Changeset 28963 for main/trunk

Timestamp:

2014-04-10T14:29:44+12:00 (10 years ago)

Author:

kjdon

Message:

moved a method here from XMLConverter. Removed Document param from methods that take an Element - now we get the Element's owner document and use that to create nodes. So now no chance that you can pass in the wrong Document for the Element thatyou are adding nodes to

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSXML.java (modified) (9 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/GSXML.java

@@ -59 +59 @@
     public static final String PARAM_ELEM = "param";
     public static final String PARAM_OPTION_ELEM = "option";
+        public static final String LIBRARY_PARAM_ELEM = "libraryParam";
     public static final String CONTENT_ELEM = "content";
     public static final String RESOURCE_ELEM = "resource";
@@ -460 +461 @@
 
     /** add text to a document/subsection element */
-    public static boolean addDocText(Document owner, Element doc, String text)
-    {
-
-        Element content = owner.createElement(NODE_CONTENT_ELEM);
-        Text t = owner.createTextNode(text);
+    public static boolean addDocText(Element doc, String text)
+    {
+      
+      Element content = doc.getOwnerDocument().createElement(NODE_CONTENT_ELEM);
+        Text t = doc.getOwnerDocument().createTextNode(text);
         content.appendChild(t);
         doc.appendChild(content);
@@ -471 +472 @@
 
     /** add an error message, unknown error type */
-    public static boolean addError(Document owner, Element doc, String text)
-    {
-        return addError(owner, doc, text, ERROR_TYPE_OTHER);
+  public static boolean addError(Element doc, String text)
+    {
+        return addError(doc, text, ERROR_TYPE_OTHER);
     }
 
     /** add an error message */
-    public static boolean addError(Document owner, Element doc, String text, String error_type)
-    {
-
-        Element content = owner.createElement(ERROR_ELEM);
+    public static boolean addError(Element doc, String text, String error_type)
+    {
+
+        Element content = doc.getOwnerDocument().createElement(ERROR_ELEM);
         content.setAttribute(ERROR_TYPE_ATT, error_type);
-        Text t = owner.createTextNode(text);
+        Text t = doc.getOwnerDocument().createTextNode(text);
         content.appendChild(t);
         doc.appendChild(content);
@@ -489 +490 @@
 
     /** add an error message */
-    public static boolean addError(Document owner, Element doc, Throwable error)
-    {
-        return addError(owner, doc, error, ERROR_TYPE_OTHER);
+    public static boolean addError(Element doc, Throwable error)
+    {
+        return addError(doc, error, ERROR_TYPE_OTHER);
     }
 
     /** add an error message */
-    public static boolean addError(Document owner, Element doc, Throwable error, String error_type)
+    public static boolean addError(Element doc, Throwable error, String error_type)
     {
         error.printStackTrace();
-        return addError(owner, doc, error.toString(), error_type);
+        return addError(doc, error.toString(), error_type);
     }
 
@@ -518 +519 @@
 
     /** adds a metadata elem to a list */
-    public static boolean addMetadata(Document owner, Element list, String meta_name, String meta_value)
+    public static boolean addMetadata(Element list, String meta_name, String meta_value)
     {
         if (meta_value == null || meta_value.equals(""))
@@ -524 +525 @@
             return false;
         }
+        Document owner = list.getOwnerDocument();
         Element data = owner.createElement(METADATA_ELEM);
         data.setAttribute(NAME_ATT, meta_name);
@@ -818 +820 @@
       }
     }
+
+    /**
+     * Given a Node representing an Element or Document, will return the
+     * Element/docroot Element. Returns null if the Node was not an element.
+     */
+    public static Element nodeToElement(Node node)
+    {
+        if (node == null)
+        {
+            return null;
+        }
+        short nodeType = node.getNodeType();
+
+        if (nodeType == Node.DOCUMENT_NODE)
+        {
+            Document docNode = (Document) node;
+            return docNode.getDocumentElement();
+        }
+        else if (nodeType == Node.ELEMENT_NODE)
+        {
+            return (Element) node;
+        }
+        else
+        {
+            String message = "Expecting Document or Element node type but got " + node.getNodeName() + "\nReturning null";
+            System.err.println(message);
+            logger.warn(message);
+            return null;
+        }
+    }
+ 
 
     /** returns a basic request message */
@@ -907 +940 @@
     }
 
-    public static void addParametersToList(Document owner, Element param_list, HashMap params)
+    public static void addParametersToList(Element param_list, HashMap params)
     {
         if (params == null)
@@ -916 +949 @@
         Set items = params.entrySet();
         Iterator i = items.iterator();
+        Document owner = param_list.getOwnerDocument();
         while (i.hasNext())
         {