source: trunk/gsdl3/src/java/org/greenstone/gsdl3/action/Action.java@ 3913

package org.greenstone.gsdl3.action;

import org.greenstone.gsdl3.core.ModuleInterface;
import org.greenstone.gsdl3.util.*;
// XML classes
import org.w3c.dom.Node; 
import org.w3c.dom.Element; 
import org.w3c.dom.Document; 

/** base class for Actions */
abstract public class Action {

    /** the interface setup variables */
    protected ConfigVars config_=null;
    /** container Document to create XML Nodes */
    protected Document doc_=null; 
    /** a converter class to parse XML and create Docs */
    protected XMLConverter converter_=null;
    /** cgi args converter */
    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() {
    converter_ = new XMLConverter();
    transformer_ = new XMLTransformer();
    doc_ = converter_.newDOM();
    }
    /** gsdl_home_ must be set before configure called */
    public void setConfigVars(ConfigVars config) {
    config_ = config;
    }
    /** sets the message router */
    public void setMessageRouter(ModuleInterface m) {
       mr_ = m;
    }
    /** 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
     * depending on the output att of the request */
    public String process(String xml_in) {
       
    Element message = converter_.getDOM(xml_in).getDocumentElement();
    
    Element result = process(message);
    return converter_.getString(result);
    }
    
    /** the main process method - must be implemented in subclass */
    abstract public Element process(Element xml_in);


}