Changeset 3645

Timestamp:

2003-01-06T15:23:47+13:00 (21 years ago)

Author:

kjdon

Message:

actions tidied up a bit, ResourceAction changed to DocumentAction, BuildAction removed, more general ProcessAction added

Location:

trunk/gsdl3/src/java/org/greenstone/gsdl3/action

Files:

• Action.java (modified) (3 diffs)
• AppletAction.java (modified) (1 diff)
• BrowseAction.java (modified) (3 diffs)
• BuildAction.java (deleted)
• DocumentAction.java (added)
• PageAction.java (modified) (4 diffs)
• ProcessAction.java (added)
• QueryAction.java (modified) (6 diffs)
• ResourceAction.java (deleted)

trunk/gsdl3/src/java/org/greenstone/gsdl3/action/Action.java

@@ -18 +18 @@
     protected XMLConverter converter_=null;
     /** cgi args converter */
-    protected CGIArgConverter cgi_=null;
+    protected GSCGI cgi_ = null;
     /** a transformer class to transform xml using xslt */
     protected XMLTransformer transformer_=null;
-
     /** a reference to the message router that it must talk to to
      * get info. it may be a communicator acting as a proxy, but it 
      doesn't care about that */
     protected ModuleInterface mr_=null;
-
 
     public Action() {
@@ -41 +39 @@
        mr_ = m;
     }
-
-    public void setCGIConverter(CGIArgConverter cgi) {
+    /** sets the GSCGI object - used to convert between short and long names
+     * of params */
+    public void setCGI(GSCGI cgi) {
     cgi_ = cgi;
+    // add in any action specific params
+    addCGIParams();
     }
     public void configure() {
     // does nothing yet
     }
-
+    /** any action specific cgi params should be added to the GSCGI object-
+     * overwrite this if a new action has its own params
+     * using cgi_.addStaticParam(param-name) */
+    protected void addCGIParams() {
+    
+    }
     /** process takes an xml representation of cgi args
      * and returns the page of results - may be in html/xml/other
@@ -60 +66 @@
     }
     
+    /** the main process method - must be implemented in subclass */
     abstract public Element process(Element xml_in);
     
-
+    
 }
 

trunk/gsdl3/src/java/org/greenstone/gsdl3/action/AppletAction.java

@@ -40 +40 @@
     HashMap params = GSXML.extractParams(cgi_param_list);
 
-    String collection = (String)params.get("collection");
-    String service_name=(String)params.get("serviceName");
+    String collection = (String)params.get(GSCGI.COLLECTION_ARG);
+    String service_name=(String)params.get(GSCGI.SERVICE_ARG);
     service_name+= "Applet";
     

trunk/gsdl3/src/java/org/greenstone/gsdl3/action/BrowseAction.java

@@ -51 +51 @@
 
     // extract the params from the cgi-request, and check that we have a coll specified
-    // first convert short to long names
     Element cgi_paramList = (Element)GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
-    cgi_.toLong(cgi_paramList);
     HashMap params = GSXML.extractParams(cgi_paramList);
 
