Changeset 5254

Timestamp:

2003-08-22T10:06:59+12:00 (21 years ago)

Author:

jmt12

Message:

Added Codec calls to transform strings for collection metadata

Location:

trunk/gli/src/org/greenstone/gatherer/cdm

Files:

• CollectionConfiguration.java (modified) (17 diffs)
• CollectionMeta.java (modified) (4 diffs)

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

@@ -35 +35 @@
 import org.greenstone.gatherer.msm.MSMUtils;
 import org.greenstone.gatherer.util.DOMTree;
+import org.greenstone.gatherer.util.Codec;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
 import org.w3c.dom.*;
-/** This class provides either access to a pseudo-G3 document, or parses a collect.cfg file in such a way as to provide an xml-type view of its content. This later version is useful as it allows the manipulation and free form editing of a legacy collect.cfg file while still allowing the various CDM data managers to base themselves directly on this model (whereas they used to be independant ListModels which clobbered the ordering of unparsed commands). 
+/** This class provides either access to a pseudo-G3 document, or parses a collect.cfg file in such a way as to provide an xml-type view of its content. This later version is useful as it allows the manipulation and free form editing of a legacy collect.cfg file while still allowing the various CDM data managers to base themselves directly on this model (whereas they used to be independant ListModels which clobbered the ordering of unparsed commands).
  * @author John Thompson, Greenstone Digital Library, University of Waikato
  * @version 2.3d
  */
-public class CollectionConfiguration 
+public class CollectionConfiguration
     extends StaticStrings {
 
@@ -60 +61 @@
     }
 
-    /** Find the best insertion position for the given DOM Element. This should try to match command tag, and if found should then try to group by name or type (eg CollectionMeta), or append to end is no such grouping exists (eg PlugIns). Failing a command match it will check against the command order for the best insertion location. 
+    /** Find the best insertion position for the given DOM Element. This should try to match command tag, and if found should then try to group by name or type (eg CollectionMeta), or append to end is no such grouping exists (eg PlugIns). Failing a command match it will check against the command order for the best insertion location.
      * @param element the command Element to be inserted
      * @return the Element which the given command should be inserted before, or null to append to end of list
@@ -130 +131 @@
             else {
             Element last_element = (Element) matching_elements.item(matching_elements.getLength() - 1);
-            return last_element.getNextSibling(); 
-            }
-        }
-        
+            return last_element.getNextSibling();
+            }
+        }
+
         }
         else {
@@ -222 +223 @@
     }
     else if(command_element_name.equals(COLLECTIONMETADATA_ELEMENT)) {
-        return self.metadataToString(command_element);
+        return self.metadataToString(command_element, show_extracted_namespace);
     }
     else if(command_element_name.equals(COLLECTIONMETADATA_CREATOR_ELEMENT)) {
-        return self.metadataToString(command_element);
+        return self.metadataToString(command_element, show_extracted_namespace);
     }
     else if(command_element_name.equals(COLLECTIONMETADATA_MAINTAINER_ELEMENT)) {
-        return self.metadataToString(command_element);
+        return self.metadataToString(command_element, show_extracted_namespace);
     }
     else if(command_element_name.equals(COLLECTIONMETADATA_PUBLIC_ELEMENT)) {
-        return self.metadataToString(command_element);
+        return self.metadataToString(command_element, show_extracted_namespace);
     }
     else if(command_element_name.equals(COLLECTIONMETADATA_BETA_ELEMENT)) {
-        return self.metadataToString(command_element);
+        return self.metadataToString(command_element, show_extracted_namespace);
     }
     else if(command_element_name.equals(PLUGIN_ELEMENT)) {
@@ -291 +292 @@
         arguments.put(name, null);
         name = null;
-        } 
+        }
     }
     return arguments;
     }
 
-    static private ArrayList known_metadata;   
+    static private ArrayList known_metadata;
 
     static private CollectionConfiguration self;
@@ -598 +599 @@
     document_element = null;
     return element;
-    }    
+    }
 
     private String indexesToString(Element command_element, boolean show_extracted_namespace) {
@@ -693 +694 @@
         if(j < language_elements_length - 1) {
         text.append(SPACE_CHARACTER);
-        }  
+        }
     }
     return text.toString();
@@ -727 +728 @@
     }
 
-    static public String metadataToString(Element command_element) {
+    static public String metadataToString(Element command_element, boolean text_value) {
     // If there is no value attribute, then we don't write anything
     String value_str = MSMUtils.getValue(command_element);
@@ -766 +767 @@
         }
         name_str = null;
+
+        // The value string we retrieved will be encoded for xml, so we now decode it - to text if text_value set. This parameter was originally show_extracted_namespace, but sincethis is only true for 'toString()' commands from within the CDM, its good enough to determine if this toString() will be used to display on screen, or write to collect.cfg
+        if(text_value == CollectionMeta.TEXT) {
+        value_str = Codec.transform(value_str, Codec.DOM_TO_TEXT);
+        }
+        else {
+            value_str = Codec.transform(value_str, Codec.DOM_TO_GREENSTONE);
+        }
+
         // We don't wrap the email addresses in quotes, nor any string without spaces
         if(value_str.indexOf(SPACE_CHARACTER) == -1) {
@@ -906 +916 @@
             String name = (String) names.next();
             String value = (String) arguments.get(name); // Can be null
+            // The metadata argument gets added as the content attribute
+            if(name.equals(METADATA_ARGUMENT) && value != null) {
+            // The metadata argument must be the fully qualified name of a metadata element, so if it doesn't yet have a namespace, append the extracted metadata namespace.
+            if(value.indexOf(MSMUtils.NS_SEP) == -1) {
+                value = Utility.EXTRACTED_METADATA_NAMESPACE + MSMUtils.NS_SEP + value;
+            }
+            //command_element.setAttribute(CONTENT_ATTRIBUTE, value);
+            }
             // Everything else is an Option Element
             Element option_element = document.createElement(OPTION_ELEMENT);
@@ -913 +931 @@
             if(value.startsWith(SPEECH_CHARACTER) && value.endsWith(SPEECH_CHARACTER)) {
                 value = value.substring(1, value.length() - 1);
-            }
-            // The metadata argument gets added as the content attribute
-            if(name.equals(METADATA_ARGUMENT) && value != null) {
-                // The metadata argument must be the fully qualified name of a metadata element, so if it doesn't yet have a namespace, append the extracted metadata namespace.
-                if(value.indexOf(MSMUtils.NS_SEP) == -1) {
-                value = Utility.EXTRACTED_METADATA_NAMESPACE + MSMUtils.NS_SEP + value;
-                }
-                //command_element.setAttribute(CONTENT_ATTRIBUTE, value);
             }
             MSMUtils.setValue(option_element, value);
@@ -1139 +1149 @@
         }
         if(value_str != null) {
+            // Ready the value str (which can contain all sorts of funky characters) for writing as a DOM value
+            value_str = Codec.transform(value_str, Codec.GREENSTONE_TO_DOM);
             command_element.setAttribute(NAME_ATTRIBUTE, name_str);
             command_element.setAttribute(LANGUAGE_ATTRIBUTE, language_str);
-            MSMUtils.setValue(command_element, Utility.encodeXML(value_str));
+            MSMUtils.setValue(command_element, value_str);
         }
         else {
@@ -1176 +1188 @@
             command_element = document.createElement(COLLECTIONMETADATA_PUBLIC_ELEMENT);
         }
-        if(command_element != null && value_str != null) {
+        if(command_element != null) {
             command_element.setAttribute(NAME_ATTRIBUTE, name_str);
             command_element.setAttribute(LANGUAGE_ATTRIBUTE, ENGLISH_LANGUAGE_STR);
@@ -1275 +1287 @@
             search_element = null;
         }
-        }    
+        }
     }
     catch(Exception exception) {
@@ -1350 +1362 @@
     catch(Exception exception) {
     }
-    return command_element; 
+    return command_element;
     }
 
@@ -1402 +1414 @@
     catch(Exception exception) {
     }
-    return command_element; 
+    return command_element;
     }
 
@@ -1564 +1576 @@
      * @param str the String to be written
      */
