Changeset 10006

Timestamp:

2005-06-03T14:36:41+12:00 (19 years ago)

Author:

mdewsnip

Message:

Moved Utility.parse to XMLTools.parseXMLFile, as part of tidying up the Utility class.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• Configuration.java (modified) (2 diffs)
• ServletConfiguration.java (modified) (1 diff)
• cdm/CollectionConfiguration.java (modified) (1 diff)
• cdm/LanguageManager.java (modified) (2 diffs)
• collection/Collection.java (modified) (1 diff)
• collection/CollectionManager.java (modified) (1 diff)
• collection/ScriptOptions.java (modified) (1 diff)
• gems/GEMS.java (modified) (2 diffs)
• gems/MetadataSet.java (modified) (1 diff)
• gui/HelpFrame.java (modified) (2 diffs)
• gui/Preferences.java (modified) (3 diffs)
• metadata/MetadataXMLFileManager.java (modified) (2 diffs)
• metadata/ProfileXMLFileManager.java (modified) (2 diffs)
• util/StaticStrings.java (modified) (1 diff)
• util/Utility.java (modified) (1 diff)
• util/XMLTools.java (modified) (1 diff)

trunk/gli/src/org/greenstone/gatherer/Configuration.java

@@ -159 +159 @@
     // Create a new config from the default configuration file from our xml library
     if (general_config == null) {
-        general_config = Utility.parse(TEMPLATE_CONFIG_XML, true);
+        general_config = XMLTools.parseXMLFile(TEMPLATE_CONFIG_XML, true);
         just_updated_config_xml_file = true;
     }
