Changeset 9036

Timestamp:

2005-02-15T11:25:50+13:00 (19 years ago)

Author:

mdewsnip

Message:

Removed all XML functions from XMLTools, and changed occurrences to use new functions.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• Configuration.java (modified) (2 diffs)
• cdm/CollectionConfiguration.java (modified) (2 diffs)
• collection/BuildOptions.java (modified) (1 diff)
• collection/Collection.java (modified) (2 diffs)
• collection/CollectionManager.java (modified) (1 diff)
• gems/MetadataSet.java (modified) (2 diffs)
• gems/MetadataSetManager.java (modified) (1 diff)
• gui/LockFileDialog.java (modified) (1 diff)
• util/Utility.java (modified) (1 diff)
• util/XMLTools.java (modified) (3 diffs)

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

@@ -618 +618 @@
         ///ystem.err.println("Writing.");
         user_config_xml.getParentFile().mkdirs();
-        XMLTools.export(general_config, user_config_xml.getAbsolutePath());
+        XMLTools.writeXMLFile(new File(user_config_xml.getAbsolutePath()), general_config);
     }
     catch(Exception exception) {
@@ -626 +626 @@
     if(user_config_xml == null || !user_config_xml.exists()) {
         // But failing that we produce a general copy
-        XMLTools.export(general_config, Utility.BASE_DIR + config_xml_name);
+        XMLTools.writeXMLFile(new File(Utility.BASE_DIR + config_xml_name), general_config);
     }
     }

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

@@ -329 +329 @@
     if(collect_config_name.equals(COLLECTCONFIGURATION_XML)) {
         // Parse with Utility but don't use class loader
-        document = XMLTools.parse(collect_config_file, false);
+        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
@@ -470 +470 @@
     if(force_xml || collect_config_file.getName().equals(COLLECTCONFIGURATION_XML)) {
         ///ystem.err.println("Writing XML");
-        XMLTools.export(document, new File(collect_config_file.getParentFile(), COLLECTCONFIGURATION_XML));
+        XMLTools.writeXMLFile(new File(collect_config_file.getParentFile(), COLLECTCONFIGURATION_XML), document);
     }
     else {

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

@@ -421 +421 @@
         }
 
-        Document document = XMLTools.parse(input_stream,false);
+        Document document = XMLTools.parseXML(input_stream);
         arguments_element = document.getDocumentElement();
     }

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

@@ -87 +87 @@
     this.file = collection_xml;
     // Try to load this collections details.
-    document = XMLTools.parse(collection_xml, false);
+    document = XMLTools.parseXMLFile(collection_xml);
     // If that fails load the default settings for a collection.
     if(document == null) {
@@ -186 +186 @@
     /** Save this xml document to the given file. */
     public void save() {
-    XMLTools.export(document, file);
+    XMLTools.writeXMLFile(file, document);
     saved = true;
     }

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

@@ -488 +488 @@
         date_element = null;
         date_time = null;
-        XMLTools.export(default_lockfile, destination);
+        XMLTools.writeXMLFile(destination, default_lockfile);
     }
     catch (Exception error) {

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

@@ -97 +97 @@
     this.file = file;
     this.value_trees = new Hashtable();
-    this.document = XMLTools.parse(file, false);
+    this.document = XMLTools.parseXMLFile(file);
 
     init(false); // don't use class loader
@@ -694 +694 @@
             }
             else {
-            value_document = XMLTools.parse(value_file, false);
+            value_document = XMLTools.parseXMLFile(value_file);
             }
             if(value_document != null) {

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

@@ -566 +566 @@
                
             // System.out.println("::: " + mds_file.toString());
-         XMLTools.export(set.getDocument(), mds_file);
+         XMLTools.writeXMLFile(mds_file, set.getDocument());
              
              set.setSetChanged(false);

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

@@ -70 +70 @@
     this.self = this;
 
-    // Parse the lock file, but do so quietly so that if the XML is poorly formed it doesn't show exception.
-    document = XMLTools.parse(lock_file, false);
+    // Parse the lock file
+    document = XMLTools.parseXMLFile(lock_file);
 
     // Creation

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

@@ -906 +906 @@
         InputStream is = base.getResourceAsStream("/" + filename);
         if (is != null) {
-        return XMLTools.parse(is, true);
+        return XMLTools.parseXML(is);
         }
     }
 
     // Try the file outside the classes directory
-    return XMLTools.parse(new File(filename), true);
+    return XMLTools.parseXMLFile(new File(filename));
     }
 

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

