Changeset 3645 for trunk/gsdl3/src/java/org/greenstone/gsdl3/action/Action.java

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

File:

• trunk/gsdl3/src/java/org/greenstone/gsdl3/action/Action.java (modified) (3 diffs)

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);
     
-
+    
 }