Changeset 3768

Timestamp:

2003-02-26T10:33:44+13:00 (21 years ago)

Author:

mdewsnip

Message:

Replaced usage of TextWriter in Xindice package with a custom-built function for displaying a DOM model as text. The new function respects the 'java.xml.transform.disable-output-escaping' and 'java.xml.transform.enable-output-escaping' processing instructions, formats the text much better (as an indented hierarchy), and works around some Netscape display issues.

File:

• trunk/gsdl3/src/java/org/greenstone/gsdl3/util/XMLConverter.java (modified) (3 diffs)

trunk/gsdl3/src/java/org/greenstone/gsdl3/util/XMLConverter.java

@@ -22 +22 @@
 import org.w3c.dom.Document; 
 import org.w3c.dom.Node; 
+import org.w3c.dom.NodeList;
+import org.w3c.dom.NamedNodeMap;
 import org.xml.sax.InputSource;
 import javax.xml.parsers.*;
-import org.apache.xindice.xml.TextWriter;
 import org.apache.xerces.dom.TextImpl;
 import org.apache.xerces.parsers.DOMParser;
@@ -53 +54 @@
     protected DOMParser parser_ = null;
 
+    private boolean outputEscaping = true;
+
+
      /** the no-args constructor */
     public XMLConverter() {
@@ -109 +113 @@
 
     /** returns the Node as a String */
-    public String getString(Node doc) {
-    if (doc==null) {
-        return "";
-    }
-    TextWriter t = new TextWriter(doc);
-    return t.toString();
+    public String getString(Node xmlNode)
+    {
+    outputEscaping = true;
+    return getString(xmlNode, 0);
+    }
+
+
+    private String getString(Node xmlNode, int depth)
+    {
+    String xmlRepresentation = "";
+
+    short nodeType = xmlNode.getNodeType();
+    String nodeName = xmlNode.getNodeName();
+
+    // Handle Element nodes
+    if (nodeType == Node.ELEMENT_NODE) {
+        xmlRepresentation += "\n";
+        for (int i = 0; i < depth; i++)
+        xmlRepresentation += "  ";
+
+        // Write opening tag
+        xmlRepresentation += "<" + nodeName;
+
+        // Write the node attributes
+        NamedNodeMap nodeAttributes = xmlNode.getAttributes();
+        for (int i = 0; i < nodeAttributes.getLength(); i++) {
+        Node attribute = nodeAttributes.item(i);
+        xmlRepresentation += " " + attribute.getNodeName() + "=";
+        xmlRepresentation += "\"" + attribute.getNodeValue() + "\"";
+        }
+
+        // If the node has no children, close the opening tag and return
+        if (xmlNode.hasChildNodes() == false) {
+        // This produces somewhat ugly output, but it is necessary to compensate
+        // for display bugs in Netscape. Firstly, the space is needed before the
+        // closing bracket otherwise Netscape will ignore some tags (<br/>, for
+        // example). Also, a newline character would be expected after the tag,
+        // but this causes problems with the display of links (the link text
+        // will contain a newline character, which is displayed badly).
+        xmlRepresentation += " />";
+        return xmlRepresentation;
+        }
+
+        // Close the opening tag
+        xmlRepresentation += ">";
+
+        // Apply recursively to the children of this node
+        NodeList children = xmlNode.getChildNodes();
+        for (int i = 0; i < children.getLength(); i++) {
+        xmlRepresentation += getString(children.item(i), depth + 1);
+        }
+
+        // Write closing tag
+        if (xmlRepresentation.endsWith("\n")) {
+        for (int i = 0; i < depth; i++)
+            xmlRepresentation += "  ";
+        }
+        xmlRepresentation += "</" + nodeName + ">\n";
+    }
+
+    // Handle Text nodes
+    else if (nodeType == Node.TEXT_NODE) {
+        String text = xmlNode.getNodeValue();
+
+        // Perform output escaping, if required
+        if (outputEscaping) {
+        text = text.replaceAll("&", "&amp;");  // Must be done first!!
+        text = text.replaceAll("<", "&lt;");
+        text = text.replaceAll(">", "&gt;");
+        text = text.replaceAll("\"", "&quot;");
+        text = text.replaceAll("\'", "&apos;");
+        }
+
+        // Remove any control-C characters
+        text = text.replaceAll("" + (char) 3, "");
+        xmlRepresentation += text;
+    }
+
+    // Handle Processing Instruction nodes
+    else if (nodeType == Node.PROCESSING_INSTRUCTION_NODE) {
+        if (nodeName == "javax.xml.transform.disable-output-escaping") {
+        outputEscaping = false;
+        }
+        else if (nodeName == "javax.xml.transform.enable-output-escaping") {
+        outputEscaping = true;
+        }
+        else {
+        System.err.println("Warning: Unhandled processing instruction " + nodeName);
+        }
+    }
+
+    // A type of node that is not handled yet
+    else {
+        System.err.println("Warning: Unknown node type: " + nodeType);
+    }
+
+    return xmlRepresentation;
     }
 }