@@ -102 +102 @@
     static public Document parseXMLFile(File xml_file)
     {
+    try {
+        return parseXML(new FileInputStream(xml_file));
+    }
+    catch (Exception exception) {
+        DebugStream.printStackTrace(exception);
+        return null;
+    }
+    }
+
+
+    /** Parse an XML document from a given input stream */
+    static public Document parseXML(InputStream xml_input_stream)
+    {
     Document document = null;
 
     try {
-        FileInputStream fis   = new FileInputStream(xml_file);
-        InputStreamReader isr = new InputStreamReader(fis, "UTF-8");
+        InputStreamReader isr = new InputStreamReader(xml_input_stream, "UTF-8");
         Reader r              = new BufferedReader(isr);
         InputSource isc       = new InputSource(r);
@@ -118 +130 @@
         document = parser.getDocument();
         isr.close();
-        fis.close();
+        xml_input_stream.close();
     }
     catch (Exception exception) {
@@ -189 +201 @@
     }
     }
-
-
-    /** ------------ OLD FUNCTIONS FROM UTILITY ---------------
-    /** Using this method we can request that a certain document be written, as valid XML, to a certain output stream. This makes use of the Xerces Serialization suite, which should in no way be confused with the usual method of Serialization used by Java. */
-    static public boolean export(Document document, String filename) {
-    return export(document, new File(filename));
-    }
-
-    static public boolean export(Document document, File file) {
-    try {
-        OutputStream os = new FileOutputStream(file);
-        // Create an output format for our document.
-        OutputFormat f = new OutputFormat(document);
-        f.setEncoding("UTF-8");
-        f.setIndenting(true);
-        f.setLineWidth(0); // Why isn't this working!
-        f.setPreserveSpace(false);
-        // Create the necessary writer stream for serialization.
-        OutputStreamWriter osw = new OutputStreamWriter(os, "UTF-8");
-        Writer w               = new BufferedWriter(osw);
-        // Generate a new serializer from the above.
-        XMLSerializer s        = new XMLSerializer(w, f);
-        s.asDOMSerializer();
-        // Finally serialize the document to file.
-        s.serialize(document);
-        // And close.
-        os.close();
-        return true;
-    }
-    // A file not found exception is most likely thrown because the directory the metadata.xml file is attempting to be written to no longer has any files in it. I'll add a test in MetadataXMLFile to test for this, but if it still happens ignore it (a non-existant directory can't really have metadata added to it any way.
-    catch (Exception exception) {
-        if(!file.getName().endsWith(StaticStrings.METADATA_XML)) {
-        DebugStream.printStackTrace(exception);
-        return false;
-        }
-        return true;
-    }
-    }
-
-    /** Parse in a xml document from a given file. */
-    static public Document parse(File file) {
-    return parse(file, true);
-    }
-
-    /** Parse in a xml document from a given file. */
-    static public Document parse(File file, boolean noisey) 
-    {
-    Document document = null;
-    try {
-        if (file.exists()) {
-        DebugStream.println("Parsing XML file: " + file);
-        FileInputStream fis = new FileInputStream(file);
-        document = parse(fis, noisey);
-        }
-    }
-    catch (Exception error) {
-        if(noisey) {
-        error.printStackTrace();
-        DebugStream.println("Exception in Utility.parse() - Unexpected");
-        }
-        else {
-        DebugStream.println("Exception in Utility.parse() - Expected");
-        DebugStream.printStackTrace(error);
-        }
-    }
-
-    return document;
-    }
-
-    /** Parse in a xml document from a given URL. */
-    static public Document parse(URL url, boolean noisey) 
-    {
-    Document document = null;
-    try {
-        
-        URLConnection connection = url.openConnection();
-        InputStream is = connection.getInputStream();
-        document = parse(is,noisey);
-    }
-    catch (Exception error) {
-        if(noisey) {
-        error.printStackTrace();
-        DebugStream.println("Exception in Utility.parse() - Unexpected");
-        }
-        else {
-        DebugStream.println("Exception in Utility.parse() - Expected");
-        DebugStream.printStackTrace(error);
-        }
-    }
-
-    return document;
-    }
-
-    /** Parse in a xml document from a given file. */
-    static public Document parse(InputStream is, boolean noisey) {
-    Document document = null;
-    try {
-        InputStreamReader isr = new InputStreamReader(is, "UTF-8");
-        Reader r              = new BufferedReader(isr);
-        InputSource isc       = new InputSource(r);
-        DOMParser parser      = new DOMParser();
-        parser.setFeature("http://xml.org/sax/features/validation", false);
-        parser.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false);
-                // May or may not be ignored, the documentation for Xerces is contradictory. If it works then parsing -should- be faster.
-        parser.setFeature("http://apache.org/xml/features/dom/defer-node-expansion", true);
-        parser.setFeature("http://apache.org/xml/features/dom/include-ignorable-whitespace", false);
-        parser.parse(isc);
-        document = parser.getDocument();
-        isr.close();
-        is.close();
-        parser = null;
-        isc = null;
-        r = null;
-        isr = null;
-        is = null;
-    }
-    catch (Exception error) {
-        if(noisey) {
-        error.printStackTrace();
-        DebugStream.println("Exception in Utility.parse() - Unexpected");
-        }
-        else {
-        DebugStream.println("Exception in Utility.parse() - Expected");
-        }
-        DebugStream.printStackTrace(error);
-    }
-    return document;
-    }
 }