@@ -205 +205 @@
     {
     // Check if the configuration file actually needs updating by looking at the version numbers
-    Document new_document = Utility.parse(TEMPLATE_CONFIG_XML, true);
+    Document new_document = XMLTools.parseXMLFile(TEMPLATE_CONFIG_XML, true);
     Document old_document = XMLTools.parseXMLFile(config_xml_file);
 

trunk/gli/src/org/greenstone/gatherer/ServletConfiguration.java

@@ -87 +87 @@
     
     this.mappings = new HashMap();
-    Document web_config = Utility.parse(web_xml.getAbsolutePath(), false);
+    Document web_config = XMLTools.parseXMLFile(web_xml.getAbsolutePath(), false);
        
     NodeList servlet_mappings = web_config.getElementsByTagName("servlet-mapping");

trunk/gli/src/org/greenstone/gatherer/cdm/CollectionConfiguration.java

@@ -326 +326 @@
     String collect_config_name = collect_config_file.getName();
     if(collect_config_name.equals(COLLECTCONFIGURATION_XML)) {
-        // Parse with Utility but don't use class loader
         document = XMLTools.parseXMLFile(collect_config_file);
     }
     // Otherwise if this is a legacy collect.cfg file then read in the template and send to magic parser
     else if(collect_config_name.equals(COLLECT_CFG)) {
-        document = Utility.parse(PSEUDO_COLLECTCONFIGURATION_XML, true);
+        document = XMLTools.parseXMLFile("xml/CollectionConfig.xml", true);
         parse(collect_config_file);
     }

trunk/gli/src/org/greenstone/gatherer/cdm/LanguageManager.java

@@ -44 +44 @@
 import org.greenstone.gatherer.gui.GLIButton;
 import org.greenstone.gatherer.util.Utility;
+import org.greenstone.gatherer.util.XMLTools;
 import org.w3c.dom.*;
 
@@ -53 +54 @@
     extends DOMProxyListModel {
 
-    static public Document LANGUAGES_DOCUMENT = Utility.parse("xml/languages.xml", true);
+    static public Document LANGUAGES_DOCUMENT = XMLTools.parseXMLFile("xml/languages.xml", true);
 
     static final private Dimension COMPONENT_SIZE = new Dimension(125,25);

trunk/gli/src/org/greenstone/gatherer/collection/Collection.java

@@ -96 +96 @@
     // If that fails load the default settings for a collection.
     if(document == null) {
-        document = Utility.parse(COLLECTION_XML_TEMPLATE, true);
+        document = XMLTools.parseXMLFile(COLLECTION_XML_TEMPLATE, true);
     }
     if (document == null) {

trunk/gli/src/org/greenstone/gatherer/collection/CollectionManager.java

@@ -452 +452 @@
     {
     try {
-        Document default_lockfile = Utility.parse("xml/" + LOCK_FILE, true);
+        Document default_lockfile = XMLTools.parseXMLFile("xml/" + LOCK_FILE, true);
         String user_name = System.getProperty("user.name");
         Element person_element = (Element) XMLTools.getNodeFromNamed(default_lockfile.getDocumentElement(), "User");

trunk/gli/src/org/greenstone/gatherer/collection/ScriptOptions.java

@@ -57 +57 @@
         // replace .pl with .xml to get the template name
         String template_name = script_name.replaceAll("\\.pl$", "\\.xml");
-        Document document = Utility.parse("xml/"+template_name, true);
+        Document document = XMLTools.parseXMLFile("xml/" + template_name, true);
         if (document != null) {
             arguments_element = document.getDocumentElement();

trunk/gli/src/org/greenstone/gatherer/gems/GEMS.java

@@ -66 +66 @@
 import org.greenstone.gatherer.util.Codec;
 import org.greenstone.gatherer.util.Utility;
+import org.greenstone.gatherer.util.XMLTools;
 import org.w3c.dom.*;
 
@@ -716 +717 @@
     private Vector attributeLists = null;      
 
-    org.w3c.dom.Document lang = Utility.parse(Configuration.gsdl_path + File.separator + "gli" + File.separator + "classes" + File.separator + "xml" + File.separator + "languages.xml", false);
+    org.w3c.dom.Document lang = XMLTools.parseXMLFile(Configuration.gsdl_path + File.separator + "gli" + File.separator + "classes" + File.separator + "xml" + File.separator + "languages.xml", false);
     
     /** Constructor. */

trunk/gli/src/org/greenstone/gatherer/gems/MetadataSet.java

@@ -83 +83 @@
     
     this.file = new File(metadata_template);
-    this.document = Utility.parse(metadata_template, true);
+    this.document = XMLTools.parseXMLFile(metadata_template, true);
 
     init(true); // use class loader

trunk/gli/src/org/greenstone/gatherer/gui/HelpFrame.java

@@ -48 +48 @@
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
+import org.greenstone.gatherer.util.XMLTools;
 import org.w3c.dom.*;
 
@@ -162 +163 @@
         try {
         String help_index = Utility.getHelpFolder() + StaticStrings.HELP_INDEX_FILENAME;
-        Document document = Utility.parse(help_index,true);
+        Document document = XMLTools.parseXMLFile(help_index, true);
 
         // Traverse the document hierarchy, building a tree representing its structure

trunk/gli/src/org/greenstone/gatherer/gui/Preferences.java

@@ -48 +48 @@
 import org.greenstone.gatherer.util.CheckListEntry;
 import org.greenstone.gatherer.util.StaticStrings;
-import org.greenstone.gatherer.util.Utility;
+import org.greenstone.gatherer.util.XMLTools;
 import org.w3c.dom.*;
 
@@ -503 +503 @@
 
     // Read all the warnings from the general xml/config.xml file, and their values from the user config.xml file
-    Document general_config_xml_file_document = Utility.parse("xml/config.xml", true);
+    Document general_config_xml_file_document = XMLTools.parseXMLFile("xml/config.xml", true);
     NodeList argument_elements_nodelist = general_config_xml_file_document.getDocumentElement().getElementsByTagName("Argument");
     for (int i = 0; i < argument_elements_nodelist.getLength(); i++) {
@@ -528 +528 @@
     // Read in the predefined configurations file
     Vector predefined = new Vector();
-    Document predefined_document = Utility.parse("xml/workflows.xml", true);
+    Document predefined_document = XMLTools.parseXMLFile("xml/workflows.xml", true);
     Element predefined_element = predefined_document.getDocumentElement();
     NodeList workflow_elements = predefined_element.getElementsByTagName("Workflow");

trunk/gli/src/org/greenstone/gatherer/metadata/MetadataXMLFileManager.java

@@ -32 +32 @@
 import org.greenstone.gatherer.DebugStream;
 import org.greenstone.gatherer.collection.CollectionTreeNode;
-import org.greenstone.gatherer.util.Utility;
 import org.greenstone.gatherer.util.XMLTools;
 
@@ -76 +75 @@
         // Create a new (empty) metadata.xml file in the file's directory...
         File new_metadata_xml_file_file = new File(current_file_directory, "metadata.xml");
-        XMLTools.writeXMLFile(new_metadata_xml_file_file, Utility.parse("xml/metadata.xml", true));
+        XMLTools.writeXMLFile(new_metadata_xml_file_file, XMLTools.parseXMLFile("xml/metadata.xml", true));
 
         // ...load it...

trunk/gli/src/org/greenstone/gatherer/metadata/ProfileXMLFileManager.java

@@ -30 +30 @@
 import java.io.*;
 import java.util.*;
-import org.greenstone.gatherer.util.Utility;
 import org.greenstone.gatherer.util.XMLTools;
 
@@ -56 +55 @@
     if (!profile_xml_file_file.exists()) {
         // Create a new (empty) profile.xml file in this directory...
-        XMLTools.writeXMLFile(profile_xml_file_file, Utility.parse("xml/profile.xml", true));
+        XMLTools.writeXMLFile(profile_xml_file_file, XMLTools.parseXMLFile("xml/profile.xml", true));
     }
 

trunk/gli/src/org/greenstone/gatherer/util/StaticStrings.java

@@ -191 +191 @@
     static final public String PLUGIN_STR                                 = "plugin";
     static final public String PROPERTIES_FILE_EXTENSION                  = ".properties";
-    static final public String PSEUDO_COLLECTCONFIGURATION_XML            = "xml/CollectionConfig.xml";
     static final public String RANGE_ELEMENT                              = "Range";
     static final public String RBRACKET_CHARACTER                         = "]";

trunk/gli/src/org/greenstone/gatherer/util/Utility.java

@@ -1037 +1037 @@
 
 
-    /** Parse in a xml document from a given filename. Note that this filename may need to be resolved by the class loader, especially for template files within a jar. */
-    static public Document parse(String filename, boolean use_classloader)
-    {
-    // Try the class loader if desired (for the applet JAR file)
-    if (use_classloader) {
-        InputStream is = base.getResourceAsStream("/" + filename);
-        if (is != null) {
-        return XMLTools.parseXML(is);
-        }
-    }
-
-    // Try the file outside the classes directory
-    return XMLTools.parseXMLFile(new File(filename));
-    }
-
-
     static public StringBuffer readXMLStream(InputStream input_stream)
     {

trunk/gli/src/org/greenstone/gatherer/util/XMLTools.java

@@ -96 +96 @@
     }
     return child;
+    }
+
+
+    /** Parse an XML document from a given file path */
+    static public Document parseXMLFile(String xml_file_path, boolean use_class_loader)
+    {
+    if (use_class_loader == true) {
+        InputStream is = Utility.base.getResourceAsStream("/" + xml_file_path);  // !!
+        if (is != null) {
+        return parseXML(is);
+        }
+    }
+
+    // Try the file outside the classes directory
+    return parseXMLFile(new File(xml_file_path));
     }