Changeset 25300

Timestamp:

2012-03-27T15:15:07+13:00 (12 years ago)

Author:

kjdon

Message:

a little bit of tidying up. adding a few more string constants to GSParams

Location:

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

Files:

• GSParams.java (modified) (8 diffs)
• GSXML.java (modified) (4 diffs)
• MacroResolver.java (modified) (1 diff)

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

@@ -25 +25 @@
 {
 
+  // cgi parameter names
     public static final String ACTION = "a"; // the major type of action- eg query or browse or process
     public static final String SUBACTION = "sa"; // subtype of action if we want different processing than the default
@@ -30 +31 @@
     public static final String RESPONSE_ONLY = "ro"; // if == 1 do the request and pass back the response xml - no page formatting
     public static final String OUTPUT = "o"; // if processing is to be done, what type of output - html/xml/other??
-    public static final String HTTPHEADERFIELDS = "hhf";
     public static final String SERVICE = "s"; // the name of the service
+
     public static final String CLUSTER = "c"; // these two are the same
-    public static final String SYSTEM = "s";
-    public static final String CONFIGURE = "c";
     public static final String COLLECTION = "c";
+    public static final String COLLECTION_TYPE = "ct"; // collection type - mg, mgpp, lucene etc
+
     public static final String LANGUAGE = "l";
     public static final String DOCUMENT = "d";
     public static final String DOCUMENT_TYPE = "dt";
-    public static final String RESOURCE = "r";
+  public static final String HREF = "href"; // url. might be an external url, or a relative one that needs translating
+  public static final String RELATIVE_LINK = "rl"; // whether the href url is relative to the collection or not.
+  public static final String EXTERNAL_LINK_TYPE = "el"; // for an external link, go direct to the page or frame it in the collection
     public static final String PROCESS_ID = "pid"; // if a request wasn't completed, this identifies the request - used when asking for a status update
-    public static final String COLLECTION_TYPE = "ct";
 
-    public static final String SIBLING = "sib"; // this should not be in here
+    
+  public static final String HTTPHEADERFIELDS = "hhf";
+
     // internal configure args
     public static final String SYSTEM_SUBSET = "ss";
@@ -49 +53 @@
     public static final String SYSTEM_MODULE_NAME = "sn";
     public static final String SYSTEM_MODULE_TYPE = "st";
-
-    public static final String EXPAND_DOCUMENT = "ed";
-    public static final String EXPAND_CONTENTS = "ec";
-    public static final String REALISTIC_BOOK = "book";
 
     // used for filtering out a piece of the final page
@@ -68 +68 @@
     public static final String S_OLD_PASSWORD = "s1.oldPassword";
 
+  // some standard arg values
+  public static final String SYSTEM_ACTION = "s";
+ 
+  public static final String EXTERNAL_LINK_TYPE_DIRECT = "direct";
+  public static final String EXTERNAL_LINK_TYPE_FRAMED = "frame";
+
     protected HashMap param_map = null;
 
@@ -79 +85 @@
         addParameter(REQUEST_TYPE, false);
         addParameter(RESPONSE_ONLY, false);
-        addParameter(CLUSTER, false); // we don't want to save collection 
-        //addParameter(COLLECTION); 
+        addParameter(CLUSTER, false); // we don't want to save cluster/collection 
         addParameter(LANGUAGE, true);
         addParameter(DOCUMENT, true);
-        addParameter(RESOURCE, true);
+        addParameter(DOCUMENT_TYPE, true);
+        // should the following two just be in doc action??
+        addParameter(HREF, false);
+        addParameter(RELATIVE_LINK, false);
         addParameter(OUTPUT, false);
         addParameter(SERVICE, false);
@@ -91 +99 @@
         addParameter(SYSTEM_MODULE_NAME, false);
         addParameter(SYSTEM_MODULE_TYPE, false);
-        addParameter(SIBLING, false);
-        addParameter(DOCUMENT_TYPE, true);
-        addParameter(EXPAND_DOCUMENT, false);
-        addParameter(EXPAND_CONTENTS, false);
-        addParameter(REALISTIC_BOOK, false);
         addParameter(INLINE_TEMPLATE, false);
         addParameter(DISPLAY_METADATA, false);
@@ -103 +106 @@
         addParameter(S_OLD_PASSWORD, false);
 
-        //addParameter();
-        // ugly hack so we don't save the extlink param
-        addParameter("s0.ext", false);
-        addParameter(COLLECTION_TYPE, true); // collection type - mg or mgpp
-
+        addParameter(COLLECTION_TYPE, true); 
+        addParameter(EXTERNAL_LINK_TYPE, false);
         // filtering args must be specified each time
         addParameter(EXCERPT_ID, false);
@@ -141 +141 @@
     public boolean shouldSave(String name)
     {
+      // p. is used to store previous settings
         if (name.startsWith("p."))
             return false;

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

@@ -49 +49 @@
     static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.GSXML.class.getName());
 
-    // greenstone xml elements
+    // greenstone message xml elements
     public static final String MESSAGE_ELEM = "message";
     public static final String REQUEST_ELEM = "request";
@@ -92 +92 @@
     public static final String DISPLAY_ELEM = "display";
     public static final String LEVEL_ELEM = "level";
+        public static final String REPLACE_ELEM = "replace";
 
     public static final String DBINFO_ELEM = "dbInfo";
@@ -122 +123 @@
     // add on to another elem type to get a list of that type
     public static final String LIST_MODIFIER = "List";
-
+  // used to refer back to another element type
+        public static final String REF_MODIFIER = "Ref";
     // greenstone xml attributes
     public static final String COLLECTION_ATT = "collection";
@@ -156 +158 @@
     public static final String NODE_STRUCTURE_ELEM = "nodeStructure";
     public static final String NODE_ID_ATT = "nodeID";
+        public static final String HREF_ID_ATT = "hrefId"; // for ids that need translating
+        public static final String ID_MOD_ATT = "idMod"; // might hold .rt etc for hrefIds
     public static final String NODE_OID = "oid";
     public static final String NODE_NAME_ATT = "nodeName";

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

@@ -78 +78 @@
     
     public void addMacros(Element replace_list_elem) {
-    NodeList replaces = replace_list_elem.getElementsByTagName("replace");
+    NodeList replaces = replace_list_elem.getElementsByTagName(GSXML.REPLACE_ELEM);
     for (int i=0; i<replaces.getLength(); i++) {
         Element e = (Element)replaces.item(i);