]> git.mxchange.org Git - jcore.git/blobdiff - src/org/mxchange/jcore/BaseFrameworkSystem.java
A lot changes on jcore:
[jcore.git] / src / org / mxchange / jcore / BaseFrameworkSystem.java
index efee7136d7fd176c699223bed27901506877696f..515981d72ae2a63dd8725ecbc7d49ee48e1f81f9 100644 (file)
@@ -178,9 +178,12 @@ public class BaseFrameworkSystem implements FrameworkInterface {
         * @param columnName Column name
         * @return Value from field
         * @throws IllegalArgumentException Some implementations may throw this.
+        * @throws NoSuchMethodException Some implementations may throw this.
+        * @throws java.lang.IllegalAccessException If the method cannot be accessed
+        * @throws java.lang.reflect.InvocationTargetException Any other problems?
         */
        @Override
-       public Object getValueFromColumn (final String columnName) throws IllegalArgumentException {
+       public Object getValueFromColumn (final String columnName) throws IllegalArgumentException, NoSuchMethodException, IllegalAccessException, InvocationTargetException {
                throw new UnsupportedOperationException(MessageFormat.format("Not implemented. columnName={0}", columnName)); //NOI18N
        }
 
@@ -191,26 +194,26 @@ public class BaseFrameworkSystem implements FrameworkInterface {
         * @param targetClass Class name to look for
         * @return Class instance
         */
-       @SuppressWarnings ("unchecked")
+       @SuppressWarnings("unchecked")
        private Class<? extends FrameworkInterface> getClassFromTarget (final FrameworkInterface instance, final String targetClass) {
                // Trace message
                this.getLogger().debug(MessageFormat.format("instance={0},targetClass={1}", instance, targetClass)); //NOI18N
-               
+
                // Instance reflaction of this class
                Class<? extends FrameworkInterface> c = instance.getClass();
-               
+
                // Analyze class
                while (!targetClass.equals(c.getSimpleName())) {
                        // Debug message
                        this.getLogger().debug(MessageFormat.format("c={0}", c.getSimpleName())); //NOI18N
-                       
+
                        // Get super class (causes unchecked warning)
                        c = (Class<? extends FrameworkInterface>) c.getSuperclass();
                }
 
                // Trace message
                this.getLogger().trace(MessageFormat.format("c={0} - EXIT!", c)); //NOI18N
-               
+
                // Return it
                return c;
        }
@@ -223,30 +226,25 @@ public class BaseFrameworkSystem implements FrameworkInterface {
         * @param methodName Method name
         * @return A Method instance
         */
-       private Method getMethodFromName (final FrameworkInterface instance, final String targetClass, final String methodName) {
+       private Method getMethodFromName (final FrameworkInterface instance, final String targetClass, final String methodName) throws NoSuchMethodException {
                // Trace messahe
                this.getLogger().trace(MessageFormat.format("targetClass={0},methodName={1}", targetClass, methodName)); //NOI18N
-               
+
                // Get target class instance
                Class<? extends FrameworkInterface> c = this.getClassFromTarget(instance, targetClass);
-               
+
                // Init field instance
                Method method = null;
-               
+
                // Use reflection to get all attributes
-               try {
-                       method = c.getDeclaredMethod(methodName, new Class<?>[0]);
-               } catch (final SecurityException | NoSuchMethodException ex) {
-                       // Security problem
-                       this.abortProgramWithException(ex);
-               }
-               
+               method = c.getDeclaredMethod(methodName, new Class<?>[0]);
+
                // Assert on field
                assert (method instanceof Method) : "method is not a Method instance"; //NOI18N
-               
+
                // Trace message
                this.getLogger().trace(MessageFormat.format("method={0} - EXIT!", method)); //NOI18N
-               
+
                // Return it
                return method;
        }
@@ -262,15 +260,14 @@ public class BaseFrameworkSystem implements FrameworkInterface {
        /**
         * Aborts program with given exception
         *
-        * @param       throwable Any type of Throwable
+        * @param throwable Any type of Throwable
         */
        protected final void abortProgramWithException (final Throwable throwable) {
                // Log exception ...
                this.getLogger().catching(throwable);
-               
+
                // .. and exit
                System.exit(1);
-
        }
 
        /**
@@ -325,9 +322,12 @@ public class BaseFrameworkSystem implements FrameworkInterface {
         * @param columnName Column name to check
         * @param bool Boolean value
         * @return Whether all conditions are met
+        * @throws NoSuchMethodException May be thrown by some implementations
+        * @throws java.lang.IllegalAccessException If the method cannot be accessed
+        * @throws java.lang.reflect.InvocationTargetException Any other problems?
         */
        @Override
-       public boolean isValueEqual (final String columnName, final boolean bool) {
+       public boolean isValueEqual (final String columnName, final boolean bool) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException {
                // Not implemented
                throw new UnsupportedOperationException(MessageFormat.format("Not implemented. columnName={0},bool={1}", columnName, bool)); //NOI18N
        }
@@ -353,6 +353,7 @@ public class BaseFrameworkSystem implements FrameworkInterface {
                // Init default values:
                // Default database backend
                BaseFrameworkSystem.properties.put("org.mxchange.database.backend.class", "org.mxchange.jcore.database.backend.base64.Base64CsvDatabaseBackend"); //NOI18N
+               BaseFrameworkSystem.properties.put("database.backend.storagepath", "data/"); //NOI18N
 
                // For MySQL backend
                BaseFrameworkSystem.properties.put("org.mxchange.database.mysql.host", "localhost"); //NOI18N
@@ -367,16 +368,12 @@ public class BaseFrameworkSystem implements FrameworkInterface {
        /**
         * Writes the properties file to disk
         */
-       private void writePropertiesFile () {
+       private void writePropertiesFile () throws IOException {
                // Trace message
                this.getLogger().trace("CALLED!"); //NOI18N
 
-               try {
-                       // Write it
-                       BaseFrameworkSystem.properties.store(new PrintWriter(FrameworkInterface.PROPERTIES_CONFIG_FILE), "This file is automatically generated. You may wish to alter it."); //NOI18N
-               } catch (final IOException ex) {
-                       this.abortProgramWithException(ex);
-               }
+               // Write it
+               BaseFrameworkSystem.properties.store(new PrintWriter(FrameworkInterface.PROPERTIES_CONFIG_FILE), "This file is automatically generated. You may wish to alter it."); //NOI18N
 
                // Trace message
                this.getLogger().trace("EXIT!"); //NOI18N
@@ -526,8 +523,11 @@ public class BaseFrameworkSystem implements FrameworkInterface {
         * @param targetClass Target class to look in
         * @param methodName Method name to look for
         * @return Boolean value from field
+        * @throws java.lang.NoSuchMethodException If the method was not found
+        * @throws java.lang.IllegalAccessException If the method cannot be accessed
+        * @throws java.lang.reflect.InvocationTargetException Some other problems?
         */
-       protected boolean getBooleanField (final FrameworkInterface instance, final String targetClass, final String methodName) {
+       protected boolean getBooleanField (final FrameworkInterface instance, final String targetClass, final String methodName) throws NoSuchMethodException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {
                // Trace messahe
                this.getLogger().trace(MessageFormat.format("targetClass={0},methodName={1}", targetClass, methodName)); //NOI18N
 
@@ -537,12 +537,8 @@ public class BaseFrameworkSystem implements FrameworkInterface {
                // Get value from field
                Boolean value = false;
 
-               try {
-                       value = (Boolean) method.invoke(instance);
-               } catch (final IllegalArgumentException | IllegalAccessException | InvocationTargetException ex) {
-                       // Other problem
-                       this.abortProgramWithException(ex);
-               }
+               // Try to get the value by invoking the method
+               value = (Boolean) method.invoke(instance);
 
                // Return value
                return value;
@@ -564,23 +560,19 @@ public class BaseFrameworkSystem implements FrameworkInterface {
         * @param targetClass Target class to look in
         * @param methodName Method name to look for
         * @return Any value from field
+        * @throws java.lang.NoSuchMethodException If the method was not found
+        * @throws java.lang.IllegalAccessException If the method cannot be accessed
+        * @throws java.lang.reflect.InvocationTargetException Some other problems?
         */
-       protected Object getField (final FrameworkInterface instance, final String targetClass, final String methodName) {
+       protected Object getField (final FrameworkInterface instance, final String targetClass, final String methodName) throws NoSuchMethodException, IllegalAccessException, IllegalArgumentException, InvocationTargetException {
                // Trace messahe
                this.getLogger().trace(MessageFormat.format("targetClass={0},methodName={1}", targetClass, methodName)); //NOI18N
-               
+
                // Get method to call
                Method method = this.getMethodFromName(instance, targetClass, methodName);
-               
+
                // Get value from field
-               Object object = null;
-               
-               try {
-                       object = method.invoke(instance);
-               } catch (final IllegalArgumentException | IllegalAccessException | InvocationTargetException ex) {
-                       // Other problem
-                       this.abortProgramWithException(ex);
-               }
+               Object object = method.invoke(instance);
 
                // Return value
                return object;
@@ -613,17 +605,17 @@ public class BaseFrameworkSystem implements FrameworkInterface {
         */
        protected Object convertNullToEmpty (final Object str) {
                // Trace message
-               this.getLogger().trace(MessageFormat.format("str={0}", str));
-               
+               this.getLogger().trace(MessageFormat.format("str={0}", str)); //NOI18N
+
                // Is it null?
                if (str == null) {
                        // Return empty string
-                       return "";
+                       return ""; //NOI18N
                }
 
                // Trace message
-               this.getLogger().trace(MessageFormat.format("str={0} - EXIT!", str));
-               
+               this.getLogger().trace(MessageFormat.format("str={0} - EXIT!", str)); //NOI18N
+
                // Return it
                return str;
        }
@@ -634,43 +626,52 @@ public class BaseFrameworkSystem implements FrameworkInterface {
         * @param instance Instance to run getter calls on
         * @param className Class name to iterate over
         * @return An iterator over all object's fields
+        * @throws java.lang.NoSuchMethodException If the called method does not exist
+        * @throws java.lang.IllegalAccessException If the method cannot be accessed
+        * @throws java.lang.reflect.InvocationTargetException Any other problems?
         */
-       protected Iterator<Map.Entry<Field, Object>> fieldIterator (final FrameworkInterface instance, final String className) {
+       protected Iterator<Map.Entry<Field, Object>> fieldIterator (final FrameworkInterface instance, final String className) throws IllegalArgumentException, NoSuchMethodException, IllegalAccessException, InvocationTargetException {
                // Trace message
-               this.getLogger().trace(MessageFormat.format("instance={0},className={1} - CALLED!", instance, className));
-               
+               this.getLogger().trace(MessageFormat.format("instance={0},className={1} - CALLED!", instance, className)); //NOI18N
+
                // Get all attributes from given instance
                Field[] fields = this.getClassFromTarget(instance, className).getDeclaredFields();
-               
+
                // Debug message
-               this.getLogger().debug(MessageFormat.format("Found {0} fields.", fields.length));
-               
+               this.getLogger().debug(MessageFormat.format("Found {0} fields.", fields.length)); //NOI18N
+
                // A simple map with K=fieldName and V=Value is fine
                Map<Field, Object> map = new HashMap<>(fields.length);
-               
+
                // Walk through all
                for (final Field field : fields) {
                        // Debug log
-                       this.getLogger().debug(MessageFormat.format("field={0}", field.getName()));
+                       this.getLogger().debug(MessageFormat.format("field={0}", field.getName())); //NOI18N
 
                        // Does the field start with "$"?
-                       if (field.getName().startsWith("$")) {
+                       if (field.getName().startsWith("$")) { //NOI18N
+                               // Debug message
+                               this.getLogger().debug(MessageFormat.format("Skipping field={0} as it starts with a dollar character.", field.getName())); //NOI18N
+
                                // Skip it silently
                                continue;
                        }
 
+                       // Debug message
+                       this.getLogger().debug(MessageFormat.format("Calling getValueFromColumn({0}) on instance {1} ...", field.getName(), instance)); //NOI18N
+
                        // Get value from it
-                       Object value = this.getValueFromColumn(field.getName());
+                       Object value = instance.getValueFromColumn(field.getName());
 
                        // Debug message
-                       this.getLogger().debug(MessageFormat.format("value={0}", value));
+                       this.getLogger().debug(MessageFormat.format("Adding field={0},value={1}", field.getName(), value)); //NOI18N
 
                        // Add it to list
                        map.put(field, value);
                }
 
                // Debug message
-               this.getLogger().debug(MessageFormat.format("Returning iterator for {0} entries ...", map.size()));
+               this.getLogger().debug(MessageFormat.format("Returning iterator for {0} entries ...", map.size())); //NOI18N
 
                // Return list iterator
                return map.entrySet().iterator();
@@ -734,20 +735,28 @@ public class BaseFrameworkSystem implements FrameworkInterface {
         * Initializes i18n bundles
         */
        protected void initBundle () {
+               // Trace message
+               this.getLogger().trace("CALLED!");
+
                // Is the bundle set?
                if (bundle instanceof ResourceBundle) {
                        // Is already set
-                       throw new IllegalStateException("called twice");
+                       throw new IllegalStateException("called twice"); //NOI18N
                }
 
                // Set instance
                bundle = ResourceBundle.getBundle(FrameworkInterface.I18N_BUNDLE_FILE); // NOI18N
+
+               // Trace message
+               this.getLogger().trace("EXIT!");
        }
-       
+
        /**
         * Prepares all properties, the file is written if it is not found
+        *
+        * @throws java.io.IOException If any IO problem occurs
         */
-       protected void initProperties () {
+       protected void initProperties () throws IOException {
                // Trace message
                this.getLogger().trace("CALLED!"); //NOI18N
 
@@ -778,9 +787,6 @@ public class BaseFrameworkSystem implements FrameworkInterface {
 
                        // Write file
                        this.writePropertiesFile();
-               } catch (final IOException ex) {
-                       // Something else didn't work
-                       this.abortProgramWithException(ex);
                }
 
                // Trace message
@@ -817,9 +823,6 @@ public class BaseFrameworkSystem implements FrameworkInterface {
 
                        // Not found
                        isBool = false;
-               } catch (final SecurityException ex) {
-                       // Really bad?
-                       this.abortProgramWithException(ex);
                }
 
                // Trace message
@@ -829,4 +832,49 @@ public class BaseFrameworkSystem implements FrameworkInterface {
                return isBool;
        }
 
+       /**
+        * Sets value in properties instance.
+        *
+        * @param key Property key (part) to set
+        * @param value Property value to set
+        */
+       protected void setProperty (final String key, final String value) {
+               // Trace message
+               this.getLogger().trace(MessageFormat.format("key={0},value={1} - CALLED!", key, value)); //NOI18N
+
+               // Both should not be null
+               if (key == null) {
+                       // key is null
+                       throw new NullPointerException("key is null");
+               } else if (value == null) {
+                       // value is null
+                       throw new NullPointerException("value is null");
+               }
+
+               // Set it
+               properties.setProperty(String.format("org.mxchange.%s", key), value); //NOI18N
+
+               // Trace message
+               this.getLogger().trace("EXIT!"); //NOI18N
+       }
+
+       /**
+        * Some getter for properties names (without org.mxchange)
+        *
+        * @return An array with property names
+        */
+       protected String[] getPropertyNames () {
+               // Init array
+               String[] names = {
+                       "database.backend.class", //NOI18N
+                       "database.backend.storagepath", //NOI18N
+                       "database.mysql.login", //NOI18N
+                       "database.mysql.host", //NOI18N
+                       "database.mysql.password", //NOI18N
+                       "database.mysql.dbname", //NOI18N
+               };
+
+               // Return it
+               return names;
+       }
 }