-    String collection = (String)params.get("collection");
+    String collection = (String)params.get(GSCGI.COLLECTION_ARG);
     if (collection == null || collection.equals("")) {
         System.err.println("BrowseAction Error:classifierbrowse, need to specify a collection!");
@@ -90 +88 @@
     
     // if there is a cl field in the cgi params, get the classifier info
-    String node = (String)params.get("classifier");
+    String node = (String)params.get("cl");
     
     if (node!=null && !node.equals("")) {
@@ -110 +108 @@
         
         // content - contains the classifier node, may be more than one
-        // call this resource list for now
+        // call this document list for now
         Element query_content = doc_.createElement(GSXML.CONTENT_ELEM);
         mr_query_request.appendChild(query_content);
         
-        Element resource_list = doc_.createElement(GSXML.RESOURCE_ELEM+GSXML.LIST_MODIFIER);
-        Element resource = doc_.createElement(GSXML.RESOURCE_ELEM);
-        resource.setAttribute(GSXML.NAME_ATT, node);
-        resource_list.appendChild(resource);
-        query_content.appendChild(resource_list);
+        Element document_list = doc_.createElement(GSXML.DOCUMENT_ELEM+GSXML.LIST_MODIFIER);
+        Element document = doc_.createElement(GSXML.DOCUMENT_ELEM);
+        document.setAttribute(GSXML.NAME_ATT, node);
+        document_list.appendChild(document);
+        query_content.appendChild(document_list);
         
         Element mr_query_response = (Element)mr_.process(mr_query_message);

trunk/gsdl3/src/java/org/greenstone/gsdl3/action/PageAction.java

@@ -14 +14 @@
 public class PageAction extends Action {
 
+    public static final String SHORT_ACTION_NAME = "p";
+    public static final String HOME_PAGE = "home";
+    public static final String ABOUT_PAGE = "about";
+
+    public String getActionShortName() {
+    return SHORT_ACTION_NAME;
+    }
     public Element process (Element message) {
     
@@ -20 +27 @@
     String page_name = request.getAttribute(GSXML.SUBACTION_ATT);
     if (page_name.equals("")) { // if no page specified, assume home page
-        page_name = "home";
+        page_name = HOME_PAGE;
     }
     
@@ -30 +37 @@
     // add the system stuff from message
     page.appendChild(doc_.importNode(GSXML.getChildByTagName(message, GSXML.CONFIGURATION_ELEM), true));
-    
-    if (page_name.equals("home")) {
+    // add the cgi args request
+    Element cgi_request = (Element)doc_.importNode(request, true);
+    page.appendChild(cgi_request);
+
+    if (page_name.equals(HOME_PAGE)) {
         return homePage(page, request);
-    } else if (page_name.equals("about")) {
+    } else if (page_name.equals(ABOUT_PAGE)) {
         return aboutPage(page, request);
     } else {
@@ -111 +121 @@
     HashMap params = GSXML.extractParams(cgi_paramList);
     
-    String coll_name = (String)params.get("collection");
-    if (coll_name == null || coll_name.equals("")) {
-        coll_name = (String)params.get("serviceCluster"); // cluster name
-    }
+    String coll_name = (String)params.get(GSCGI.COLLECTION_ARG);
     if (coll_name == null || coll_name.equals("")) {
         System.err.println("PageAction Error: about page requested with no collection or cluster specified!");

trunk/gsdl3/src/java/org/greenstone/gsdl3/action/QueryAction.java

@@ -59 +59 @@
     HashMap params = GSXML.extractParams(cgi_param_list);
 
-    String collection = (String)params.get("collection");
+    String collection = (String)params.get(GSCGI.COLLECTION_ARG);
     if (collection == null || collection.equals("")) {
         System.err.println("QueryAction Error: no collection was specified!");
@@ -77 +77 @@
 
     Element mr_info_response = (Element) mr_.process(mr_info_message);
-    System.out.println("describe response from query=");
-    System.out.println(converter_.getString(mr_info_response));
     String path = GSXML.RESPONSE_ELEM;
     path = GSPath.appendLink(path, GSXML.SERVICE_ELEM);
@@ -87 +85 @@
         System.out.println("adding shortnames");
         // add short names to the params in the param list
-        cgi_.addShortNames(pl);
+        cgi_.paramListAddShortNames(pl);
         // for each param in the description, overwrite teh default value with the currently set value if present 
         Element param = (Element)pl.getFirstChild();
@@ -116 +114 @@
         }
     }
-    System.out.println(converter_.getString(pl));
     
     // part of the data for the description is the cgi-params
@@ -148 +145 @@
     // for now, just create a whole new request
     
-    // check that there are some resources - for now check the list, but later should use a numdocs metadata elem
+    // check that there are some documents - for now check the list, but later should use a numdocs metadata elem
     path = GSXML.RESPONSE_ELEM;
     path = GSPath.appendLink(path, GSXML.CONTENT_ELEM);
-    path = GSPath.appendLink(path, GSXML.RESOURCE_ELEM+GSXML.LIST_MODIFIER);
-    
-    Element resource_list = (Element)GSXML.getNodeByPath(mr_query_response,
-                                 path); // resourceList not present if no docs found
-    if (resource_list == null) {
+    path = GSPath.appendLink(path, GSXML.DOCUMENT_ELEM+GSXML.LIST_MODIFIER);
+    
+    Element document_list = (Element)GSXML.getNodeByPath(mr_query_response,
+                                 path); // documentList not present if no docs found
+    if (document_list == null) {
         
         Element result_response = (Element)GSXML.getChildByTagName(mr_query_response, GSXML.RESPONSE_ELEM);
@@ -182 +179 @@
     
     // the first part of the content is the doc list
-    meta_content.appendChild(doc_.importNode(resource_list, true));
+    meta_content.appendChild(doc_.importNode(document_list, true));
     
     // the second part of the content is the metadata list