Changeset 2661

Timestamp:

03/07/13 11:23:41 (11 years ago)

Author:

keeloo

Message:

Fixed the code for accessing the parameter file via a stream.

Location:

vlo/branches/vlo-2.13-param/vlo_importer

Files:

• src/main/java/eu/clarin/cmdi/vlo/config/ConfigFilePersister.java (modified) (3 diffs)
• src/main/java/eu/clarin/cmdi/vlo/config/ConfigFromFile.java (modified) (1 diff)
• src/main/java/eu/clarin/cmdi/vlo/config/VloConfig.java (modified) (7 diffs)
• xsdMapping.txt (modified) (1 diff)

vlo/branches/vlo-2.13-param/vlo_importer/src/main/java/eu/clarin/cmdi/vlo/config/ConfigFilePersister.java

@@ -4 +4 @@
 import java.io.File;
 import java.io.InputStream;
+import java.util.logging.Level;
 import org.simpleframework.xml.core.Persister;
 
@@ -70 +71 @@
     
     /**
-     * The name of the XML file defining the members of the annotated class
+     * The absolute name of the XML file defining the members of the annotated 
+     * class.
      */
     private String fileName;
@@ -132 +134 @@
     public Object ConfigFromFile() {
         
-        // may be change the name of to something reflecting the stream idea
+        Object object = null;
 
-        Object object;
+        // try to resolve the absolute name of configuration file to a stream
+        InputStream sourceAsStream;
+        sourceAsStream = ConfigFilePersister.class.getResourceAsStream(fileName);
 
-        // File configSource;
-        // configSource = new File(fileName);
-        
-        // configSource = new InputStream(filename);
-        
-        // seems to be clean, that is: without reference to context
-        
-        // configSource = getClass().getClassLoader().getResourceAsStream(fileName);
-        
-        Class c = null;
-        try {
-            c = Class.forName("eu.clarin.cmdi.vlo.config.ConfigFilePersister");
-        } catch (Exception ex) {
-            // This should not happen.
-        }
-        
-        /**
-         * The point is that here some merging will take place. Find a suitable
-         * name for c. Another point is that now the filename should take the
-         * place of the absName
-         */
+        if (sourceAsStream == null) {
             
-        String absName = "/VloConfig.xml";
-        
-        InputStream configSource = c.getResourceAsStream(absName);
-
-        try {
-            // object = persister.read(configClass, configSource);
-            object = persister.read(configClass, configSource, true);
-        } catch (Exception e) {
-            object = null;
-            logger.log(e);
+            // the resource cannot be found inside the package, try outside
+            File sourceAsFile; 
+            
+            sourceAsFile = new File(fileName);
+            try {
+                object = persister.read(configClass, sourceAsFile, true);
+            } catch (Exception e) {
+                logger.log(e);
+            }
+            
+        } else {
+            // the resource can be found in eu.clarin.cmdi.vlo.config
+            try {
+                object = persister.read(configClass, sourceAsStream, true);
+            } catch (Exception e) {
+                logger.log(e);
+            }
         }
 

vlo/branches/vlo-2.13-param/vlo_importer/src/main/java/eu/clarin/cmdi/vlo/config/ConfigFromFile.java

@@ -37 +37 @@
      * Configure by reading from an XML file
      * 
-     * @param fileName
+     * @param fileName the absolute name of the file to read the configuration
+     * from, for example the packaged configuration file /VloConfig.xml
      *
      * @param config the object whose annotated members will be assigned a value

vlo/branches/vlo-2.13-param/vlo_importer/src/main/java/eu/clarin/cmdi/vlo/config/VloConfig.java

@@ -10 +10 @@
 import org.slf4j.LoggerFactory;
 
+
+    /**
+
+     */
+
 /**
  * VLO configuration<br><br>
@@ -40 +45 @@
  * after 
  * 
- * {@literal VloConfig.read();}<br><br>
- * 
- * or
- * 
- * {@literal VloConfig.read();}<br><br>
+ * {@literal VloConfig.readPackagedConfig();}<br><br>
  * 
  * has been issued from a certain context, you can reference a parameter by
@@ -51 +52 @@
  *
  * in any scope, also the scope from which the read message was send.
+ * 
+ * 
+ * 
+ * Move the following remarks to a general remark in the class description, a
+ * remark indicating what you could do if you do not want to use the packaged
+ * configuration.
+ * 
+ * 
+ * Here, modifications of the parameters inspired on the difference
+ * in context can be made.
+ *
+ * A web application can serve as a typical example of a difference in context:
+ * the application itself runs in a web server container, while the tests
+ * associated with the web application will be run outside this container. *
+ *
+ * 
  *
  * Through the get and set methods, the application is indifferent to the origin
@@ -114 +131 @@
     
     /**
-     * Create a static reference to the class itself to collect the members
-     * denoting parameters. Because these members themselves are static, the 
-     * reference will point the a fixed set of parameters. Please note that the
-     * reference needs to be a protected reference because of access from one
-     * of the extending VloWebApp class.
-     */
-    protected static VloConfig config = null;
-
-    /**
      * Read the configuration from the packaged XML configuration file.  
      * 
-     * @param fileName the name of the file to read the configuration from
-     *
-     * @return the configuration 
+     * @param fileName the name of the file to read the configuration from 
      */
     public static void readPackagedConfig() {
         
         // set the name of the packaged configuration file
-        String fileName = "/VloConfig";
+        String fileName = "/VloConfig.xml";
         
         VloConfig.readConfig (fileName);
-        
-        // return config;
-    }
-    
-    /**
-     * Read the configuration from an XML file. 
-     *
-     * Please invoke this method if you want a configuration different from
-     * the one that is represented in the packages XML file. 
+    }
+    
+    // VLO application configuration
+    static VloConfig config = null;
+
+    /**
+     * Read the configuration from a file. 
+     *
+     * Please invoke this method instead of readPackagedConfig if you want to 
+     * read the configuration from a file external to the VloConfig package.
      * 
      * @param fileName the name of the file to read the configuration from
-     *
-     * @return the configuration 
      */
     public static void readConfig(String fileName) {
-        
-        // may it is safe to first expand the name a litte bit more
 
         if (config == null) {
@@ -158 +161 @@
         }
 
-        // get the XML file configuration from the file by invoking ...
+        // get the XML file configuration from the file
         read(fileName, config);
     }
-
-    /**
-     * Read the configuration from an XML file. 
-     * 
-     * Move the following remarks to a general remark in the class description, 
-     * a remark indicating what you could do if you do not want to use the 
-     * packaged configuration.
-     * 
-     * Invoke this method instead of readConfig() if you want to change
-     * the parameters because the application is run in a context different
-     * from the usual one. Here, modifications of the parameters inspired on
-     * the difference in context can be made.
-     * 
-     * A web application can serve as a typical example of a difference in 
-     * context: the application itself runs in a web server container, while the
-     * tests associated with the web application will be run outside this 
-     * container.
-     *     
-     */
 
     /**
@@ -199 +183 @@
     @ElementList // directive for Simple
     private static List<DataRoot> dataRoots;
-    
-    public static List<DataRoot> getDataRoots() {
-        return dataRoots;
-    }
     
     @Element
@@ -277 +257 @@
      * application.
      */
+    public static List<DataRoot> getDataRoots() {
+        return dataRoots;
+    }
     
     /**

vlo/branches/vlo-2.13-param/vlo_importer/xsdMapping.txt

@@ -1 @@
-This file is generated on Mar 1, 2013 2:41:50 PM and only used to document the mapping.
+This file is generated on Mar 7, 2013 12:22:39 PM and only used to document the mapping.
 This file contains xsd name and a list of conceptName with xpath mappings that are generated.
 ---------------------