Changeset 3850 for trunk/gsdl3

Timestamp:

2003-03-11T16:53:23+13:00 (21 years ago)

Author:

kjdon

Message:

added more stuff

File:

• trunk/gsdl3/src/java/org/greenstone/gsdl3/util/GSXML.java (modified) (12 diffs)

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

@@ -35 +35 @@
     public static final String ERROR_ELEM = "error";
     public static final String DEFAULT_ELEM = "default";
-    public static final String STYLESHEET_ELEM = "stylesheet"; // any additional stylesheet stuff is carried in the message inside this elem
+    public static final String STYLESHEET_ELEM = "format";//"stylesheet"; // any additional stylesheet stuff is carried in the message inside this elem
+    public static final String FORMAT_ELEM = "format"; // config files use format - shoudl we use this instead of stylesheet??
     public static final String TERM_ELEM = "term";
 
+    //config file elems
+    public static final String INDEX_ELEM = "index";
+    public static final String SEARCH_ELEM = "search";
+    public static final String BROWSE_ELEM = "browse";
+    public static final String FIELD_ELEM = "field";
+    public static final String DISPLAYNAME_ELEM = "displayName";
+    public static final String SHORTNAME_ATT = "shortname";
     // elems for the pages to be processed by xslt
     public final static String PAGE_ELEM = "page";
@@ -66 +74 @@
     public static final String PARAM_SHORTNAME_ATT = "shortname";
     public static final String PARAM_IGNORE_POS_ATT = "ignore";
-
+    public static final String CLASSIFIER_CONTENT_ATT = "content";
     public static final String DOC_NODE_ELEM = "documentNode";
     public static final String DOC_NODE_ID_ATT = "documentID";
@@ -79 +87 @@
     public static final String PARAM_TYPE_INTEGER = "integer";
     public static final String PARAM_TYPE_BOOLEAN = "boolean";
-    public static final String PARAM_TYPE_ENUM = "enum";
+    public static final String PARAM_TYPE_ENUM_START = "enum";
     public static final String PARAM_TYPE_ENUM_SINGLE = "enum_single";
     public static final String PARAM_TYPE_ENUM_MULTI = "enum_multi";
@@ -119 +127 @@
     
     // takes a node with a resource elements inside it and extracts all the 
-    // HASh oids - name att for resource
+    // HASH oids - name att for resource
+    // generalise this for any element type? pass in the list, the element name, the att to extract
     public static String [] getDocumentNameList(Element content) {
     
@@ -147 +156 @@
     }
 
+    // same as above function
     /** extracts metadata names out of an element */
     public static String [] getMetaNameList(Element content) {
@@ -170 +180 @@
     }
 
+    // combine the next two??
     /** takes a paramList element, and gets a HashMap of name-value pairs */
     public static HashMap extractParams(Element xml) {
@@ -213 +224 @@
     }
 
+    /** gets the value att or the text content */
     public static String getValue(Element e) {
     String val = e.getAttribute(VALUE_ATT);
@@ -222 +234 @@
     return val;
     }
+    
     /** extracts the text out of a node */
     public static String getNodeText(Element param) {
@@ -289 +302 @@
     }
 
+    /** copies the metadata out of teh metadataList of 'from' into
+     * the metadataList of 'to' */
     public static boolean mergeMetadataLists(Node to, Node from) {
     Node to_meta = getChildByTagName(to, METADATA_ELEM+LIST_MODIFIER);
@@ -428 +443 @@
         p.setAttribute(DEFAULT_ATT, default_value);
     }
-    if (type.startsWith(PARAM_TYPE_ENUM) && options!=null) {
+    if (type.startsWith(PARAM_TYPE_ENUM_START) && options!=null) {
         for (int i=0; i<options.length; i++) {
         Element e = owner.createElement(PARAM_OPTION_ELEM);
@@ -460 +475 @@
     return param;
     }
-
+    /*
+    public static Element createClassifierDisplay(Document owner, String name,
+                          String name_text) {
+    Element classifier = owner.createElement(CLASSIFIER_ELEM);
+    classifier.setAttribute(NAME_ATT, name);
+    classifier.appendChild(createTextElement(owner, DISPLAY_NAME_ELEM, name_text));
+    
+    return classifier;
+    }
+
+    *
     /** returns the element parent/node_name[@attribute_name='attribute_value']
      */
@@ -479 +504 @@
     }
 
+
+    /** Returns the appropriate language element from a display elem,
+     display is the containing element, name is the name of the element to 
+     look for, lang is the preferred language, lang_default is the fall back 
+     lang if neither lang is found, will return the first one it finds*/
+    public static String getDisplayText(Element display, String name,
+                       String lang, String lang_default) {
+    Element item = getNamedElement(display, name, GSXML.LANG_ATT, lang);
+    if (item==null) {
+        item = getNamedElement(display, name, GSXML.LANG_ATT, lang_default);
+    }
+    if (item ==null) {
+        item = (Element)getChildByTagName(display, name); // just get the first one
+    }
+    if (item==null) {
+        return ""; // should we return an empty string? or null?
+    }
+    return getNodeText(item);
+
+    }
     // replaces < > " ' & in the original with their entities
     public static String xmlSafe(String original) {