Changeset 3509

Timestamp:

2002-10-30T10:37:02+13:00 (21 years ago)

Author:

kjdon

Message:

made all the xml elem names etc constants

File:

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

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

@@ -12 +12 @@
 public class GSXML {
 
+    // greenstone xml elements
+    public static final String MESSAGE_ELEM = "message";
+    public static final String REQUEST_ELEM = "request";
+    public static final String RESPONSE_ELEM = "response";
+    public static final String COLLECTION_ELEM = "collection";
+    public static final String SERVICE_ELEM = "service";
+    public static final String CLUSTER_ELEM = "serviceCluster";
+    public static final String SITE_ELEM = "site";
+    public static final String PARAM_ELEM = "param";
+    public static final String OPTION_ELEM = "option";
+    public static final String CONTENT_ELEM = "content";
+    public static final String RESOURCE_ELEM = "resource";
+    public static final String METADATA_ELEM = "metadata";
+    public static final String SERVICE_IMPL_ELEM = "servicesImpl";
+    // add on to another elem type to get a list of that type
+    public static final String LIST_MODIFIER = "List";
+
+    //public static final String
+    //public static final String
+
+    // greenstone xml attributes
+    public static final String NAME_ATT = "name";
+    public static final String TO_ATT = "to";
+    public static final String FROM_ATT = "from";
+    public static final String LANG_ATT = "lang";
+    public static final String TYPE_ATT = "type";
+    public static final String VALUE_ATT = "value";
+    public static final String DEFAULT_ATT = "default";
+    public static final String INFO_ATT = "info";
+    // parameter types
     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_INPUT = "input";
-  // takes a node with a resource elements inside it and extracts all the 
-  // HASh oids - name att for resource
+
+    // request types
+    public static final String REQUEST_TYPE_DESCRIBE = "describe";
+    public static final String REQUEST_TYPE_CONFIGURE = "configure";
+    public static final String REQUEST_TYPE_QUERY = "query";
+    // public static final String REQUEST_TYPE_
+    
+    // takes a node with a resource elements inside it and extracts all the 
+    // HASh oids - name att for resource
     public static String [] getResourceNameList(Element content) {
     
     Node n = content.getFirstChild();
-    while (n!=null && !n.getNodeName().equals("resourceList")) {
+    while (n!=null && !n.getNodeName().equals(RESOURCE_ELEM+LIST_MODIFIER)) {
         n = n.getNextSibling();
     }
@@ -34 +71 @@
     for (int i=0; i<numdocs; i++) {
         Element e = (Element)docs.item(i);
-        String id = e.getAttribute("name");
+        String id = e.getAttribute(NAME_ATT);
         // check that its a valid id - ie starts with HASH 
         // need to change this if use different ids
@@ -48 +85 @@
     public static String [] getMetaNameList(Element content) {
     Node n = content.getFirstChild();
-    while (n!=null && !n.getNodeName().equals("metadataList")) {
+    while (n!=null && 
+           !n.getNodeName().equals(METADATA_ELEM+LIST_MODIFIER)) {
         n = n.getNextSibling();
     }
@@ -60 +98 @@
     for (int i=0; i<numelems; i++) {
         Element e = (Element)elems.item(i);
-        String id = e.getAttribute("name");
+        String id = e.getAttribute(NAME_ATT);
         ids[i] = id;
     }
@@ -70 +108 @@
     public static HashMap extractParams(Element xml) {
 
-    if (!xml.getNodeName().equals("paramList")) {
+    if (!xml.getNodeName().equals(PARAM_ELEM+LIST_MODIFIER)) {
         System.err.println("GSXML:paramList element should have been passed to extractParams, instead it was "+xml.getNodeName());
         return null;
@@ -78 +116 @@
     for (int i=0; i<params.getLength(); i++) {
         Element param = (Element)params.item(i);
-        String name=param.getAttribute("name");
-        String value=param.getAttribute("value");
+        String name=param.getAttribute(NAME_ATT);
+        String value=param.getAttribute(VALUE_ATT);
         if (value.equals("")) { // the value is in the content of the param
         value=getNodeText(param); 
@@ -90 +128 @@
 
     public static String getValue(Element e) {
-    String val = e.getAttribute("value");
+    String val = e.getAttribute(VALUE_ATT);
     if (val ==null || val.equals("")) {
         // have to get it out of the text
@@ -112 +150 @@
     /** creates a new document Element */
     public static Element createResourceElement(Document owner, String oid) { 
-    Element e = owner.createElement("resource");
-    e.setAttribute("name", oid);
+    Element e = owner.createElement(RESOURCE_ELEM);
+    e.setAttribute(NAME_ATT, oid);
     
     return e;