Changeset 3576

Timestamp:

2002-11-26T14:05:37+13:00 (21 years ago)

Author:

kjdon

Message:

added some comments, now uses GSXML.static variables instead of strings for xml names

File:

• trunk/gsdl3/src/java/org/greenstone/gsdl3/util/CGIArgConverter.java (modified) (7 diffs)

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

@@ -4 +4 @@
 import org.w3c.dom.Element;
 
+/** converts long names for parameters into short names for cgi args, and vice versa */
 public class CGIArgConverter {
 
+    /** long to short mapping */
     protected HashMap long_map_=null;
+    /** short to long mapping */
     protected HashMap short_map_=null;
     
+    /** initialises the maps with known parameters */
     public CGIArgConverter() {
     long_map_ = new HashMap();
@@ -14 +18 @@
 
     // initialize with the ones we know about
+    short_map_.put("a", "action"); 
+    long_map_.put("action", "a");
+
+    short_map_.put("sa", "subaction"); 
+    long_map_.put("subaction", "sa");   
+
+    short_map_.put("sn", "serviceName"); 
+    long_map_.put("serviceName", "sn"); 
+
+    short_map_.put("sc", "serviceCluster");
+    long_map_.put("serviceCluster", "sc");
+
+    short_map_.put("l", "lang"); 
+    long_map_.put("lang", "l");
+
+    short_map_.put("c", "collection"); 
+    long_map_.put("collection", "c");
+
+    long_map_.put("resource", "r");
+    short_map_.put("r", "resource");
+
+    // these are service specific - should we have these here??
     long_map_.put("case", "k");
     short_map_.put("k", "case");
@@ -35 +61 @@
     short_map_.put("md", "maxDocs");
 
-    short_map_.put("c", "collection"); 
-    long_map_.put("collection", "c");
-
-    short_map_.put("a", "action"); 
-    long_map_.put("action", "a");
-
-    short_map_.put("sa", "subaction"); 
-    long_map_.put("subaction", "sa");   
-
-    short_map_.put("sn", "serviceName"); 
-    long_map_.put("serviceName", "sn"); 
-
-    short_map_.put("sc", "serviceCluster");
-    long_map_.put("serviceCluster", "sc");
-
-    short_map_.put("l", "lang"); 
-    long_map_.put("lang", "l");
-
     long_map_.put("query", "q");
     short_map_.put("q", "query");
     
-    long_map_.put("resource", "r");
-    short_map_.put("r", "resource");
-
     short_map_.put("cl", "classifier"); 
     long_map_.put("classifier", "cl");
     }
 
+    /** takes a paramList element  - contains <param name="x"> elements
+     * converts all the short names to long names 
+     * returns true if successful, false otherwise */
     public boolean toLong(Element param_list) {
     
-    if (!param_list.getNodeName().equals("paramList")) {
-        System.out.println("wrong element to CGIArgConverter:toLong");
+    if (!param_list.getNodeName().equals(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER)) {
+        System.err.println("CGIArgConverter Error: wrong element passed to toLong");
         return false;
     }
@@ -72 +80 @@
     Element param = (Element)param_list.getFirstChild();
     while (param!=null) {
-        String name = param.getAttribute("name");
-        param.setAttribute("name", toLong(name));
+        String name = param.getAttribute(GSXML.NAME_ATT);
+        param.setAttribute(GSXML.NAME_ATT, toLong(name));
+        param = (Element)param.getNextSibling();
+    }
+    return true;
+
+    }
+    /** adds shortnames to the params in the list */
+    public boolean addShortNames(Element param_list) {
+    if (!param_list.getNodeName().equals(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER)) {
+        System.err.println("CGIArgConverter Error: wrong element passed to addShortNames");
+        return false;
+    }
+    
+    Element param = (Element)param_list.getFirstChild();
+    while (param!=null) {
+        String name = param.getAttribute(GSXML.NAME_ATT);
+        param.setAttribute(GSXML.PARAM_SHORTNAME_ATT, toShort(name));
         param = (Element)param.getNextSibling();
     }
@@ -80 +104 @@
     }
     
-    public boolean  addShortNames(Element param_list) {
-    if (!param_list.getNodeName().equals("paramList")) {
-        System.out.println("wrong element to CGIArgConverter:toShort");
-        return false;
-    }
-    
-    Element param = (Element)param_list.getFirstChild();
-    while (param!=null) {
-        String name = param.getAttribute("name");
-        param.setAttribute("shortname", toShort(name));
-        param = (Element)param.getNextSibling();
-    }
-    return true;
-
-    }
-    
-
+    /** returns the long form of a short arg - 
+     * returns the original if it doesn't know about this short arg */
     public String toLong(String short_name) {
-    
     
     if (short_map_.containsKey(short_name)) {
         return (String)short_map_.get(short_name);
     }
-    System.err.println("CGIArgConverter: short name '"+short_name+"' not found in map!");
     return short_name; // just return the original
     }
-
+    /** returns the short form of a long arg */
     public String toShort(String long_name) {
 
@@ -119 +126 @@
     return short_name;
     }
-
+    
+    /** tries to create a new short form of the long name - 
+     * if it cant, it just returns the original name */
     protected String newShortName(String long_name) {
-
+    
     // for now, try the first letter, then first two etc.
     int i=1;
@@ -129 +138 @@
         short_try = long_name.substring(0, i);
     }
-    if (i==long_name.length()) {
-        return ""; // couldn't find one
-    }
     return short_try;
+    
     }
 }