-    private void write(BufferedWriter writer, String str) 
+    private void write(BufferedWriter writer, String str)
     throws IOException {
     writer.write(str, 0, str.length());

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

@@ -37 +37 @@
 import org.greenstone.gatherer.cdm.Index;
 import org.greenstone.gatherer.msm.MSMUtils;
+import org.greenstone.gatherer.util.Codec;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
@@ -46 +47 @@
 public class CollectionMeta
     implements DOMProxyListEntry {
+
+    static final public boolean TEXT = true;
+    static final public boolean GREENSTONE = false;
+
     private Element element;
     private String text;
@@ -113 +118 @@
      * @return The value of value as a <strong>String</strong>.
      */
-    public String getValue() {
-    // We have to replace the string made of '\' 'n' with the '\n' character! Also watch for other greenstone magic
-    return Utility.decodeGreenstone(MSMUtils.getValue(element));
+    public String getValue(boolean text_value) {
+    String raw_value = MSMUtils.getValue(element);
+    // Decode the raw value depending on whether the user asked for the TEXT or GREENSTONE version
+    if(text_value == TEXT) {
+        return Codec.transform(raw_value, Codec.DOM_TO_TEXT);
+    }
+    else {
+        return Codec.transform(raw_value, Codec.DOM_TO_GREENSTONE);
+    }
     }
 
@@ -143 +154 @@
      * @param value the new value as a String.
      */
-    public void setValue(String value) {
-    MSMUtils.setValue(element, Utility.encodeGreenstone(value));
+    public void setValue(String raw_value) {
+    // Only raw html text can be given to setValue so we need to encode it
+    MSMUtils.setValue(element, Codec.transform(raw_value, Codec.TEXT_TO_DOM));
     text = null; // Reset text
     }