Changeset 24393

Timestamp:

2011-08-12T09:57:26+12:00 (13 years ago)

Author:

sjm84

Message:

Adding in the server-side code for the Document Maker as well as several other enhancements

Location:

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

Files:

• action/Action.java (modified) (2 diffs)
• action/GS2BrowseAction.java (modified) (1 diff)
• collection/Collection.java (modified) (2 diffs)
• service/AbstractBrowse.java (modified) (4 diffs)
• service/AbstractDocumentRetrieve.java (modified) (2 diffs)
• service/AbstractGS2DocumentRetrieve.java (modified) (7 diffs)
• service/ArchiveIO.java (added)
• service/DocXMLUtil.java (added)
• service/DocumentMaker.java (added)
• service/GS2Browse.java (modified) (1 diff)
• service/ServiceRack.java (modified) (2 diffs)
• util/DBHelper.java (added)
• util/DBInfo.java (modified) (1 diff)
• util/FlatDatabaseWrapper.java (modified) (1 diff)
• util/GDBMWrapper.java (modified) (1 diff)
• util/GSDocumentModel.java (added)
• util/GSXML.java (modified) (4 diffs)
• util/JDBMWrapper.java (modified) (1 diff)
• util/SimpleCollectionDatabase.java (modified) (1 diff)
• util/XMLTransformer.java (modified) (1 diff)
• util/XSLTUtil.java (modified) (1 diff)

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

@@ -77 +77 @@
     }
 
-    protected void extractMetadataNames(Element format, HashSet meta_names) {
+    protected void extractMetadataNames(Element format, HashSet meta_names) {
     //NodeList nodes = format.getElementsByTagNameNS("metadata", "http://www.greenstone.org/configformat");
     NodeList metadata_nodes = format.getElementsByTagName("gsf:metadata");
@@ -90 +90 @@
                 metadata.append("all");
                 metadata.append(GSConstants.META_RELATION_SEP);
-            } else if (all.equals("offset")) { // multiple is no longer boolean. 
-        // Can be "true", "false" or it can be "offset" (when requested to use mdoffset)
-                metadata.append("offset");
-                metadata.append(GSConstants.META_RELATION_SEP);
-            } // if multiple=false, then get first value for the metadata
+            }
             if (!select.equals("")) {
                 metadata.append(select);

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/action/GS2BrowseAction.java

@@ -272 +272 @@
         Element d = this.doc.createElement(GSXML.DOC_NODE_ELEM);
         d.setAttribute(GSXML.NODE_ID_ATT, ((Element)doc_nodes.item(c)).getAttribute(GSXML.NODE_ID_ATT));
-        if(((Element)doc_nodes.item(c)).hasAttribute(GSXML.NODE_MDOFFSET_ATT)) {
-            d.setAttribute(GSXML.NODE_MDOFFSET_ATT, ((Element)doc_nodes.item(c)).getAttribute(GSXML.NODE_MDOFFSET_ATT));
-        }
         doc_list.appendChild(d);
         }

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/collection/Collection.java

@@ -23 +23 @@
 import org.greenstone.gsdl3.service.*;
 
-
 // java XML classes we're using
-import org.w3c.dom.Document; 
-import org.w3c.dom.Node; 
-import org.w3c.dom.Element; 
-import org.w3c.dom.NodeList; 
+import org.w3c.dom.Document;
+import org.w3c.dom.Node;
+import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
 
 import java.io.*;
@@ -49 +48 @@
 
 /**
- * Represents a collection in Greenstone. A collection is an extension of
- * a ServiceCluster - it has local data that the services use.
- *
+ * Represents a collection in Greenstone. A collection is an extension of a
+ * ServiceCluster - it has local data that the services use.
+ * 
  * @author <a href="mailto:[email protected]">Katherine Don</a>
  * @see ModuleInterface
  */
-public class Collection 
-    extends ServiceCluster {
-
-    static Logger logger = Logger.getLogger(org.greenstone.gsdl3.collection.Collection.class.getName());
-
-    /** is this collection being tidied */
-    protected boolean useBook = false;
-    /** is this collection public or private */
-    protected boolean is_public = true;
-
-    /** does this collection provide the OAI service */
-    protected boolean has_oai = true;
-    /** time when this collection was built */
-    protected long lastmodified = 0;
-    /** earliestDatestamp of this collection. Necessary for OAI */
-    protected long earliestDatestamp = 0;
-
-
-    /** An element containing the serviceRackList element of buildConfig.xml, used to determine whether it contains
-     *  the OAIPMH serviceRack 
-     */
-    //protected Element service_rack_list = null;
-    
-    protected XMLTransformer transformer = null;
-    /** same as setClusterName */
-    public void setCollectionName(String name) {
-    setClusterName(name);
-    }
-
-    public Collection() {
-    super();
-    this.description = this.doc.createElement(GSXML.COLLECTION_ELEM);
-    
-    }
-    
-    /**
-     * Configures the collection.
-     *
-     * gsdlHome and collectionName must be set before configure is called.
-     *
-     * the file buildcfg.xml is located in gsdlHome/collect/collectionName
-     * collection metadata is obtained, and services loaded.
-     *
-     * @return true/false on success/fail
-     */
-    public boolean configure() {
-    
-    if (this.site_home == null || this.cluster_name== null) {
-        logger.error("Collection: site_home and collection_name must be set before configure called!");
-        return false;
-    }
-    
-    Element coll_config_xml = loadCollConfigFile();
-    Element build_config_xml = loadBuildConfigFile();
-    
-    if (coll_config_xml==null||build_config_xml==null) {
-        return false;
-    }
-    
-    // get the collection type attribute
-    Element search = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.SEARCH_ELEM); 
-    if(search!=null) {
-      col_type = search.getAttribute(GSXML.TYPE_ATT);
-    }
-    
-    // process the metadata and display items
-    findAndLoadInfo(coll_config_xml, build_config_xml);
-    
-    // now do the services
-    configureServiceRacks(coll_config_xml, build_config_xml);
-
-    return true;
-    
-    }
-
-    public boolean useBook() {
-        return useBook;
-    }
-    
-    public boolean isPublic() {
-    return is_public;
-    }
-    // Not used anymore by the OAIReceptionist to find out the earliest datestamp 
-    // amongst all oai collections in the repository. May be useful generally.
-    public long getLastmodified() {
-      return lastmodified;
-    }
-    //used by the OAIReceptionist to find out the earliest datestamp amongst all oai collections in the repository
-    public long getEarliestDatestamp() {
-    return earliestDatestamp;
-    }
-
-    /** whether the service_map in ServiceCluster.java contains the service 'OAIPMH'
-     *  11/06/2007 xiao
-     */
-    public boolean hasOAI() {
-      return has_oai;
-    }
-    /** 
-     * load in the collection config file into a DOM Element 
-     */    
-    protected Element loadCollConfigFile() {
-
-    File coll_config_file = new File(GSFile.collectionConfigFile(this.site_home, this.cluster_name));
-    
-    if (!coll_config_file.exists()) {
-        logger.error("Collection: couldn't configure collection: "+this.cluster_name+", "+coll_config_file+" does not exist");
-        return null;
-    }
-    // get the xml for both files
-    Document coll_config_doc = this.converter.getDOM(coll_config_file, CONFIG_ENCODING);
-    Element coll_config_elem = null;
-    if (coll_config_doc != null) {
-        coll_config_elem = coll_config_doc.getDocumentElement();
-    }
-    return coll_config_elem;
-
-    }
-    
-    /** 
-     * load in the collection build config file into a DOM Element 
-     */        
-    protected Element loadBuildConfigFile() {
-    
-    File build_config_file = new File(GSFile.collectionBuildConfigFile(this.site_home, this.cluster_name));
-    if (!build_config_file.exists()) {
-        logger.error("Collection: couldn't configure collection: "+this.cluster_name+", "+build_config_file+" does not exist");
-        return null;
-    }
-    Document build_config_doc = this.converter.getDOM(build_config_file, CONFIG_ENCODING);
-    Element build_config_elem = null;
-    if (build_config_doc != null) {
-        build_config_elem = build_config_doc.getDocumentElement();
-    }
-
-    lastmodified = build_config_file.lastModified();
-  
-    return build_config_elem;
-    }
-
-    /**
-     * find the metadata and display elems from the two config files and add it to the appropriate lists
-     */
-    protected boolean findAndLoadInfo(Element coll_config_xml, 
-                      Element build_config_xml){
-              
-      // metadata
-      Element meta_list = (Element)GSXML.getChildByTagName(coll_config_xml, GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER);
-      addMetadata(meta_list);
-      meta_list = (Element)GSXML.getChildByTagName(build_config_xml, GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER);
-      addMetadata(meta_list);
-      
-      meta_list = this.doc.createElement(GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
-      GSXML.addMetadata(this.doc, meta_list, "httpPath", this.site_http_address+"/collect/"+this.cluster_name);
-      addMetadata(meta_list);
-      
-      // display stuff
-      Element display_list = (Element)GSXML.getChildByTagName(coll_config_xml, GSXML.DISPLAY_TEXT_ELEM+GSXML.LIST_MODIFIER);
-      if (display_list != null) {
-        resolveMacros(display_list);
-        addDisplayItems(display_list);
-      }
-      
-      //check whether the html are tidy or not
-      Element import_list = (Element)GSXML.getChildByTagName(coll_config_xml, GSXML.IMPORT_ELEM);
-      if (import_list != null) {
-        Element plugin_list = (Element)GSXML.getChildByTagName(import_list, GSXML.PLUGIN_ELEM+GSXML.LIST_MODIFIER);
-        addPlugins(plugin_list);
-        if (plugin_list != null){
-          Element plugin_elem = (Element)GSXML.getNamedElement(plugin_list, GSXML.PLUGIN_ELEM, GSXML.NAME_ATT, "HTMLPlugin");
-          if (plugin_elem != null) {
-            //get the option
-            Element option_elem = (Element)GSXML.getNamedElement(plugin_elem, GSXML.PARAM_OPTION_ELEM, GSXML.NAME_ATT, "-use_realistic_book");
-            if (option_elem != null) {
-              useBook = true;
-            }
-          }
-        }
-      }
-      meta_list = this.doc.createElement(GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
-      if (useBook == true)
-        GSXML.addMetadata(this.doc, meta_list, "tidyoption", "tidy");
-      else
-        GSXML.addMetadata(this.doc, meta_list, "tidyoption", "untidy");
-      addMetadata(meta_list);
-      
-      // check whether we are public or not
-      if (meta_list != null) {
-        Element meta_elem = (Element) GSXML.getNamedElement(metadata_list, GSXML.METADATA_ELEM, GSXML.NAME_ATT, "public");
-        if (meta_elem != null) {
-          String value = GSXML.getValue(meta_elem).toLowerCase().trim();
-          if (value.equals("false")) {
-            is_public = false;
-          }
-        }
-      }
-      return true;
-
-    }
-
-  protected boolean configureServiceRacks(Element coll_config_xml, 
-                      Element build_config_xml){
-    clearServices();
-    Element service_list = (Element)GSXML.getChildByTagName(build_config_xml, GSXML.SERVICE_CLASS_ELEM+GSXML.LIST_MODIFIER);
-    configureServiceRackList(service_list, coll_config_xml);
-        
-    // collection Config may also contain manually added service racks
-    service_list = (Element)GSXML.getChildByTagName(coll_config_xml, GSXML.SERVICE_CLASS_ELEM+GSXML.LIST_MODIFIER);
-    if (service_list != null) {
-      configureServiceRackList(service_list, build_config_xml);
-      
-      // Check for oai
-      Element oai_service_rack = GSXML.getNamedElement(service_list, GSXML.SERVICE_CLASS_ELEM, OAIXML.NAME, OAIXML.OAIPMH);
-      if (oai_service_rack == null) {
-    has_oai = false;
-    logger.info("No oai for collection: " + this.cluster_name);
-    
-      } else {
-    has_oai = true;
-    
-    // extract earliestDatestamp from the buildconfig.xml for OAI
-    Element metadata_list = (Element)GSXML.getChildByTagName(build_config_xml, GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER);
-
-    if(metadata_list != null) {
-        NodeList children = metadata_list.getElementsByTagName(GSXML.METADATA_ELEM); 
-               // can't do getChildNodes(), because whitespace, such as newlines, creates Text nodes
-        for (int i = 0; i < children.getLength(); i++) {
-        Element metadata = (Element)children.item(i);
-        if(metadata.getAttribute(GSXML.NAME_ATT).equals(OAIXML.EARLIEST_DATESTAMP)) {
-            String earliestDatestampStr = GSXML.getValue(metadata);
-            if(!earliestDatestampStr.equals("")) {
-            earliestDatestamp = Long.parseLong(earliestDatestampStr);
-            }
-            break; // found a metadata element with name=earliestDatestamp in buildconfig
-        }
-        }
-    }
-    
-    // If at the end of this, there is no value for earliestDatestamp, print out a warning
-    logger.warn("No earliestDatestamp in buildConfig.xml for collection: " + this.cluster_name + ". Defaulting to 0.");
-
-      }
-    } else { // no list of services (no ServiceRackList), so no oai_service_rack either
-    // explicitly set has_oai to false here, since it's initialised to true by default
-    has_oai = false;
-    }
-    return true;
-  }
-  
-  protected boolean resolveMacros(Element display_list) {
-    if (display_list==null) return false;
-    NodeList displaynodes = display_list.getElementsByTagName(GSXML.DISPLAY_TEXT_ELEM);
-    if (displaynodes.getLength()>0) { 
-        String http_site = this.site_http_address;
-        String http_collection = this.site_http_address +"/collect/"+this.cluster_name;
-        for(int k=0; k<displaynodes.getLength(); k++) {
-        Element d = (Element) displaynodes.item(k);
-        String text = GSXML.getNodeText(d);
-        text = StringUtils.replace(text, "_httpsite_", http_site);
-        text = StringUtils.replace(text, "_httpcollection_", http_collection);
-        GSXML.setNodeText(d, text);
-        }
-    }
-    return true;
-    }
-    /** 
-     * do a configure on only part of the collection
-     */
-    protected boolean configureSubset(String subset) {
-
-    // need the coll config files
-    Element coll_config_elem = loadCollConfigFile();
-    Element build_config_elem = loadBuildConfigFile();
-    if (coll_config_elem == null||build_config_elem == null) {
-        // wont be able to do any of the requests
-        return false;
-    }    
-    
-    if (subset.equals(GSXML.SERVICE_ELEM+GSXML.LIST_MODIFIER)) {
-      return configureServiceRacks(coll_config_elem, build_config_elem);
-    } 
-
-    if (subset.equals(GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER) || subset.equals(GSXML.DISPLAY_TEXT_ELEM+GSXML.LIST_MODIFIER) || subset.equals(GSXML.PLUGIN_ELEM+GSXML.LIST_MODIFIER)) {
-        return findAndLoadInfo(coll_config_elem, build_config_elem);
-        
-    }
-    
-    logger.error("Collection: cant process system request, configure "+subset);
-    return false;
-    } 
-
- /** handles requests made to the ServiceCluster itself 
-     *
-     * @param req - the request Element- <request>
-     * @return the result Element - should be <response>
-     */
-    protected Element processMessage(Element request) {
-
-    Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
-    response.setAttribute(GSXML.FROM_ATT, this.cluster_name);
-    String type = request.getAttribute(GSXML.TYPE_ATT);
-    String lang = request.getAttribute(GSXML.LANG_ATT);
-    response.setAttribute(GSXML.TYPE_ATT, type);
-
-    logger.debug("Collection received a message, attempting to process");
-
-    if (type.equals(GSXML.REQUEST_TYPE_FORMAT_STRING)) {
-        logger.error("Received format string request");
-
-        String subaction = request.getAttribute("subaction");
-        logger.error("Subaction is " + subaction);
-
-        String service = request.getAttribute("service");
-        logger.error("Service is " + service);
-
-        String classifier = null;
-        if(service.equals("ClassifierBrowse"))
-        {
-            classifier = request.getAttribute("classifier");
-            logger.error("Classifier is " + classifier);
-        }
-
-        //logger.error("Format string: " + format_string);
-        logger.error("Config file location = " + GSFile.collectionConfigFile(this.site_home, this.cluster_name));
-
-        // check for version file
-
-        String directory = new File(GSFile.collectionConfigFile(this.site_home, this.cluster_name)).getParent() + File.separator;
-        logger.error("Directory is " + directory);
-
-        String version_filename = "";
-        if(service.equals("ClassifierBrowse"))
-            version_filename = directory + "browse_"+classifier+"_format_statement_version.txt";
-        else
-            version_filename = directory + "query_format_statement_version.txt";
-
-        File version_file = new File(version_filename);
-        logger.error("Version filename is " + version_filename);
-
-
-        if(subaction.equals("update"))
-        {
-            Element format_element = (Element) GSXML.getChildByTagName(request, GSXML.FORMAT_STRING_ELEM);
-            //String format_string = GSXML.getNodeText(format_element);
-            Element format_statement = (Element) format_element.getFirstChild();
-
-
-            String version_number = "1";
-            BufferedWriter writer;
-
-            try{
-
-                if(version_file.exists())
-                {
-                    // Read version
-                    BufferedReader reader = new BufferedReader(new FileReader(version_filename));
-                    version_number = reader.readLine();
-                    int aInt = Integer.parseInt(version_number) + 1;
-                    version_number = Integer.toString(aInt);
-                    reader.close();
-                }
-                else{
-                    // Create
-                    version_file.createNewFile();
-                    writer = new BufferedWriter(new FileWriter(version_filename));
-                    writer.write(version_number);
-                    writer.close();
-                }
-
-                // Write version file
-                String format_statement_filename = "";
-
-                if(service.equals("ClassifierBrowse"))
-                    format_statement_filename = directory + "browse_"+classifier+"_format_statement_v" + version_number + ".txt";
-                else
-                    format_statement_filename = directory + "query_format_statement_v" + version_number + ".txt";
-
-                logger.error("Format statement filename is " + format_statement_filename);
-
-                // Write format statement
-                String format_string = this.converter.getString(format_statement); //GSXML.xmlNodeToString(format_statement);
-                writer = new BufferedWriter(new FileWriter(format_statement_filename));
-                writer.write(format_string);
-                writer.close();
-
-                // Update version number
-                writer = new BufferedWriter(new FileWriter(version_filename));
-                writer.write(version_number);
-                writer.close();
-
-            } catch (IOException e) {
-                logger.error("IO Exception "+e);
-            }
-        }
-
-        if(subaction.equals("saveDocument"))
-        {
-            int k;
-            Element format_element = (Element) GSXML.getChildByTagName(request, GSXML.FORMAT_STRING_ELEM);
-            //String format_string = GSXML.getNodeText(format_element);
-            // Get display tag
-            Element display_format = (Element) format_element.getFirstChild();
-
-            logger.error("I have received a save document request");
-            String format_string = GSXML.xmlNodeToString(display_format);
-            logger.error("Param="+format_string);
-            String collection_config = directory + "collectionConfig.xml";
-            Document config = this.converter.getDOM(new File(collection_config), "UTF-8");
-
-            Node current_node = GSXML.getChildByTagName(config, "CollectionConfig");
-
-            // Get display child
-            if(GSXML.getChildByTagName(current_node, "display") == null)
-            {
-                logger.error("ERROR: does not have a display child");
-                // well then create a format tag
-                Element display_tag = config.createElement("display");
-                current_node = (Node) current_node.appendChild(display_tag);
-                //current_node = (Node) format_tag;
-            }
-
-            else{
-                current_node = GSXML.getChildByTagName(current_node, "display");
-            }
-
-            if(GSXML.getChildByTagName(current_node, "format") == null)
-            {
-                logger.error("ERROR: does not have a format child");
-                // well then create a format tag
-                Element format_tag = config.createElement("format");
-                current_node.appendChild(format_tag);
-                //current_node = (Node) format_tag;
-            }
-
-
-            current_node.replaceChild(config.importNode(display_format,true), GSXML.getChildByTagName(current_node, "format"));
-
-            logger.error(GSXML.xmlNodeToString(current_node));
-
-            logger.error("Convert config to string");
-            String new_config = this.converter.getString(config);
-
-            new_config = StringUtils.replace(new_config, "&lt;", "<");
-            new_config = StringUtils.replace(new_config, "&gt;", ">");
-            new_config = StringUtils.replace(new_config, "&quot;", "\"");
-
-            try{
-                // Write to file (not original! for now)
-                BufferedWriter writer = new BufferedWriter(new FileWriter(collection_config+".new"));
-                writer.write(new_config);
-                writer.close();
-                logger.error("All is happy with collection saveDocument");
-            } catch (IOException e) {
-                logger.error("IO Exception "+e);
-            }
-        }
-
-        if(subaction.equals("save"))
-        {
-            logger.error("SAVE format statement");
-
-            Element format_element = (Element) GSXML.getChildByTagName(request, GSXML.FORMAT_STRING_ELEM);
-            //String format_string = GSXML.getNodeText(format_element);
-            Element format_statement = (Element) format_element.getFirstChild();
-
-            try{
-
-                // open collectionConfig.xml and read in to w3 Document
-                String collection_config = directory + "collectionConfig.xml";
-                Document config = this.converter.getDOM(new File(collection_config), "UTF-8");
-           
-                //String tag_name = "";
-                int k;
-                int index;
-                Element elem;
-                // Try importing entire tree to this.doc so we can add and remove children at ease
-                //Node current_node = this.doc.importNode(GSXML.getChildByTagName(config, "CollectionConfig"),true);
-                Node current_node = GSXML.getChildByTagName(config, "CollectionConfig");
-                NodeList current_node_list;
-   
-                logger.error("Service is "+service);
-
-                if(service.equals("ClassifierBrowse"))
-                {
-                    //tag_name = "browse";
-                    // if CLX then need to look in <classifier> X then <format>
-                    // default is <browse><format>
-
-                    logger.error("Looking for browse");
-                    current_node = GSXML.getChildByTagName(current_node, "browse");
-
-                    // find CLX
-                    if(classifier != null)
-                    {
-                        logger.error("Classifier is not null");
-                        logger.error("Classifier is "+classifier);
-                        current_node_list = GSXML.getChildrenByTagName(current_node, "classifier");
-                        index = Integer.parseInt(classifier.substring(2)) - 1;
-                        logger.error("classifier index is "+index);
-                        // index should be given by X-1
-                        current_node = current_node_list.item(index);
-                        // what if classifier does not have a format tag?
-                        if(GSXML.getChildByTagName(current_node, "format") == null)
-                        {
-                            logger.error("ERROR: valid classifier but does not have a format child");
-                            // well then create a format tag
-                            Element format_tag = config.createElement("format");
-                            current_node.appendChild(format_tag);
-                            //current_node = (Node) format_tag;
-                        }
-                    }
-                    else{
-                        logger.error("Classifier is null");
-                        // To support all classifiers, set classifier to null?  There is the chance here that the format tag does not exist
-                        if(GSXML.getChildByTagName(current_node, "format") == null)
-                        {
-                            logger.error("ERROR: classifier does not have a format child");
-                            // well then create a format tag
-                            Element format_tag = config.createElement("format");
-                            current_node.appendChild(format_tag);
-                            //current_node = (Node) format_tag;
-                        }
-                    }
-                }
-                else if(service.equals("AllClassifierBrowse"))
-                {
-                    logger.error("Looking for browse");
-                    current_node = GSXML.getChildByTagName(current_node, "browse");
-                    if(GSXML.getChildByTagName(current_node, "format") == null)
-                    {
-                        logger.error("ERROR AllClassifierBrowse: all classifiers do not have a format child");
-                        // well then create a format tag
-                        Element format_tag = config.createElement("format");
-                        current_node.appendChild(format_tag);
-                        //current_node = (Node) format_tag;
-                    }
-                }
-                else
-                {
-                    // look in <format> with no attributes
-                    logger.error("I presume this is search");
-            
-                    current_node_list = GSXML.getChildrenByTagName(current_node, "search");
-                    for(k=0; k<current_node_list.getLength(); k++) 
-                    {
-                        current_node = current_node_list.item(k);
-                        // if current_node has no attributes then break
-                        elem = (Element) current_node;
-                        if(elem.hasAttribute("name")==false)
-                            break;
-                    }
-                }
-
-                current_node.replaceChild(config.importNode(format_statement,true), GSXML.getChildByTagName(current_node, "format"));
-
-                // Now convert config document to string for writing to file
-                logger.error("Convert config to string");
-                String new_config = this.converter.getString(config);
-
-                new_config = StringUtils.replace(new_config, "&lt;", "<");
-                new_config = StringUtils.replace(new_config, "&gt;", ">");
-                new_config = StringUtils.replace(new_config, "&quot;", "\"");
-    
-                // Write to file (not original! for now)
-                BufferedWriter writer = new BufferedWriter(new FileWriter(collection_config+".new"));
-                writer.write(new_config);
-                writer.close();
-                logger.error("All is happy with collection");
-
-             } catch( Exception ex ) {
-                logger.error("There was an exception "+ex);
-
-                StringWriter sw = new StringWriter();
-                PrintWriter pw = new PrintWriter(sw, true);
-                ex.printStackTrace(pw);
-                pw.flush();
-                sw.flush();
-                logger.error(sw.toString());
-            }
-
-        }
-    }
-    else { // unknown type
-        return super.processMessage(request);
-
-    }
-    return response;
-    }
+public class Collection extends ServiceCluster
+{
+
+    static Logger logger = Logger.getLogger(org.greenstone.gsdl3.collection.Collection.class.getName());
+
+    /** is this collection being tidied */
+    protected boolean useBook = false;
+    /** is this collection public or private */
+    protected boolean is_public = true;
+
+    /** does this collection provide the OAI service */
+    protected boolean has_oai = true;
+    /** time when this collection was built */
+    protected long lastmodified = 0;
+    /** earliestDatestamp of this collection. Necessary for OAI */
+    protected long earliestDatestamp = 0;
+
+    /**
+     * An element containing the serviceRackList element of buildConfig.xml,
+     * used to determine whether it contains the OAIPMH serviceRack
+     */
+    //protected Element service_rack_list = null;
+
+    protected XMLTransformer transformer = null;
+
+    /** same as setClusterName */
+    public void setCollectionName(String name)
+    {
+        setClusterName(name);
+    }
+
+    public Collection()
+    {
+        super();
+        this.description = this.doc.createElement(GSXML.COLLECTION_ELEM);
+
+    }
+
+    /**
+     * Configures the collection.
+     * 
+     * gsdlHome and collectionName must be set before configure is called.
+     * 
+     * the file buildcfg.xml is located in gsdlHome/collect/collectionName
+     * collection metadata is obtained, and services loaded.
+     * 
+     * @return true/false on success/fail
+     */
+    public boolean configure()
+    {
+
+        if (this.site_home == null || this.cluster_name == null)
+        {
+            logger.error("Collection: site_home and collection_name must be set before configure called!");
+            return false;
+        }
+
+        Element coll_config_xml = loadCollConfigFile();
+        Element build_config_xml = loadBuildConfigFile();
+
+        if (coll_config_xml == null || build_config_xml == null)
+        {
+            return false;
+        }
+
+        // get the collection type attribute
+        Element search = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.SEARCH_ELEM);
+        if (search != null)
+        {
+            col_type = search.getAttribute(GSXML.TYPE_ATT);
+        }
+        
+        Element browse = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.INFODB_ELEM);
+        if (browse != null)
+        {
+            db_type = browse.getAttribute(GSXML.TYPE_ATT);
+        }
+        else
+        {
+            db_type = "gdbm"; //Default database type
+        }
+
+        // process the metadata and display items
+        findAndLoadInfo(coll_config_xml, build_config_xml);
+
+        // now do the services
+        configureServiceRacks(coll_config_xml, build_config_xml);
+
+        return true;
+
+    }
+
+    public boolean useBook()
+    {
+        return useBook;
+    }
+
+    public boolean isPublic()
+    {
+        return is_public;
+    }
+
+    // Not used anymore by the OAIReceptionist to find out the earliest datestamp 
+    // amongst all oai collections in the repository. May be useful generally.
+    public long getLastmodified()
+    {
+        return lastmodified;
+    }
+
+    //used by the OAIReceptionist to find out the earliest datestamp amongst all oai collections in the repository
+    public long getEarliestDatestamp()
+    {
+        return earliestDatestamp;
+    }
+
+    /**
+     * whether the service_map in ServiceCluster.java contains the service
+     * 'OAIPMH' 11/06/2007 xiao
+     */
+    public boolean hasOAI()
+    {
+        return has_oai;
+    }
+
+    /**
+     * load in the collection config file into a DOM Element
+     */
+    protected Element loadCollConfigFile()
+    {
+
+        File coll_config_file = new File(GSFile.collectionConfigFile(this.site_home, this.cluster_name));
+
+        if (!coll_config_file.exists())
+        {
+            logger.error("Collection: couldn't configure collection: " + this.cluster_name + ", " + coll_config_file + " does not exist");
+            return null;
+        }
+        // get the xml for both files
+        Document coll_config_doc = this.converter.getDOM(coll_config_file, CONFIG_ENCODING);
+        Element coll_config_elem = null;
+        if (coll_config_doc != null)
+        {
+            coll_config_elem = coll_config_doc.getDocumentElement();
+        }
+        return coll_config_elem;
+
+    }
+
+    /**
+     * load in the collection build config file into a DOM Element
+     */
+    protected Element loadBuildConfigFile()
+    {
+
+        File build_config_file = new File(GSFile.collectionBuildConfigFile(this.site_home, this.cluster_name));
+        if (!build_config_file.exists())
+        {
+            logger.error("Collection: couldn't configure collection: " + this.cluster_name + ", " + build_config_file + " does not exist");
+            return null;
+        }
+        Document build_config_doc = this.converter.getDOM(build_config_file, CONFIG_ENCODING);
+        Element build_config_elem = null;
+        if (build_config_doc != null)
+        {
+            build_config_elem = build_config_doc.getDocumentElement();
+        }
+
+        lastmodified = build_config_file.lastModified();
+
+        return build_config_elem;
+    }
+
+    /**
+     * find the metadata and display elems from the two config files and add it
+     * to the appropriate lists
+     */
+    protected boolean findAndLoadInfo(Element coll_config_xml, Element build_config_xml)
+    {
+
+        // metadata
+        Element meta_list = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
+        addMetadata(meta_list);
+        meta_list = (Element) GSXML.getChildByTagName(build_config_xml, GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
+        addMetadata(meta_list);
+
+        meta_list = this.doc.createElement(GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
+        GSXML.addMetadata(this.doc, meta_list, "httpPath", this.site_http_address + "/collect/" + this.cluster_name);
+        addMetadata(meta_list);
+
+        // display stuff
+        Element display_list = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.DISPLAY_TEXT_ELEM + GSXML.LIST_MODIFIER);
+        if (display_list != null)
+        {
+            resolveMacros(display_list);
+            addDisplayItems(display_list);
+        }
+
+        //check whether the html are tidy or not
+        Element import_list = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.IMPORT_ELEM);
+        if (import_list != null)
+        {
+            Element plugin_list = (Element) GSXML.getChildByTagName(import_list, GSXML.PLUGIN_ELEM + GSXML.LIST_MODIFIER);
+            addPlugins(plugin_list);
+            if (plugin_list != null)
+            {
+                Element plugin_elem = (Element) GSXML.getNamedElement(plugin_list, GSXML.PLUGIN_ELEM, GSXML.NAME_ATT, "HTMLPlugin");
+                if (plugin_elem != null)
+                {
+                    //get the option
+                    Element option_elem = (Element) GSXML.getNamedElement(plugin_elem, GSXML.PARAM_OPTION_ELEM, GSXML.NAME_ATT, "-use_realistic_book");
+                    if (option_elem != null)
+                    {
+                        useBook = true;
+                    }
+                }
+            }
+        }
+        meta_list = this.doc.createElement(GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
+        if (useBook == true)
+            GSXML.addMetadata(this.doc, meta_list, "tidyoption", "tidy");
+        else
+            GSXML.addMetadata(this.doc, meta_list, "tidyoption", "untidy");
+        addMetadata(meta_list);
+
+        // check whether we are public or not
+        if (meta_list != null)
+        {
+            Element meta_elem = (Element) GSXML.getNamedElement(metadata_list, GSXML.METADATA_ELEM, GSXML.NAME_ATT, "public");
+            if (meta_elem != null)
+            {
+                String value = GSXML.getValue(meta_elem).toLowerCase().trim();
+                if (value.equals("false"))
+                {
+                    is_public = false;
+                }
+            }
+        }
+        return true;
+
+    }
+
+    protected boolean configureServiceRacks(Element coll_config_xml, Element build_config_xml)
+    {
+        clearServices();
+        Element service_list = (Element) GSXML.getChildByTagName(build_config_xml, GSXML.SERVICE_CLASS_ELEM + GSXML.LIST_MODIFIER);
+        configureServiceRackList(service_list, coll_config_xml);
+
+        // collection Config may also contain manually added service racks
+        service_list = (Element) GSXML.getChildByTagName(coll_config_xml, GSXML.SERVICE_CLASS_ELEM + GSXML.LIST_MODIFIER);
+        if (service_list != null)
+        {
+            configureServiceRackList(service_list, build_config_xml);
+
+            // Check for oai
+            Element oai_service_rack = GSXML.getNamedElement(service_list, GSXML.SERVICE_CLASS_ELEM, OAIXML.NAME, OAIXML.OAIPMH);
+            if (oai_service_rack == null)
+            {
+                has_oai = false;
+                logger.info("No oai for collection: " + this.cluster_name);
+
+            }
+            else
+            {
+                has_oai = true;
+
+                // extract earliestDatestamp from the buildconfig.xml for OAI
+                Element metadata_list = (Element) GSXML.getChildByTagName(build_config_xml, GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
+
+                if (metadata_list != null)
+                {
+                    NodeList children = metadata_list.getElementsByTagName(GSXML.METADATA_ELEM);
+                    // can't do getChildNodes(), because whitespace, such as newlines, creates Text nodes
+                    for (int i = 0; i < children.getLength(); i++)
+                    {
+                        Element metadata = (Element) children.item(i);
+                        if (metadata.getAttribute(GSXML.NAME_ATT).equals(OAIXML.EARLIEST_DATESTAMP))
+                        {
+                            String earliestDatestampStr = GSXML.getValue(metadata);
+                            if (!earliestDatestampStr.equals(""))
+                            {
+                                earliestDatestamp = Long.parseLong(earliestDatestampStr);
+                            }
+                            break; // found a metadata element with name=earliestDatestamp in buildconfig
+                        }
+                    }
+                }
+
+                // If at the end of this, there is no value for earliestDatestamp, print out a warning
+                logger.warn("No earliestDatestamp in buildConfig.xml for collection: " + this.cluster_name + ". Defaulting to 0.");
+
+            }
+        }
+        else
+        { // no list of services (no ServiceRackList), so no oai_service_rack either
+            // explicitly set has_oai to false here, since it's initialised to true by default
+            has_oai = false;
+        }
+        return true;
+    }
+
+    protected boolean resolveMacros(Element display_list)
+    {
+        if (display_list == null)
+            return false;
+        NodeList displaynodes = display_list.getElementsByTagName(GSXML.DISPLAY_TEXT_ELEM);
+        if (displaynodes.getLength() > 0)
+        {
+            String http_site = this.site_http_address;
+            String http_collection = this.site_http_address + "/collect/" + this.cluster_name;
+            for (int k = 0; k < displaynodes.getLength(); k++)
+            {
+                Element d = (Element) displaynodes.item(k);
+                String text = GSXML.getNodeText(d);
+                text = StringUtils.replace(text, "_httpsite_", http_site);
+                text = StringUtils.replace(text, "_httpcollection_", http_collection);
+                GSXML.setNodeText(d, text);
+            }
+        }
+        return true;
+    }
+
+    /**
+     * do a configure on only part of the collection
+     */
+    protected boolean configureSubset(String subset)
+    {
+
+        // need the coll config files
+        Element coll_config_elem = loadCollConfigFile();
+        Element build_config_elem = loadBuildConfigFile();
+        if (coll_config_elem == null || build_config_elem == null)
+        {
+            // wont be able to do any of the requests
+            return false;
+        }
+
+        if (subset.equals(GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER))
+        {
+            return configureServiceRacks(coll_config_elem, build_config_elem);
+        }
+
+        if (subset.equals(GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER) || subset.equals(GSXML.DISPLAY_TEXT_ELEM + GSXML.LIST_MODIFIER) || subset.equals(GSXML.PLUGIN_ELEM + GSXML.LIST_MODIFIER))
+        {
+            return findAndLoadInfo(coll_config_elem, build_config_elem);
+
+        }
+
+        logger.error("Collection: cant process system request, configure " + subset);
+        return false;
+    }
+
+    /**
+     * handles requests made to the ServiceCluster itself
+     * 
+     * @param req
+     *            - the request Element- <request>
+     * @return the result Element - should be <response>
+     */
+    protected Element processMessage(Element request)
+    {
+
+        Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
+        response.setAttribute(GSXML.FROM_ATT, this.cluster_name);
+        String type = request.getAttribute(GSXML.TYPE_ATT);
+        String lang = request.getAttribute(GSXML.LANG_ATT);
+        response.setAttribute(GSXML.TYPE_ATT, type);
+
+        logger.error("Collection received a message, attempting to process");
+
+        if (type.equals(GSXML.REQUEST_TYPE_FORMAT_STRING))
+        {
+            logger.error("Received format string request");
+
+            String subaction = request.getAttribute("subaction");
+            logger.error("Subaction is " + subaction);
+
+            String service = request.getAttribute("service");
+            logger.error("Service is " + service);
+
+            String classifier = null;
+            if (service.equals("ClassifierBrowse"))
+            {
+                classifier = request.getAttribute("classifier");
+                logger.error("Classifier is " + classifier);
+            }
+
+            //logger.error("Format string: " + format_string);
+            logger.error("Config file location = " + GSFile.collectionConfigFile(this.site_home, this.cluster_name));
+
+            // check for version file
+
+            String directory = new File(GSFile.collectionConfigFile(this.site_home, this.cluster_name)).getParent() + File.separator;
+            logger.error("Directory is " + directory);
+
+            String version_filename = "";
+            if (service.equals("ClassifierBrowse"))
+                version_filename = directory + "browse_" + classifier + "_format_statement_version.txt";
+            else
+                version_filename = directory + "query_format_statement_version.txt";
+
+            File version_file = new File(version_filename);
+            logger.error("Version filename is " + version_filename);
+
+            if (subaction.equals("update"))
+            {
+                Element format_element = (Element) GSXML.getChildByTagName(request, GSXML.FORMAT_STRING_ELEM);
+                //String format_string = GSXML.getNodeText(format_element);
+                Element format_statement = (Element) format_element.getFirstChild();
+
+                String version_number = "1";
+                BufferedWriter writer;
+
+                try
+                {
+
+                    if (version_file.exists())
+                    {
+                        // Read version
+                        BufferedReader reader = new BufferedReader(new FileReader(version_filename));
+                        version_number = reader.readLine();
+                        int aInt = Integer.parseInt(version_number) + 1;
+                        version_number = Integer.toString(aInt);
+                        reader.close();
+                    }
+                    else
+                    {
+                        // Create
+                        version_file.createNewFile();
+                        writer = new BufferedWriter(new FileWriter(version_filename));
+                        writer.write(version_number);
+                        writer.close();
+                    }
+
+                    // Write version file
+                    String format_statement_filename = "";
+
+                    if (service.equals("ClassifierBrowse"))
+                        format_statement_filename = directory + "browse_" + classifier + "_format_statement_v" + version_number + ".txt";
+                    else
+                        format_statement_filename = directory + "query_format_statement_v" + version_number + ".txt";
+
+                    logger.error("Format statement filename is " + format_statement_filename);
+
+                    // Write format statement
+                    String format_string = this.converter.getString(format_statement); //GSXML.xmlNodeToString(format_statement);
+                    writer = new BufferedWriter(new FileWriter(format_statement_filename));
+                    writer.write(format_string);
+                    writer.close();
+
+                    // Update version number
+                    writer = new BufferedWriter(new FileWriter(version_filename));
+                    writer.write(version_number);
+                    writer.close();
+
+                }
+                catch (IOException e)
+                {
+                    logger.error("IO Exception " + e);
+                }
+            }
+
+            if (subaction.equals("saveDocument"))
+            {
+                int k;
+                Element format_element = (Element) GSXML.getChildByTagName(request, GSXML.FORMAT_STRING_ELEM);
+                //String format_string = GSXML.getNodeText(format_element);
+                // Get display tag
+                Element display_format = (Element) format_element.getFirstChild();
+
+                logger.error("I have received a save document request");
+                String format_string = GSXML.xmlNodeToString(display_format);
+                logger.error("Param=" + format_string);
+                String collection_config = directory + "collectionConfig.xml";
+                Document config = this.converter.getDOM(new File(collection_config), "UTF-8");
+
+                Node current_node = GSXML.getChildByTagName(config, "CollectionConfig");
+
+                // Get display child
+                if (GSXML.getChildByTagName(current_node, "display") == null)
+                {
+                    logger.error("ERROR: does not have a display child");
+                    // well then create a format tag
+                    Element display_tag = config.createElement("display");
+                    current_node = (Node) current_node.appendChild(display_tag);
+                    //current_node = (Node) format_tag;
+                }
+
+                else
+                {
+                    current_node = GSXML.getChildByTagName(current_node, "display");
+                }
+
+                if (GSXML.getChildByTagName(current_node, "format") == null)
+                {
+                    logger.error("ERROR: does not have a format child");
+                    // well then create a format tag
+                    Element format_tag = config.createElement("format");
+                    current_node.appendChild(format_tag);
+                    //current_node = (Node) format_tag;
+                }
+
+                current_node.replaceChild(config.importNode(display_format, true), GSXML.getChildByTagName(current_node, "format"));
+
+                logger.error(GSXML.xmlNodeToString(current_node));
+
+                logger.error("Convert config to string");
+                String new_config = this.converter.getString(config);
+
+                new_config = StringUtils.replace(new_config, "&lt;", "<");
+                new_config = StringUtils.replace(new_config, "&gt;", ">");
+                new_config = StringUtils.replace(new_config, "&quot;", "\"");
+
+                try
+                {
+                    // Write to file (not original! for now)
+                    BufferedWriter writer = new BufferedWriter(new FileWriter(collection_config + ".new"));
+                    writer.write(new_config);
+                    writer.close();
+                    logger.error("All is happy with collection saveDocument");
+                }
+                catch (IOException e)
+                {
+                    logger.error("IO Exception " + e);
+                }
+            }
+
+            if (subaction.equals("save"))
+            {
+                logger.error("SAVE format statement");
+
+                Element format_element = (Element) GSXML.getChildByTagName(request, GSXML.FORMAT_STRING_ELEM);
+                //String format_string = GSXML.getNodeText(format_element);
+                Element format_statement = (Element) format_element.getFirstChild();
+
+                try
+                {
+
+                    // open collectionConfig.xml and read in to w3 Document
+                    String collection_config = directory + "collectionConfig.xml";
+                    Document config = this.converter.getDOM(new File(collection_config), "UTF-8");
+
+                    //String tag_name = "";
+                    int k;
+                    int index;
+                    Element elem;
+                    // Try importing entire tree to this.doc so we can add and remove children at ease
+                    //Node current_node = this.doc.importNode(GSXML.getChildByTagName(config, "CollectionConfig"),true);
+                    Node current_node = GSXML.getChildByTagName(config, "CollectionConfig");
+                    NodeList current_node_list;
+
+                    logger.error("Service is " + service);
+
+                    if (service.equals("ClassifierBrowse"))
+                    {
+                        //tag_name = "browse";
+                        // if CLX then need to look in <classifier> X then <format>
+                        // default is <browse><format>
+
+                        logger.error("Looking for browse");
+                        current_node = GSXML.getChildByTagName(current_node, "browse");
+
+                        // find CLX
+                        if (classifier != null)
+                        {
+                            logger.error("Classifier is not null");
+                            logger.error("Classifier is " + classifier);
+                            current_node_list = GSXML.getChildrenByTagName(current_node, "classifier");
+                            index = Integer.parseInt(classifier.substring(2)) - 1;
+                            logger.error("classifier index is " + index);
+                            // index should be given by X-1
+                            current_node = current_node_list.item(index);
+                            // what if classifier does not have a format tag?
+                            if (GSXML.getChildByTagName(current_node, "format") == null)
+                            {
+                                logger.error("ERROR: valid classifier but does not have a format child");
+                                // well then create a format tag
+                                Element format_tag = config.createElement("format");
+                                current_node.appendChild(format_tag);
+                                //current_node = (Node) format_tag;
+                            }
+                        }
+                        else
+                        {
+                            logger.error("Classifier is null");
+                            // To support all classifiers, set classifier to null?  There is the chance here that the format tag does not exist
+                            if (GSXML.getChildByTagName(current_node, "format") == null)
+                            {
+                                logger.error("ERROR: classifier does not have a format child");
+                                // well then create a format tag
+                                Element format_tag = config.createElement("format");
+                                current_node.appendChild(format_tag);
+                                //current_node = (Node) format_tag;
+                            }
+                        }
+                    }
+                    else if (service.equals("AllClassifierBrowse"))
+                    {
+                        logger.error("Looking for browse");
+                        current_node = GSXML.getChildByTagName(current_node, "browse");
+                        if (GSXML.getChildByTagName(current_node, "format") == null)
+                        {
+                            logger.error("ERROR AllClassifierBrowse: all classifiers do not have a format child");
+                            // well then create a format tag
+                            Element format_tag = config.createElement("format");
+                            current_node.appendChild(format_tag);
+                            //current_node = (Node) format_tag;
+                        }
+                    }
+                    else
+                    {
+                        // look in <format> with no attributes
+                        logger.error("I presume this is search");
+
+                        current_node_list = GSXML.getChildrenByTagName(current_node, "search");
+                        for (k = 0; k < current_node_list.getLength(); k++)
+                        {
+                            current_node = current_node_list.item(k);
+                            // if current_node has no attributes then break
+                            elem = (Element) current_node;
+                            if (elem.hasAttribute("name") == false)
+                                break;
+                        }
+                    }
+
+                    current_node.replaceChild(config.importNode(format_statement, true), GSXML.getChildByTagName(current_node, "format"));
+
+                    // Now convert config document to string for writing to file
+                    logger.error("Convert config to string");
+                    String new_config = this.converter.getString(config);
+
+                    new_config = StringUtils.replace(new_config, "&lt;", "<");
+                    new_config = StringUtils.replace(new_config, "&gt;", ">");
+                    new_config = StringUtils.replace(new_config, "&quot;", "\"");
+
+                    // Write to file (not original! for now)
+                    BufferedWriter writer = new BufferedWriter(new FileWriter(collection_config + ".new"));
+                    writer.write(new_config);
+                    writer.close();
+                    logger.error("All is happy with collection");
+
+                }
+                catch (Exception ex)
+                {
+                    logger.error("There was an exception " + ex);
+
+                    StringWriter sw = new StringWriter();
+                    PrintWriter pw = new PrintWriter(sw, true);
+                    ex.printStackTrace(pw);
+                    pw.flush();
+                    sw.flush();
+                    logger.error(sw.toString());
+                }
+
+            }
+        }
+        else
+        { // unknown type
+            return super.processMessage(request);
+
+        }
+        return response;
+    }
 
 }
-
-
-
-

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/AbstractBrowse.java

@@ -574 +574 @@
      * <docNode nodeId='xxx' nodeType='leaf' docType='hierarchy'/>
      */
-    protected Element createDocNode(String node_id, int offset) {
+    protected Element createDocNode(String node_id) {
     Element node = this.doc.createElement(GSXML.DOC_NODE_ELEM);
     node.setAttribute(GSXML.NODE_ID_ATT, node_id);
@@ -587 +587 @@
     String node_type = getNodeType(node_id, doc_type);  
     node.setAttribute(GSXML.NODE_TYPE_ATT, node_type);
-    
-    // mdoffset information stored in DB determines which of multiple values for
-    // a metadata needs to be displayed when a classifier is built on that metadata
-    node.setAttribute(GSXML.NODE_MDOFFSET_ATT, Integer.toString(offset));
     return node;
     }
@@ -625 +621 @@
     ArrayList child_ids = getChildrenIds(node_id);
     if (child_ids==null) return;
-    
-    // get a list of all mdoffsets at this point
-    ArrayList child_offsets = getOffsetsForChildrenIds(node_id);
-    // make sure that if it's doesn't match up with child_ids in length, 
-    // it is padded with 0s to make up the length
-    if(child_offsets == null) {
-        child_offsets = new ArrayList(child_ids.size());
-    } 
-    if(child_offsets.size() < child_ids.size()) {
-        Integer zero = new Integer(0);
-        for(int i = child_offsets.size()-1; i < child_ids.size(); i++) {
-        child_offsets.add(zero);
-        }
-    }
-
     for (int i=0; i< child_ids.size(); i++) {
         String child_id = (String)child_ids.get(i);
-        int child_offset = ((Integer)child_offsets.get(i)).intValue(); // counts both docnodes and classnodes at the childlevel, is this right?
         Element child_elem;
         if (isDocumentId(child_id)) {
-        child_elem = createDocNode(child_id, child_offset);
+        child_elem = createDocNode(child_id);
         } else {
         child_elem = createClassifierNode(child_id);
@@ -704 +684 @@
     }
 
-    /** Override to get a list of mdoffsets of children. Return null if no children or if no mdoffsets for them */
-    protected ArrayList getOffsetsForChildrenIds(String node_id) { 
-    return null; 
-    }
-
     /** if id ends in .fc, .pc etc, then translate it to the correct id */
     abstract protected String translateId(String node_id);

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/AbstractDocumentRetrieve.java

@@ -241 +241 @@
         Element request_node = (Element) request_nodes.item(i);
         String node_id = request_node.getAttribute(GSXML.NODE_ID_ATT);
-
-        // make a custom copy of metadata_names_list for each docID, since mdoffset value varies for each doc
-        ArrayList customised_metadata_names_list = new ArrayList(metadata_names_list.size());
-        int mdoffset = 0;
-        if(request_node.hasAttribute(GSXML.NODE_MDOFFSET_ATT)) {
-        String offset = request_node.getAttribute(GSXML.NODE_MDOFFSET_ATT);
-        mdoffset = Integer.parseInt(offset);
-        }   
-        for(int x = 0; x < metadata_names_list.size(); x++) {
-        String metaname = (String)metadata_names_list.get(x);
-        if(metaname.indexOf("offset" + GSConstants.META_RELATION_SEP) != -1) {
-            // append offset number to the metaname
-            metaname = metaname.replace("offset"+GSConstants.META_RELATION_SEP, "offset"+mdoffset+GSConstants.META_RELATION_SEP);
-        } 
-        customised_metadata_names_list.add(x, metaname);            
-        }
-        
        
         boolean is_external_link = false;
@@ -289 +272 @@
         if (!is_external_link){
         try {
-            Element metadata_list = getMetadataList(node_id, all_metadata, customised_metadata_names_list);
+            Element metadata_list = getMetadataList(node_id, all_metadata, metadata_names_list);
             request_node.appendChild(metadata_list);
         } catch (GSException e) {       

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/AbstractGS2DocumentRetrieve.java

@@ -41 +41 @@
 import java.util.Iterator;
 import java.util.ArrayList;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
 import org.apache.log4j.*;
@@ -198 +196 @@
         
     } else {
-        // prepare regex to work with mdoffset: looking for <offset\d*_>
-        Pattern pattern = Pattern.compile("offset[0-9]*" + GSConstants.META_RELATION_SEP);
-
         for (int i=0; i<metadata_names.size(); i++) {
                 String meta_name = (String) metadata_names.get(i);
         String value = getMetadata(node_id, info, meta_name, lang);
-
-        // Remove the occurrence (if any) in this metaname of the mdoffset number in the pattern <offset\d*_>
-        // Leaving string "offset" in at this point: it will be handled in config_format.xsl's gsf:metadata template match
-        Matcher matcher = pattern.matcher(meta_name);
-        meta_name = matcher.replaceFirst("offset" + GSConstants.META_RELATION_SEP); 
-            //replaceFirst(""); // if removing the occurrence (if any) of entire pattern <offset\d*_> in input      
-
         GSXML.addMetadata(this.doc, metadata_list, meta_name, value);
         }
@@ -329 +317 @@
     protected String getMetadata(String node_id, DBInfo info, 
                  String metadata, String lang) {
-    String multiple = "false"; // multiple can now be "true", "false" or "offset<number>". It's no longer a boolean
+    boolean multiple = false;
     String relation = "";
     String separator = ", ";
@@ -358 +346 @@
     metadata = metadata.substring(pos+1);
     // check for all on the front
-    if (temp.equals("all") || temp.startsWith("offset")) { // multiple can now be "true", "false" or "offset"
-        multiple = temp; // multiple=true;
+    if (temp.equals("all")) {
+        multiple=true;      
         pos = metadata.indexOf(GSConstants.META_RELATION_SEP);
         if (pos ==-1) {
@@ -411 +399 @@
     StringBuffer result = new StringBuffer();
 
-    if (multiple.equals("false")) {
+    if (!multiple) {
         result.append(this.macro_resolver.resolve(relation_info.getInfo(metadata), lang, MacroResolver.SCOPE_META, relation_id));
-    } else if(multiple.startsWith("offset")) { // multiple = offset
-        String offset = multiple.substring("offset".length(), multiple.length());
-        int offsetVal = offset.equals("") ? 0 : Integer.parseInt(offset);
-        String value = relation_info.getInfoOffset(metadata, offsetVal); // what if this metadata is not the one we need to get the offset for? MDTYPE!
-           // at the moment, do we assume the user will specify retrieving the offset only for such metadata as has an offset? 
-           // At least, getInfoOffset will return the firstelement if the offset exceeds the bounds of the values for this metadata key
-
-        result.append(this.macro_resolver.resolve(value, lang, MacroResolver.SCOPE_META, relation_id));
-        
-    } else { // multiple = true, we have multiple meta      
+    } else {
+        // we have multiple meta
         Vector values = relation_info.getMultiInfo(metadata);
-        if (values != null) {
+        if (values != null) {
         boolean first = true;
         for (int i=0; i<values.size(); i++) {
@@ -435 +415 @@
         }
         }
-        logger.info(result);
+          logger.info(result); 
     }
     // if not ancestors, then this is all we do
@@ -448 +428 @@
         relation_info = this.coll_db.getInfo(relation_id);
         if (relation_info == null) return result.toString();
-        if (multiple.equals("false")) { //if (!multiple)
+        if (!multiple) {
         result.insert(0, separator);
         result.insert(0, this.macro_resolver.resolve(relation_info.getInfo(metadata), lang, MacroResolver.SCOPE_META, relation_id));

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/GS2Browse.java

@@ -175 +175 @@
 
     }
-    /** returns a list of the mdoffset values in order for the children, null is 
-      * returned if there are no children or if the mdoffset field is empty */
-    protected ArrayList getOffsetsForChildrenIds(String node_id) { 
-    DBInfo info = this.coll_db.getInfo(node_id);
-    if (info == null) {
-        return null;
-    }
-    
-    ArrayList childrenOffsets = new ArrayList();
-    
-    String offset = info.getInfo("mdoffset").trim();
-    if(offset.equals("")) {
-        return null;
-    }
-    StringTokenizer st = new StringTokenizer(offset, ";");
-    while (st.hasMoreTokens()) {
-        String val = st.nextToken().trim();
-        childrenOffsets.add(Integer.valueOf(val));
-    }
-    return childrenOffsets;
-    }
-
     /** returns the node id of the parent node, null if no parent */
     protected String getParentId(String node_id){

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/ServiceRack.java

@@ -24 +24 @@
 
 // xml classes
-import org.w3c.dom.Node; 
-import org.w3c.dom.NodeList; 
-import org.w3c.dom.Element; 
-import org.w3c.dom.Document; 
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+import org.w3c.dom.Element;
+import org.w3c.dom.Document;
 import org.xml.sax.InputSource;
 import javax.xml.parsers.*;
@@ -45 +45 @@
 /**
  * ServiceRack - abstract base class for services
- *
- * A ServiceRack provides one or more Services. 
- * This base class implements the process method.
- *Each service is invoked
- * by a method called process<service name> which takes one parameter - the xml request Element, and returns an XML response Element. 
- * for example, the TextQuery service would be invoked by 
+ * 
+ * A ServiceRack provides one or more Services. This base class implements the
+ * process method. Each service is invoked by a method called process<service
+ * name> which takes one parameter - the xml request Element, and returns an XML
+ * response Element. for example, the TextQuery service would be invoked by
  * processTextQuery(Element request)
- *
+ * 
  * @author Katherine Don
  */
-public abstract class ServiceRack
-    implements ModuleInterface
+public abstract class ServiceRack implements ModuleInterface
 {
 
-     static Logger logger = Logger.getLogger(org.greenstone.gsdl3.service.ServiceRack.class.getName());
-
-    /** the absolute address of the site home */
-    protected String site_home =null;
-    /** the http address of the site home */
-    protected String site_http_address =null;
-
-    protected String library_name = null;
-    /** the name of the cluster (or collection) that this service 
-    belongs to - if any */ 
-    protected String cluster_name = null;
-
-    /** some services can talk back to the message router */
-    protected MessageRouter router = null;
-
-    /** a converter class to create Documents etc */
-    protected XMLConverter converter = null;
-
-    /** the original config info - if need to store it */
-    protected Element config_info = null;
-
-    /** XML element for describe requests - the container doc */
-    protected Document doc = null;
-
-    /** XML element for describe requests - list of supported services
-    - this is static     */
-    protected Element short_service_info = null;
-
-    /** XML element for stylesheet requests - map of service name to format 
-    elem */
-    protected HashMap format_info_map = null;
-
-    /** A class loader that knows about the collection resources directory 
-     *  can put properties files, dtds etc  in here */
-    CollectionClassLoader class_loader = null;
-    
-    /** sets the cluster name */
-    public void setClusterName(String cluster_name) {
-    this.cluster_name = cluster_name;
-    }
-    /** sets the collect name */
-    public void setCollectionName(String coll_name) {
-    setClusterName(coll_name);
-    }
-
-    public void cleanUp() {}
-    
-    /** sets the site home */
-    public void setSiteHome(String site_home) {
-    this.site_home = site_home;
-    }
-    /** sets the site http address */
-    public void setSiteAddress(String site_address) {
-    this.site_http_address = site_address;
-    }
-
-    public void setLibraryName(String library_name) {
-    this.library_name = library_name;
-    }
-    public String getLibraryName() {
-    return this.library_name;
-    }
-    /** sets the message router */
-    public void setMessageRouter(MessageRouter m) {
-       this.router = m;
-       setLibraryName(m.getLibraryName());
-    }
-
-    /** the no-args constructor */
-    public ServiceRack() {
-    this.converter = new XMLConverter();
-    this.doc = this.converter.newDOM();
-    this.short_service_info = this.doc.createElement(GSXML.SERVICE_ELEM+GSXML.LIST_MODIFIER);
-    this.format_info_map = new HashMap();
-    }
-    
-
-    /** configure the service module
-     *
-     * @param info the XML node <serviceRack name="XXX"/> with name equal
-     * to the class name (of the subclass)
-     *
-     * must configure short_service_info_ and service_info_map_
-     * @return true if configured ok
-     * must be implemented in subclasses
-     */
-    public boolean configure(Element info) {
-    return configure(info, null);
-    }
-    
-    public boolean configure(Element info, Element extra_info) {
-    // set up the class loader
-    this.class_loader = new CollectionClassLoader(this.getClass().getClassLoader(), this.site_home, this.cluster_name);
-    return true;
-    }
-
-    /**
-     * Process an XML document - convenience method that uses Strings rather than Elements. just calls process(Element).
-     *
-     * @param xml_in the Document to process - a string
-     * @return the resultant document as a string - contains any error messages
-     * @see String
-     */
-    public String process(String xml_in) {
-    
-    Document doc = this.converter.getDOM(xml_in);
-    if (doc == null) {
-        logger.error("Couldn't parse request");
-        logger.error(xml_in);
-        return null;
-    }
-    Node res = process(doc);
-    return this.converter.getString(res);
-    
-    }
-
-    /** process an XML request in DOM form
-     *
-     * @param message the Node node containing the request
-     * should be <message> 
-     * @return an Node with the result XML
-     * @see Node/Element
-     */
-    public Node process(Node message_node) {
-
-    Element message = this.converter.nodeToElement(message_node);
-
-    NodeList requests = message.getElementsByTagName(GSXML.REQUEST_ELEM);
-    Document mess_doc = message.getOwnerDocument();
-    Element mainResult = this.doc.createElement(GSXML.MESSAGE_ELEM);
-    if (requests.getLength()==0) {
-        // no requests
-        return mainResult; // empty message for now
-    }
-
-    for (int i=0; i<requests.getLength(); i++) {
-        Element request = (Element)requests.item(i);
-    
-        String type = request.getAttribute(GSXML.TYPE_ATT);
-        if (type.equals(GSXML.REQUEST_TYPE_DESCRIBE)) {
-        Element response = processDescribe(request);
-        if (response !=null) {
-            mainResult.appendChild(this.doc.importNode(response, true));
-        }
-        
-        } else if (type.equals(GSXML.REQUEST_TYPE_FORMAT)) {
-        Element response = processFormat(request);
-            mainResult.appendChild(this.doc.importNode(response, true));
-        
-           
-        } else {
-        // other type of request, must be processed by the subclass - 
-        // send to the service method
-        StringBuffer error_string = new StringBuffer();
-        String to = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));        
-        Element response = null;
-        try {
-            Class c = this.getClass();
-            Class []params = {Class.forName("org.w3c.dom.Element")};
-            
-            String method_name = "process"+to;
-            Method m = null;
-            while (c != null) {
-            
-            try {
-                m = c.getDeclaredMethod(method_name, params);
-                // if this has worked, break
-                break;
-            } catch (NoSuchMethodException e) {
-                c = c.getSuperclass();
-            } catch (SecurityException e) {
-                logger.error("security exception for finding method "+method_name);
-                error_string.append("ServiceRack.process: security exception for finding method "+method_name);
+    static Logger logger = Logger.getLogger(org.greenstone.gsdl3.service.ServiceRack.class.getName());
+
+    /** the absolute address of the site home */
+    protected String site_home = null;
+    /** the http address of the site home */
+    protected String site_http_address = null;
+
+    protected String library_name = null;
+    /**
+     * the name of the cluster (or collection) that this service belongs to - if
+     * any
+     */
+    protected String cluster_name = null;
+
+    /** some services can talk back to the message router */
+    protected MessageRouter router = null;
+
+    /** a converter class to create Documents etc */
+    protected XMLConverter converter = null;
+
+    /** the original config info - if need to store it */
+    protected Element config_info = null;
+
+    /** XML element for describe requests - the container doc */
+    protected Document doc = null;
+
+    /**
+     * XML element for describe requests - list of supported services - this is
+     * static
+     */
+    protected Element short_service_info = null;
+
+    /**
+     * XML element for stylesheet requests - map of service name to format elem
+     */
+    protected HashMap format_info_map = null;
+
+    /**
+     * A class loader that knows about the collection resources directory can
+     * put properties files, dtds etc in here
+     */
+    CollectionClassLoader class_loader = null;
+
+    /** sets the cluster name */
+    public void setClusterName(String cluster_name)
+    {
+        this.cluster_name = cluster_name;
+    }
+
+    /** sets the collect name */
+    public void setCollectionName(String coll_name)
+    {
+        setClusterName(coll_name);
+    }
+
+    public void cleanUp()
+    {
+    }
+
+    /** sets the site home */
+    public void setSiteHome(String site_home)
+    {
+        this.site_home = site_home;
+    }
+
+    /** sets the site http address */
+    public void setSiteAddress(String site_address)
+    {
+        this.site_http_address = site_address;
+    }
+
+    public void setLibraryName(String library_name)
+    {
+        this.library_name = library_name;
+    }
+
+    public String getLibraryName()
+    {
+        return this.library_name;
+    }
+
+    /** sets the message router */
+    public void setMessageRouter(MessageRouter m)
+    {
+        this.router = m;
+        setLibraryName(m.getLibraryName());
+    }
+
+    /** the no-args constructor */
+    public ServiceRack()
+    {
+        this.converter = new XMLConverter();
+        this.doc = this.converter.newDOM();
+        this.short_service_info = this.doc.createElement(GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
+        this.format_info_map = new HashMap();
+    }
+
+    /**
+     * configure the service module
+     * 
+     * @param info
+     *            the XML node <serviceRack name="XXX"/> with name equal to the
+     *            class name (of the subclass)
+     * 
+     *            must configure short_service_info_ and service_info_map_
+     * @return true if configured ok must be implemented in subclasses
+     */
+    public boolean configure(Element info)
+    {
+        return configure(info, null);
+    }
+
+    public boolean configure(Element info, Element extra_info)
+    {
+        // set up the class loader
+        this.class_loader = new CollectionClassLoader(this.getClass().getClassLoader(), this.site_home, this.cluster_name);
+        return true;
+    }
+
+    /**
+     * Process an XML document - convenience method that uses Strings rather
+     * than Elements. just calls process(Element).
+     * 
+     * @param xml_in
+     *            the Document to process - a string
+     * @return the resultant document as a string - contains any error messages
+     * @see String
+     */
+    public String process(String xml_in)
+    {
+
+        Document doc = this.converter.getDOM(xml_in);
+        if (doc == null)
+        {
+            logger.error("Couldn't parse request");
+            logger.error(xml_in);
+            return null;
+        }
+        Node res = process(doc);
+        return this.converter.getString(res);
+
+    }
+
+    /**
+     * process an XML request in DOM form
+     * 
+     * @param message
+     *            the Node node containing the request should be <message>
+     * @return an Node with the result XML
+     * @see Node/Element
+     */
+    public Node process(Node message_node)
+    {
+
+        Element message = this.converter.nodeToElement(message_node);
+
+        NodeList requests = message.getElementsByTagName(GSXML.REQUEST_ELEM);
+        Document mess_doc = message.getOwnerDocument();
+        Element mainResult = this.doc.createElement(GSXML.MESSAGE_ELEM);
+        if (requests.getLength() == 0)
+        {
+            // no requests
+            return mainResult; // empty message for now
+        }
+
+        for (int i = 0; i < requests.getLength(); i++)
+        {
+            Element request = (Element) requests.item(i);
+
+            String type = request.getAttribute(GSXML.TYPE_ATT);
+            if (type.equals(GSXML.REQUEST_TYPE_DESCRIBE))
+            {
+                Element response = processDescribe(request);
+                if (response != null)
+                {
+                    mainResult.appendChild(this.doc.importNode(response, true));
+                }
+
             }
-            } // while
-            if (m != null) {
-            Object []args = {request};
-            try {
-                response = (Element)m.invoke(this, args);
-                
-            } catch (Exception e) {
-              logger.error("Trying to call a processService type method (process"+to+") on a subclass("+this.getClass().getName()+"), but an exception happened:"+e.toString(), e);
-                
-                error_string.append("Trying to call a processService type method (process"+to+") on a subclass("+this.getClass().getName()+"), but an exception happened:"+e.toString());
+            else if (type.equals(GSXML.REQUEST_TYPE_FORMAT))
+            {
+                Element response = processFormat(request);
+                mainResult.appendChild(this.doc.importNode(response, true));
+
             }
-            } else {
-            logger.error("method "+method_name+" not found for class "+this.getClass().getName());
-            error_string.append("ServiceRack.process: method "+method_name+" not found for class "+this.getClass().getName());
-            }
-            
-        } catch (ClassNotFoundException e) {
-            logger.error("Element class not found");
-            error_string.append("Element class not found");
-        }
-        if (response !=null) {
-            mainResult.appendChild(this.doc.importNode(response, true));
-        } else {
-            // add in a dummy response
-            logger.error("adding in an error element\n");
-            response = this.doc.createElement(GSXML.RESPONSE_ELEM);
-            GSXML.addError(this.doc, response, error_string.toString());
-            mainResult.appendChild(response);
-            
-        }
- 
-        } // else process request
-    } // for each request
-    
-    return mainResult;
-        
-    }
-
- 
-
-    /** process method for describe requests 
-     */
-    protected Element processDescribe(Element request) {
-    
-    Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
-    response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_DESCRIBE);
-    
-    String lang = request.getAttribute(GSXML.LANG_ATT);
-    String to = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));
-    if (to.equals("")) { // return the service list
-        response.appendChild(getServiceList(lang));
-        return response;
-    } 
-    response.setAttribute(GSXML.FROM_ATT, to);
-    Element param_list = (Element)GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
-    Element description = null;
-    if (param_list == null) {
-        description = getServiceDescription(to, lang, null);
-    } else {
-        NodeList params = param_list.getElementsByTagName(GSXML.PARAM_ELEM);
-        for (int i=0; i<params.getLength(); i++) {
-        
-        Element param = (Element)params.item(i);
-        // Identify the structure information desired
-        if (param.getAttribute(GSXML.NAME_ATT).equals(GSXML.SUBSET_PARAM )) {
-            String info = param.getAttribute(GSXML.VALUE_ATT);
-            if (description == null) {
-             description = getServiceDescription(to, lang, info);
-            } else {
-            Element temp = getServiceDescription(to, lang, info);
-            GSXML.mergeElements(description, temp);
-            }
-        }
-        }
-    }
-    if (description != null) { // may be null if non-existant service
-        response.appendChild(description);
-    }
-    return response;
-    
-    }
-
-    /** process method for stylesheet requests
-     */
-    protected Element processFormat(Element request) {
-    Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
-    response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_FORMAT);
-    
-    String to = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));
-    
-    if (to.equals("")) { // serviceRack query - is this appropriate??
-        return response;
-    } 
-    
-    
-    // describe a particular service    
-    if (this.format_info_map.containsKey(to)) {
-        response.appendChild(getServiceFormat(to));
-        response.setAttribute(GSXML.FROM_ATT, to);
-        return response;
-    }
-    // else no format info
-    logger.error("ServiceRack describe request: no format info for "+to+".");
-    return response;
-    }   
-    
-    /** returns the service list for the subclass */
-    protected Element getServiceList(String lang) {
-    // for now, it is static and has no language stuff
-    return (Element) this.short_service_info.cloneNode(true);
-    }
-    
-    /** returns a specific service description */
-    abstract protected Element getServiceDescription(String service, String lang, String subset);
-
-    protected Element getServiceFormat(String service) {
-    Element format = (Element)((Element)this.format_info_map.get(service)).cloneNode(true);
-    return format;
-    }
-
-    /** overloaded version for no args case */
-    protected String getTextString(String key, String lang) {
-    return getTextString(key, lang, null, null);
-    }
-
-    protected String getTextString(String key, String lang, String dictionary) {
-    return getTextString(key, lang, dictionary, null);
-    }
-    protected String getTextString(String key, String lang, String [] args) {
-    return getTextString(key, lang, null, args);
-    }
-    
-    /** getTextString - retrieves a language specific text string for the given
-key and locale, from the specified resource_bundle (dictionary)
-    */
-    protected String getTextString(String key, String lang, String dictionary, String[] args) {
-
-    // we want to use the collection class loader in case there are coll specific files
-    if (dictionary != null) {
-        // just try the one specified dictionary
-        Dictionary dict = new Dictionary(dictionary, lang, this.class_loader);
-        String result = dict.get(key, args);
-        if (result == null) { // not found
-        return "_"+key+"_";
-        }
-        return result;
-    }
-
-    // now we try class names for dictionary names
-    String class_name = this.getClass().getName();
-    class_name = class_name.substring(class_name.lastIndexOf('.')+1);
-    Dictionary dict = new Dictionary(class_name, lang, this.class_loader);
-    String result = dict.get(key, args);
-    if (result != null) {
-        return result;
-    }
-
-    // we have to try super classes
-    Class c = this.getClass().getSuperclass();
-    while (result == null && c != null) {
-        class_name = c.getName();
-        class_name = class_name.substring(class_name.lastIndexOf('.')+1);
-        if (class_name.equals("ServiceRack")) {
-        // this is as far as we go
-        break;
-        }
-        dict = new Dictionary(class_name, lang, this.class_loader);
-        result = dict.get(key, args);
-        c = c.getSuperclass();
-    }
-    if (result == null) {
-        return "_"+key+"_";
-    }
-    return result;
-    
-    }
-
-    protected String getMetadataNameText(String key, String lang) {
-
-    String properties_name = "metadata_names";
-    Dictionary dict = new Dictionary(properties_name, lang);
-    
-    String result = dict.get(key);
-    if (result == null) { // not found
-        return null;
-    } 
-    return result;
-    }
+            else
+            {
+                // other type of request, must be processed by the subclass - 
+                // send to the service method
+                StringBuffer error_string = new StringBuffer();
+                String to = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));
+                Element response = null;
+                try
+                {
+                    Class c = this.getClass();
+                    Class[] params = { Class.forName("org.w3c.dom.Element") };
+
+                    String method_name = "process" + to;
+                    Method m = null;
+                    while (c != null)
+                    {
+
+                        try
+                        {
+                            m = c.getDeclaredMethod(method_name, params);
+                            // if this has worked, break
+                            break;
+                        }
+                        catch (NoSuchMethodException e)
+                        {
+                            c = c.getSuperclass();
+                        }
+                        catch (SecurityException e)
+                        {
+                            logger.error("security exception for finding method " + method_name);
+                            error_string.append("ServiceRack.process: security exception for finding method " + method_name);
+                        }
+                    } // while
+                    if (m != null)
+                    {
+                        Object[] args = { request };
+                        try
+                        {
+                            response = (Element) m.invoke(this, args);
+
+                        }
+                        catch (Exception e)
+                        {
+                            logger.error("Trying to call a processService type method (process" + to + ") on a subclass(" + this.getClass().getName() + "), but an exception happened:" + e.toString(), e);
+
+                            error_string.append("Trying to call a processService type method (process" + to + ") on a subclass(" + this.getClass().getName() + "), but an exception happened:" + e.toString());
+                        }
+                    }
+                    else
+                    {
+                        logger.error("method " + method_name + " not found for class " + this.getClass().getName());
+                        error_string.append("ServiceRack.process: method " + method_name + " not found for class " + this.getClass().getName());
+                    }
+
+                }
+                catch (ClassNotFoundException e)
+                {
+                    logger.error("Element class not found");
+                    error_string.append("Element class not found");
+                }
+                if (response != null)
+                {
+                    mainResult.appendChild(this.doc.importNode(response, true));
+                }
+                else
+                {
+                    // add in a dummy response
+                    logger.error("adding in an error element\n");
+                    response = this.doc.createElement(GSXML.RESPONSE_ELEM);
+                    GSXML.addError(this.doc, response, error_string.toString());
+                    mainResult.appendChild(response);
+
+                }
+
+            } // else process request
+        } // for each request
+
+        return mainResult;
+
+    }
+
+    /**
+     * process method for describe requests
+     */
+    protected Element processDescribe(Element request)
+    {
+
+        Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
+        response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_DESCRIBE);
+
+        String lang = request.getAttribute(GSXML.LANG_ATT);
+        String to = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));
+        if (to.equals(""))
+        { // return the service list
+            response.appendChild(getServiceList(lang));
+            return response;
+        }
+        response.setAttribute(GSXML.FROM_ATT, to);
+        Element param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
+        Element description = null;
+        if (param_list == null)
+        {
+            description = getServiceDescription(to, lang, null);
+        }
+        else
+        {
+            NodeList params = param_list.getElementsByTagName(GSXML.PARAM_ELEM);
+            for (int i = 0; i < params.getLength(); i++)
+            {
+
+                Element param = (Element) params.item(i);
+                // Identify the structure information desired
+                if (param.getAttribute(GSXML.NAME_ATT).equals(GSXML.SUBSET_PARAM))
+                {
+                    String info = param.getAttribute(GSXML.VALUE_ATT);
+                    if (description == null)
+                    {
+                        description = getServiceDescription(to, lang, info);
+                    }
+                    else
+                    {
+                        Element temp = getServiceDescription(to, lang, info);
+                        GSXML.mergeElements(description, temp);
+                    }
+                }
+            }
+        }
+        if (description != null)
+        { // may be null if non-existant service
+            response.appendChild(description);
+        }
+        return response;
+
+    }
+
+    /**
+     * process method for stylesheet requests
+     */
+    protected Element processFormat(Element request)
+    {
+        Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
+        response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_FORMAT);
+
+        String to = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));
+
+        if (to.equals(""))
+        { // serviceRack query - is this appropriate??
+            return response;
+        }
+
+        // describe a particular service    
+        if (this.format_info_map.containsKey(to))
+        {
+            response.appendChild(getServiceFormat(to));
+            response.setAttribute(GSXML.FROM_ATT, to);
+            return response;
+        }
+        // else no format info
+        logger.error("ServiceRack describe request: no format info for " + to + ".");
+        return response;
+    }
+
+    /** returns the service list for the subclass */
+    protected Element getServiceList(String lang)
+    {
+        // for now, it is static and has no language stuff
+        return (Element) this.short_service_info.cloneNode(true);
+    }
+
+    /** returns a specific service description */
+    abstract protected Element getServiceDescription(String service, String lang, String subset);
+
+    protected Element getServiceFormat(String service)
+    {
+        Element format = (Element) ((Element) this.format_info_map.get(service)).cloneNode(true);
+        return format;
+    }
+
+    /** overloaded version for no args case */
+    protected String getTextString(String key, String lang)
+    {
+        return getTextString(key, lang, null, null);
+    }
+
+    protected String getTextString(String key, String lang, String dictionary)
+    {
+        return getTextString(key, lang, dictionary, null);
+    }
+
+    protected String getTextString(String key, String lang, String[] args)
+    {
+        return getTextString(key, lang, null, args);
+    }
+
+    /**
+     * getTextString - retrieves a language specific text string for the given
+     * key and locale, from the specified resource_bundle (dictionary)
+     */
+    protected String getTextString(String key, String lang, String dictionary, String[] args)
+    {
+
+        // we want to use the collection class loader in case there are coll specific files
+        if (dictionary != null)
+        {
+            // just try the one specified dictionary
+            Dictionary dict = new Dictionary(dictionary, lang, this.class_loader);
+            String result = dict.get(key, args);
+            if (result == null)
+            { // not found
+                return "_" + key + "_";
+            }
+            return result;
+        }
+
+        // now we try class names for dictionary names
+        String class_name = this.getClass().getName();
+        class_name = class_name.substring(class_name.lastIndexOf('.') + 1);
+        Dictionary dict = new Dictionary(class_name, lang, this.class_loader);
+        String result = dict.get(key, args);
+        if (result != null)
+        {
+            return result;
+        }
+
+        // we have to try super classes
+        Class c = this.getClass().getSuperclass();
+        while (result == null && c != null)
+        {
+            class_name = c.getName();
+            class_name = class_name.substring(class_name.lastIndexOf('.') + 1);
+            if (class_name.equals("ServiceRack"))
+            {
+                // this is as far as we go
+                break;
+            }
+            dict = new Dictionary(class_name, lang, this.class_loader);
+            result = dict.get(key, args);
+            c = c.getSuperclass();
+        }
+        if (result == null)
+        {
+            return "_" + key + "_";
+        }
+        return result;
+
+    }
+
+    protected String getMetadataNameText(String key, String lang)
+    {
+
+        String properties_name = "metadata_names";
+        Dictionary dict = new Dictionary(properties_name, lang);
+
+        String result = dict.get(key);
+        if (result == null)
+        { // not found
+            return null;
+        }
+        return result;
+    }
 }
-

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

@@ -22 +22 @@
 import java.util.HashMap;
 import java.util.Set;
-/** class to hold info from a gdbm (or equiv) query
- * maps a String key to a list of Strings (values)
- * at the moment, the user must know if something has a single value or not
+
+/**
+ * class to hold info from a gdbm (or equiv) query maps a String key to a list
+ * of Strings (values) at the moment, the user must know if something has a
+ * single value or not
  */
-public class DBInfo {
+public class DBInfo
+{
+    protected HashMap info_map_;
 
-    protected HashMap info_map_;
+    public DBInfo()
+    {
+        info_map_ = new HashMap();
+    }
 
-    public DBInfo() {
-    info_map_ = new HashMap();
-    }
+    // methods for keys that can have a single value
 
-    // methods for keys that can have a single value
+    /** set the value for a key - replaces any existing value */
+    public void setInfo(String key, String value)
+    {
+        Vector v = new Vector();
+        v.add(value);
+        info_map_.put(key, v);
+    }
 
-    /** set the value for a key - replaces any existing value */
-    public void setInfo(String key, String value) {
-    Vector v = new Vector();
-    v.add(value);
-    info_map_.put(key, v);
-    }
+    /**
+     * get the value - used for keys that have one value, otherwise just returns
+     * the first one
+     */
+    public String getInfo(String key)
+    {
+        Vector items = (Vector) info_map_.get(key);
+        if (items == null)
+        {
+            return "";
+        }
+        return (String) items.firstElement();
+    }
 
-    /** get the value - used for keys that have one value, otherwise just
-     * returns the first one */
-    public String getInfo(String key) {
-    Vector items = (Vector)info_map_.get(key);
-    if (items==null) {
-        return "";
+    // methods for keys that can have multiple values
+
+    /** add a value to a key - for keys that can have multiple values */
+    public void addInfo(String key, String value)
+    {
+        Vector v = (Vector) info_map_.get(key);
+        if (v == null)
+        {
+            v = new Vector();
+        }
+        v.add(value);
+        info_map_.put(key, v);
     }
-    return (String)items.firstElement();
-    }
 
-    /** get the value for the key at offset. If offset out of bounds,
-     * just return the first one. */
-    public String getInfoOffset(String key, int offset) {
-    Vector items = (Vector)info_map_.get(key);
-    if (items==null) {
-        return "";
+    /**
+     * return a vector of all values associated with a key
+     * 
+     * @return Vector of Strings
+     */
+    public Vector getMultiInfo(String key)
+    {
+        return (Vector) info_map_.get(key);
     }
-    if(offset >= 0 && offset < items.size()) {
-        return (String)items.get(offset);
-    } // else
-    return (String)items.firstElement();
-    }
 
+    /** returns a list of all the keys in the info */
+    public Set getKeys()
+    {
+        return info_map_.keySet();
+    }
 
-    // methods for keys that can have multiple values
-    
-    /** add a value to a key - for keys that can have multiple values */
-    public void addInfo(String key, String value) {
-    Vector v = (Vector)info_map_.get(key);
-    if (v==null) {
-        v = new Vector();
+    /** returns the Info as a string */
+    public String toString()
+    {
+        return info_map_.toString();
+
     }
-    v.add(value);
-    info_map_.put(key, v);
-    }
-    /** return a vector of all values associated with a key 
-     * @return Vector of Strings
-     */
-    public Vector getMultiInfo(String key) {
-    return (Vector)info_map_.get(key);
-    }
-
-    /** returns a list of all the keys in the info */
-    public Set getKeys() {
-    return info_map_.keySet();
-    }
-    /** returns the Info as a string */
-    public String toString() {
-    return info_map_.toString();
-
-    }
 }

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

@@ -37 +37 @@
   /** returns the value associated with the key */
   public String getValue(String key);
+  
+  /** sets the given key to the given value in the database */
+  public boolean setValue(String key, String value);
+  
+  /** deletes the given key from the database */
+  public boolean deleteKey(String key);
 
   /** returns a string of key-value entries that can be 

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

@@ -28 +28 @@
 import java.io.File;
 
-/** java wrapper class for gdbm - uses Java-GDBM written by Martin Pool
- * replaces gdbmclass in the old version
+/**
+ * java wrapper class for gdbm - uses Java-GDBM written by Martin Pool replaces
+ * gdbmclass in the old version
  */
 
-public class GDBMWrapper 
-  implements FlatDatabaseWrapper {
-
-  static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.GDBMWrapper.class.getName());
-  
-  /* GdbmFile modes:
-     READER - read access, many readers may share the database
-     WRITER - read/write access, exclusive access
-     WRCREAT - read/write access, create db if doesn't exist
-     NEWDB - read/write access, db should be replaced if exists
-  */
-    
-    
-    protected GdbmFile db_=null;
-    
-  /** open the database filename, with mode mode - uses the constants
-      above, eg GdbmFile.WRITER */
-  public boolean openDatabase(String filename, int mode) {
-    // need to convert mode to GdbmFile mode
-    if (mode == READ) { 
-      mode = GdbmFile.READER;
-    } else if (mode == WRITE) {
-      mode = GdbmFile.WRITER;
-    }   else {
-      logger.error ("invalid mode, "+mode+ ", opening db for reading only");
-      mode = GdbmFile.READER;
-    }
-    try {
-    if (db_!=null) {
-        db_.close();
-    }
-
-    // The java version of the C++ code in common-src/src/lib/gdbmclass.cpp
-    if(mode == GdbmFile.READER) {
-      // Looking to read in the database
-      // we now use gdb extension. Check for ldb/bdb in case of legacy collection
-      // if not (first time) then generate using txt2db
-        if (!new File(filename).exists()) {
-          logger.warn("Database file " + filename + " does not exist. Looking for ldb/bdb version");
-          int extension = filename.lastIndexOf('.');
-          String filename_head = filename.substring(0, extension);
-          filename = filename_head + ".ldb";
-          if (!new File(filename).exists()) {
-        filename = filename_head + ".bdb";
+public class GDBMWrapper implements FlatDatabaseWrapper
+{
+
+    static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.GDBMWrapper.class.getName());
+
+    /*
+     * GdbmFile modes: READER - read access, many readers may share the database
+     * WRITER - read/write access, exclusive access WRCREAT - read/write access,
+     * create db if doesn't exist NEWDB - read/write access, db should be
+     * replaced if exists
+     */
+
+    protected GdbmFile db_ = null;
+
+    /**
+     * open the database filename, with mode mode - uses the constants above, eg
+     * GdbmFile.WRITER
+     */
+    public boolean openDatabase(String filename, int mode)
+    {
+        // need to convert mode to GdbmFile mode
+        if (mode == READ)
+        {
+            mode = GdbmFile.READER;
+        }
+        else if (mode == WRITE)
+        {
+            mode = GdbmFile.WRITER;
+        }
+        else
+        {
+            logger.error("invalid mode, " + mode + ", opening db for reading only");
+            mode = GdbmFile.READER;
+        }
+        try
+        {
+            if (db_ != null)
+            {
+                db_.close();
+            }
+
+            // The java version of the C++ code in common-src/src/lib/gdbmclass.cpp
+            if (mode == GdbmFile.READER)
+            {
+                // Looking to read in the database
+                // we now use gdb extension. Check for ldb/bdb in case of legacy collection
+                // if not (first time) then generate using txt2db
+                if (!new File(filename).exists())
+                {
+                    logger.warn("Database file " + filename + " does not exist. Looking for ldb/bdb version");
+                    int extension = filename.lastIndexOf('.');
+                    String filename_head = filename.substring(0, extension);
+                    filename = filename_head + ".ldb";
+                    if (!new File(filename).exists())
+                    {
+                        filename = filename_head + ".bdb";
+
+                        if (!new File(filename).exists())
+                        {
+                            logger.warn("ldb/bdb version of database file " + filename + " does not exist. Looking for txtgz version of db file.");
+                            // put the filename back to gdb
+                            filename = filename_head + ".gdb";
+                            // need to generate architecture native GDBM file using txt2db
+
+                            // replace sought after gdbm filename ext with ".txt.gz"
+
+                            String txtgzFilename = filename_head + ".txt.gz";
+                            if (new File(txtgzFilename).exists())
+                            {
+                                // Test to make sure Perl is on the path
+                                // On Linux, the output of the test goes to STDOUT so redirect it to STDERR
+                                String cmdTest = "perl -v 2>&1";
+                                //String cmdTest = "echo %PATH%";
+                                int returnValue = Processing.runProcess(cmdTest);
+                                if (returnValue != 0)
+                                {
+                                    logger.error("Tried to find Perl. Return exit value of running " + cmdTest + ": " + returnValue + ", (expected this to be 0)");
+                                    logger.error("Check that Perl is set in your PATH environment variable.");
+                                    //log.error("At present, PATH=" + System.getenv("PATH"));
+                                }
+
+                                String cmd = "perl -S txtgz-to-gdbm.pl \"" + txtgzFilename + "\" \"" + filename + "\"";
+                                returnValue = Processing.runProcess(cmd);
+                                // For some reason, launching this command with gsdl_system() still returns 1
+                                // even when it returns 0 when run from the command-line. We can check whether
+                                // we succeeded by looking at whether the output database file was created.
+                                if (returnValue != 0)
+                                {
+                                    logger.warn("Warning, non-zero return value on running command \"" + cmd + "\": " + returnValue);
+                                    if (!new File(filename).exists())
+                                    {
+                                        logger.error("Tried to run command \"" + cmd + "\", but it failed");
+                                    }
+                                }
+                            }
+                        }
+                    }
+
+                }
+            }
+
+            db_ = new GdbmFile(filename, mode);
+        }
+        catch (GdbmException e)
+        { // the database wasn't opened or created
+            logger.error("couldn't open database " + filename);
+            return false;
+        }
+        db_.setKeyPacking(new StringPacking());
+        db_.setValuePacking(new StringPacking());
+        return true;
+    }
+
+    /** close the database associated with this wrapper */
+    public void closeDatabase()
+    {
+        try
+        {
+            if (db_ != null)
+            {
+                db_.close();
+                db_ = null;
+                if (System.getProperty("os.name").startsWith("Windows"))
+                {
+                    //Hack: force Windows to let go of the gdb file
+                    System.gc();
+                }
+            }
+        }
+        catch (GdbmException e)
+        {
+            // should never get here - close never actually throws an exception
+            logger.error("error on close()");
+        }
+    }
+
+    public String getValue(String key)
+    {
+        if (db_ == null)
+        {
+            return null;
+        }
+        String s_info;
+        try
+        {
+            try
+            {
+                // The key is UTF8: do db lookup using the UTF8 version of key
+                s_info = (String) db_.fetch(key.getBytes("UTF-8"));
+            }
+            catch (UnsupportedEncodingException e)
+            {
+                logger.warn("utf8 key for " + key + " unrecognised. Retrying with default encoding.");
+                // retry db lookup using default encoding of key instead of UTF8
+                s_info = (String) db_.fetch(key);
+            }
+        }
+        catch (GdbmException e)
+        {
+            logger.error("couldn't get record");
+            return null;
+        }
+        if (s_info == null)
+        {
+            // record not present
+            logger.error("key " + key + " not present in db");
+            return null;
+        }
+        return s_info;
+    }
+
+    /**
+     * sets the given key to the given value in the database
+     */
+    public boolean setValue(String key, String value)
+    {
+        if (db_ == null || !db_.isWritable())
+        {
+            logger.error("GDBM database is either null or not writable");
+            return false;
+        }
         
-        if (!new File(filename).exists()) {
-        logger.warn("ldb/bdb version of database file " + filename + " does not exist. Looking for txtgz version of db file.");
-        // put the filename back to gdb
-        filename = filename_head + ".gdb";
-        // need to generate architecture native GDBM file using txt2db
+        try
+        {
+            db_.store(key, value);
+        }
+        catch (GdbmException ex)
+        {
+            logger.error("Error storing " + key + " = " + value + " in GDBM database");
+            logger.error("Error message is: " + ex.getMessage());
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * deletes the entry for given key
+     */
+    public boolean deleteKey(String key)
+    {
+        if (db_ == null)
+        {
+            logger.error("GDBM database is null");
+            return false;
+        }
         
-        // replace sought after gdbm filename ext with ".txt.gz"
+        try
+        {
+            db_.delete(key);
+        }
+        catch (GdbmException ex)
+        {
+            logger.error("Error deleting key " + key + " from the database");
+            logger.error("Error message is: " + ex.getMessage());
+            return false;
+        }
         
-        String txtgzFilename = filename_head + ".txt.gz";
-        if(new File(txtgzFilename).exists()) {          
-            // Test to make sure Perl is on the path
-            // On Linux, the output of the test goes to STDOUT so redirect it to STDERR
-            String cmdTest = "perl -v 2>&1";            
-            //String cmdTest = "echo %PATH%";
-            int returnValue = Processing.runProcess(cmdTest);
-            if (returnValue != 0) {
-            logger.error("Tried to find Perl. Return exit value of running " 
-                     + cmdTest + ": " +  returnValue + ", (expected this to be 0)");
-            logger.error("Check that Perl is set in your PATH environment variable.");
-            //log.error("At present, PATH=" + System.getenv("PATH"));
-            }
-            
-            String cmd = "perl -S txtgz-to-gdbm.pl \"" + txtgzFilename + "\" \"" + filename + "\"";
-            returnValue = Processing.runProcess(cmd);
-            // For some reason, launching this command with gsdl_system() still returns 1
-            // even when it returns 0 when run from the command-line. We can check whether
-            // we succeeded by looking at whether the output database file was created.
-            if (returnValue != 0) {
-            logger.warn("Warning, non-zero return value on running command \"" + cmd + "\": " + returnValue);
-            if (!new File(filename).exists()) {
-                logger.error("Tried to run command \"" + cmd + "\", but it failed");
-            }
-            }           
-        }
-        }
-          }
-          
-        }
-    }
-
-    db_ = new GdbmFile(filename, mode);
-    } catch ( GdbmException e) { // the database wasn't opened or created
-    logger.error("couldn't open database "+filename);
-    return false;
-    } 
-    db_.setKeyPacking(new StringPacking());
-    db_.setValuePacking(new StringPacking());
-    return true;
-  }
-  
-  /** close the database associated with this wrapper */
-  public void closeDatabase() {
-    try {
-      if (db_ != null) {
-       db_.close();
-       db_ = null;
-        if(System.getProperty("os.name").startsWith("Windows")) {
-            //Hack: force Windows to let go of the gdb file
-            System.gc();
-        }
-      }
-    } catch (GdbmException e) {
-      // should never get here - close never actually throws an exception
-      logger.error("error on close()");
-    }
-  }
-
-  public String getValue(String key) {
-    if (db_==null) {
-      return null;
-    }
-    String s_info;
-    try {
-    try {
-        // The key is UTF8: do db lookup using the UTF8 version of key
-        s_info = (String)db_.fetch(key.getBytes("UTF-8"));
-    } catch(UnsupportedEncodingException e) {
-        logger.warn("utf8 key for " + key 
-             + " unrecognised. Retrying with default encoding.");
-        // retry db lookup using default encoding of key instead of UTF8
-        s_info = (String)db_.fetch(key);
-    }
-    } catch (GdbmException e) {
-      logger.error("couldn't get record");
-      return null;
-    }
-    if (s_info==null) {
-      // record not present
-      logger.error("key "+key+" not present in db");
-      return null;
-    }
-    return s_info;
-  }
-
-  /** sets the key value as info 
-   * TODO - not implemented yet */
-  public boolean setValue (String key, String value) {
-    if (db_==null) {
-      return false;
-    }
-    return false;
-  }
-  /** deletes the entry for key 
-   * TODO - not implemented yet */
-  public boolean deleteKey(String key) {
-    if (db_==null) {
-      return false;
-    }
-    return false;
-  }
-
-    /** returns a string of key-value entries that
-     *  can be printed for debugging purposes. */
-    public String displayAllEntries() {
-    StringBuffer output = new StringBuffer();
-    try{
-        java.util.Enumeration e = db_.keys();
-        while(e.hasMoreElements()) {
-        Object key = e.nextElement();
-        Object value = db_.fetch(key);
-
-        output.append("key href: ");
-        output.append((String)key);
-        output.append("\tvalue ID: ");
-        output.append((String)value);
-        output.append("\n");
-        //logger.warn("key: " + key + "\tvalue: " + value);
-
-        String urlkey = java.net.URLEncoder.encode((String)key, "UTF8");
-        output.append("URL encoded key: " + urlkey);
-        //logger.warn("URL encoded key: " + urlkey);
-        }
-    } catch(UnsupportedEncodingException e) {
-        logger.warn("Trouble converting key to UTF-8.");
-    } catch(Exception e) {
-        logger.warn("Exception encountered when trying to displayAllEntries():" + e);
-    }
-    return output.toString();
-    }
+        return true;
+    }
+
+    /**
+     * returns a string of key-value entries that can be printed for debugging
+     * purposes.
+     */
+    public String displayAllEntries()
+    {
+        StringBuffer output = new StringBuffer();
+        try
+        {
+            java.util.Enumeration e = db_.keys();
+            while (e.hasMoreElements())
+            {
+                Object key = e.nextElement();
+                Object value = db_.fetch(key);
+
+                output.append("key href: ");
+                output.append((String) key);
+                output.append("\tvalue ID: ");
+                output.append((String) value);
+                output.append("\n");
+                //logger.warn("key: " + key + "\tvalue: " + value);
+
+                String urlkey = java.net.URLEncoder.encode((String) key, "UTF8");
+                output.append("URL encoded key: " + urlkey);
+                //logger.warn("URL encoded key: " + urlkey);
+            }
+        }
+        catch (UnsupportedEncodingException e)
+        {
+            logger.warn("Trouble converting key to UTF-8.");
+        }
+        catch (Exception e)
+        {
+            logger.warn("Exception encountered when trying to displayAllEntries():" + e);
+        }
+        return output.toString();
+    }
 }

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

@@ -1 +1 @@
 /*
- *    GSXML.java
- *    Copyright (C) 2008 New Zealand Digital Library, http://www.nzdl.org
- *
- *    This program is free software; you can redistribute it and/or modify
- *    it under the terms of the GNU General Public License as published by
- *    the Free Software Foundation; either version 2 of the License, or
- *    (at your option) any later version.
- *
- *    This program is distributed in the hope that it will be useful,
- *    but WITHOUT ANY WARRANTY; without even the implied warranty of
- *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *    GNU General Public License for more details.
- *
- *    You should have received a copy of the GNU General Public License
- *    along with this program; if not, write to the Free Software
- *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
+*    GSXML.java
+*    Copyright (C) 2008 New Zealand Digital Library, http://www.nzdl.org
+*
+*    This program is free software; you can redistribute it and/or modify
+*    it under the terms of the GNU General Public License as published by
+*    the Free Software Foundation; either version 2 of the License, or
+*    (at your option) any later version.
+*
+*    This program is distributed in the hope that it will be useful,
+*    but WITHOUT ANY WARRANTY; without even the implied warranty of
+*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*    GNU General Public License for more details.
+*
+*    You should have received a copy of the GNU General Public License
+*    along with this program; if not, write to the Free Software
+*    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
 package org.greenstone.gsdl3.util;
 
@@ -26 +26 @@
 import org.w3c.dom.Text;
 
-
 import javax.xml.transform.TransformerFactory;
 import javax.xml.transform.Transformer;
@@ -46 +45 @@
 /** various functions for extracting info out of GS XML */
 public class GSXML {
-  
-  static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.GSXML.class.getName());
-  
-  // greenstone xml elements
-  public static final String MESSAGE_ELEM = "message";
-  public static final String REQUEST_ELEM = "request";
-  public static final String RESPONSE_ELEM = "response";
-  public static final String COLLECTION_ELEM = "collection";
-  public static final String SERVICE_ELEM = "service";
-  public static final String CLUSTER_ELEM = "serviceCluster";
-  public static final String SITE_ELEM = "site";
-  public static final String PARAM_ELEM = "param";
-  public static final String PARAM_OPTION_ELEM = "option";
-  public static final String CONTENT_ELEM = "content";
-  public static final String RESOURCE_ELEM = "resource";
-  public static final String DOCUMENT_ELEM = "document";
-  public static final String METADATA_ELEM = "metadata";
-  public static final String SERVICE_CLASS_ELEM = "serviceRack";
-  public static final String CLASSIFIER_ELEM = "classifier";
-  public static final String APPLET_ELEM = "applet";
-  public static final String APPLET_DATA_ELEM = "appletData";
-  public static final String CONFIGURE_ELEM = "configure";
-  public static final String STATUS_ELEM = "status";
-  public static final String ERROR_ELEM = "error";
-  public static final String DEFAULT_ELEM = "default";
-  public static final String STYLESHEET_ELEM = "format";//"stylesheet"; // any additional stylesheet stuff is carried in the message inside this elem
-  public static final String FORMAT_ELEM = "format"; // config files use format - should we use this instead of stylesheet??
-  public static final String TERM_ELEM = "term";
-  public static final String STOPWORD_ELEM = "stopword";
-  public static final String SYSTEM_ELEM = "system";
-  public static final String FORMAT_STRING_ELEM = "formatString";
-  
-  //config file elems
-  public static final String COLLECTION_CONFIG_ELEM = "collectionConfig";
-  public static final String COLLECTION_BUILD_ELEM = "buildConfig";
-  public static final String COLLECTION_INIT_ELEM = "collectionInit";
-  public static final String RECOGNISE_ELEM = "recognise";
-  public static final String DOC_TYPE_ELEM = "docType";
-  public static final String SEARCH_ELEM = "search";
-  public static final String INFODB_ELEM = "infodb";
-  public static final String INDEX_ELEM = "index";
-  public static final String INDEX_STEM_ELEM = "indexStem";
-  public static final String INDEX_OPTION_ELEM = "indexOption";
-  public static final String BROWSE_ELEM = "browse";
-  public static final String DISPLAY_ELEM = "display";
-  public static final String LEVEL_ELEM = "level";
-
-  public static final String DBINFO_ELEM = "dbInfo";
-  public static final String DBNAME_ATT = "dbname";  
-  public static final String DBPATH_ATT = "dbpath";
-  public static final String SQLSTATE_ATT = "sqlstate";
-  public static final String DATABASE_TYPE_ELEM = "databaseType";
-  public static final String SHORTNAME_ATT = "shortname";
-  public static final String NOTIFY_ELEM = "notify";
-  public static final String NOTIFY_HOST_ATT = "host";
-
-   
-
-  // elems for the pages to be processed by xslt
-  public final static String PAGE_ELEM = "page";
-  public final static String CONFIGURATION_ELEM = "config";
-  public final static String PAGE_REQUEST_ELEM = "pageRequest";
-  public final static String PAGE_RESPONSE_ELEM = "pageResponse";
-  public final static String PAGE_EXTRA_ELEM = "pageExtra";
-  
-  //public final static String DESCRIPTION_ELEM = "description";
-  
-  public static final String  ACTION_ELEM = "action";
-  public static final String  SUBACTION_ELEM = "subaction";
-  
-  // add on to another elem type to get a list of that type
-  public static final String LIST_MODIFIER = "List";
-  
-  // greenstone xml attributes
-  public static final String NAME_ATT = "name";
-  public static final String TO_ATT = "to";
-  public static final String USER_ID_ATT = "uid";
-  public static final String FROM_ATT = "from";
-  public static final String LANG_ATT = "lang";
-  public static final String TYPE_ATT = "type";
-  public static final String DB_TYPE_ATT = "dbType";
-  public static final String VALUE_ATT = "value";
-  public static final String DEFAULT_ATT = "default";
-  public static final String INFO_ATT = "info";
-  public static final String ACTION_ATT = "action";
-  public static final String SUBACTION_ATT = "subaction";
-  public static final String OUTPUT_ATT = "output";
-  public static final String ADDRESS_ATT = "address";
-  public static final String LOCAL_SITE_ATT = "localSite";
-  public static final String LOCAL_SITE_NAME_ATT = "localSiteName";
-  public static final String STATUS_ERROR_CODE_ATT = "code";
-  public static final String STATUS_PROCESS_ID_ATT = "pid";
-  public static final String PARAM_SHORTNAME_ATT = "shortname";
-  public static final String PARAM_IGNORE_POS_ATT = "ignore";
-  public static final String CLASSIFIER_CONTENT_ATT = "content";
-  public static final String ERROR_TYPE_ATT = "type";
-  public static final String COLLECT_TYPE_ATT = "ct";
-  public static final String HIDDEN_ATT = "hidden";
-  
-  // document stuff
-  public static final String DOC_TYPE_ATT = "docType";
-  public static final String DOC_NODE_ELEM = "documentNode";
-  public static final String NODE_CONTENT_ELEM = "nodeContent";
-  public static final String NODE_STRUCTURE_ELEM = "nodeStructure";
-  public static final String NODE_ID_ATT = "nodeID";
-  public static final String NODE_NAME_ATT = "nodeName";
-  public static final String NODE_TYPE_ATT = "nodeType";
-  public static final String NODE_RANK_ATT = "rank";
-  public static final String NODE_TYPE_ROOT = "root";
-  public static final String NODE_TYPE_INTERNAL = "internal";
-  public static final String NODE_TYPE_LEAF = "leaf";
-  public static final String NODE_MDOFFSET_ATT = "mdoffset";
-  
-  public static final String DOC_TYPE_SIMPLE = "simple";
-  public static final String DOC_TYPE_PAGED = "paged";
-  public static final String DOC_TYPE_HIERARCHY = "hierarchy";
-
-  public static final String SESSION_EXPIRATION = "session_expiration";
-  public static final String USER_SESSION_CACHE_ATT = "user_session_cache";
-
-  // classifier stuff
-  public static final String CLASS_NODE_ELEM = "classifierNode";
-  public static final String CLASS_NODE_ORIENTATION_ATT = "orientation";
-  
-  // parameter types
-  public static final String PARAM_TYPE_INTEGER = "integer";
-  public static final String PARAM_TYPE_BOOLEAN = "boolean";
-  public static final String PARAM_TYPE_ENUM_START = "enum";
-  public static final String PARAM_TYPE_ENUM_SINGLE = "enum_single";
-  public static final String PARAM_TYPE_ENUM_MULTI = "enum_multi";
-  public static final String PARAM_TYPE_STRING = "string";
-  public static final String PARAM_TYPE_TEXT = "text";
-  public static final String PARAM_TYPE_MULTI = "multi";
-  public static final String PARAM_TYPE_FILE = "file";
-  public static final String PARAM_TYPE_INVISIBLE = "invisible";
-  // stuff for text strings
-  public static final String DISPLAY_TEXT_ELEM = "displayItem";
-  // the following are used for the name attributes
-  public static final String DISPLAY_TEXT_NAME = "name";
-  public static final String DISPLAY_TEXT_SUBMIT = "submit";
-  public static final String DISPLAY_TEXT_DESCRIPTION = "description";
-  
-  // request types
-  // get the module description
-  public static final String REQUEST_TYPE_DESCRIBE = "describe";
-  // startup a process
-  public static final String REQUEST_TYPE_PROCESS = "process";
-  // get the status of an ongoing process
-  public static final String REQUEST_TYPE_STATUS = "status";
-  // system type request - eg reload a collection
-  public static final String REQUEST_TYPE_SYSTEM = "system";
-  // page requests to the Receptionist/Actions
-  public static final String REQUEST_TYPE_PAGE = "page"; // used to be cgi
-  // get any format info for a service
-  public static final String REQUEST_TYPE_FORMAT = "format";
-  // modify the requests
-  public static final String REQUEST_TYPE_MESSAGING = "messaging";
-  // save the format string
-  public static final String REQUEST_TYPE_FORMAT_STRING = "formatString";
-  
-  // service types
-  public static final String SERVICE_TYPE_QUERY = "query";
-  public static final String SERVICE_TYPE_RETRIEVE = "retrieve";
-  public static final String SERVICE_TYPE_BROWSE = "browse";
-  public static final String SERVICE_TYPE_APPLET = "applet";
-  public static final String SERVICE_TYPE_PROCESS = "process";
-  public static final String SERVICE_TYPE_ENRICH = "enrich";
-  public static final String SERVICE_TYPE_OAI = "oai";
-  public static final String FLAX_PAGE = "flaxPage";
-  public static final String FLAX_PAGE_GENERATION = "FlaxPageGeneration";  
-  
-  // system command types and attributes
-  public static final String SYSTEM_TYPE_CONFIGURE = "configure";
-  public static final String SYSTEM_TYPE_ACTIVATE = "activate";
-  public static final String SYSTEM_TYPE_DEACTIVATE = "deactivate";
-  
-  public static final String SYSTEM_SUBSET_ATT = "subset";
-  public static final String SYSTEM_MODULE_TYPE_ATT = "moduleType";
-  public static final String SYSTEM_MODULE_NAME_ATT = "moduleName";
-  
-  // communicator types
-  public static final String COMM_TYPE_SOAP_JAVA = "soap";
-  
-  // error types
-  public static final String ERROR_TYPE_SYNTAX = "syntax";
-  public static final String ERROR_TYPE_SYSTEM = "system";
-  public static final String ERROR_TYPE_INVALID_ID = "invalid_id";
-  public static final String ERROR_TYPE_OTHER = "other";
-  
-  // some system wide param names
-  public static final String SUBSET_PARAM = "subset";
-  
-  //for plugin
-  public static final String PLUGIN_ELEM = "plugin";
-  public static final String IMPORT_ELEM = "import";
-  
-  //for authentication
-   public static final String AUTHEN_NODE_ELEM="authenticationNode";
-   public static final String USER_NODE_ELEM="userNode";
-
-   //for configure action results
-   public static final String SUCCESS = "success";
-   public static final String ERROR = "error";
-   
-  /** takes a list of elements, and returns an array of strings
-   * of the values of attribute att_name */
-  public static String [] getAttributeValuesFromList(Element list,
-    String att_name) {
-    
-    NodeList children = list.getChildNodes();
-    
-    int num_nodes = children.getLength();
-    String []ids = new String[num_nodes];
-    for (int i=0; i<num_nodes; i++) {
-      Element e = (Element)children.item(i);
-      String id = e.getAttribute(att_name);
-      ids[i] = id;
-    }
-    
-    return ids;
-  }
-  
-  public static HashMap extractParams(Element xml, boolean deep) {
-    return extractParams(xml, deep, null);
-  }
-
-  /** takes a paramList element, and gets a HashMap of name-value pairs
-   * if deep=true, extracts embedded params, otherwise just top level
-   * params*/
-  public static HashMap extractParams(Element xml, boolean deep, String toFind) {
-    
-    if (!xml.getNodeName().equals(PARAM_ELEM+LIST_MODIFIER)) {
-      logger.error("paramList element should have been passed to extractParams, instead it was "+xml.getNodeName());
-      return null;
-    }
-    
-    NodeList params = null;
-    if (deep) { // get all the nested ones
-      params = xml.getElementsByTagName(PARAM_ELEM);
-    } else { // just get the top  level ones
-      params = xml.getChildNodes();
-    }
-    HashMap param_map = new HashMap();
-    for (int i=0; i<params.getLength(); i++) {
-      if (params.item(i).getNodeName().equals(PARAM_ELEM)) {
-        Element param = (Element)params.item(i);
-        String name=param.getAttribute(NAME_ATT);
-        String value=getValue(param); //att or content
-
-    // For only one parameter
-    if(toFind != null && name.equals(toFind)) {
-        param_map.put(name, value);
+
+    static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.GSXML.class.getName());
+
+    // greenstone xml elements
+    public static final String MESSAGE_ELEM = "message";
+    public static final String REQUEST_ELEM = "request";
+    public static final String RESPONSE_ELEM = "response";
+    public static final String COLLECTION_ELEM = "collection";
+    public static final String SERVICE_ELEM = "service";
+    public static final String CLUSTER_ELEM = "serviceCluster";
+    public static final String SITE_ELEM = "site";
+    public static final String PARAM_ELEM = "param";
+    public static final String PARAM_OPTION_ELEM = "option";
+    public static final String CONTENT_ELEM = "content";
+    public static final String RESOURCE_ELEM = "resource";
+    public static final String DOCUMENT_ELEM = "document";
+    public static final String METADATA_ELEM = "metadata";
+    public static final String SERVICE_CLASS_ELEM = "serviceRack";
+    public static final String CLASSIFIER_ELEM = "classifier";
+    public static final String APPLET_ELEM = "applet";
+    public static final String APPLET_DATA_ELEM = "appletData";
+    public static final String CONFIGURE_ELEM = "configure";
+    public static final String STATUS_ELEM = "status";
+    public static final String ERROR_ELEM = "error";
+    public static final String DEFAULT_ELEM = "default";
+    public static final String STYLESHEET_ELEM = "format";//"stylesheet"; // any additional stylesheet stuff is carried in the message inside this elem
+    public static final String FORMAT_ELEM = "format"; // config files use format - should we use this instead of stylesheet??
+    public static final String TERM_ELEM = "term";
+    public static final String STOPWORD_ELEM = "stopword";
+    public static final String SYSTEM_ELEM = "system";
+    public static final String FORMAT_STRING_ELEM = "formatString";
+
+    //config file elems
+    public static final String COLLECTION_CONFIG_ELEM = "collectionConfig";
+    public static final String COLLECTION_BUILD_ELEM = "buildConfig";
+    public static final String COLLECTION_INIT_ELEM = "collectionInit";
+    public static final String RECOGNISE_ELEM = "recognise";
+    public static final String DOC_TYPE_ELEM = "docType";
+    public static final String SEARCH_ELEM = "search";
+    public static final String INFODB_ELEM = "infodb";
+    public static final String INDEX_ELEM = "index";
+    public static final String INDEX_STEM_ELEM = "indexStem";
+    public static final String INDEX_OPTION_ELEM = "indexOption";
+    public static final String BROWSE_ELEM = "browse";
+    public static final String DISPLAY_ELEM = "display";
+    public static final String LEVEL_ELEM = "level";
+
+    public static final String DBINFO_ELEM = "dbInfo";
+    public static final String DBNAME_ATT = "dbname";  
+    public static final String DBPATH_ATT = "dbpath";
+    public static final String SQLSTATE_ATT = "sqlstate";
+    public static final String DATABASE_TYPE_ELEM = "databaseType";
+    public static final String SHORTNAME_ATT = "shortname";
+    public static final String NOTIFY_ELEM = "notify";
+    public static final String NOTIFY_HOST_ATT = "host";
+    
+    //doc.xml file elems
+    public static final String DOCXML_SECTION_ELEM = "Section";
+    public static final String DOCXML_DESCRIPTION_ELEM = "Description";
+    public static final String DOCXML_METADATA_ELEM = "Metadata";
+    public static final String DOCXML_CONTENT_ELEM = "Content";
+
+    // elems for the pages to be processed by xslt
+    public final static String PAGE_ELEM = "page";
+    public final static String CONFIGURATION_ELEM = "config";
+    public final static String PAGE_REQUEST_ELEM = "pageRequest";
+    public final static String PAGE_RESPONSE_ELEM = "pageResponse";
+    public final static String PAGE_EXTRA_ELEM = "pageExtra";
+
+    //public final static String DESCRIPTION_ELEM = "description";
+
+    public static final String  ACTION_ELEM = "action";
+    public static final String  SUBACTION_ELEM = "subaction";
+
+    // add on to another elem type to get a list of that type
+    public static final String LIST_MODIFIER = "List";
+
+    // greenstone xml attributes
+    public static final String COLLECTION_ATT = "collection";
+    public static final String NAME_ATT = "name";
+    public static final String TO_ATT = "to";
+    public static final String USER_ID_ATT = "uid";
+    public static final String FROM_ATT = "from";
+    public static final String LANG_ATT = "lang";
+    public static final String TYPE_ATT = "type";
+    public static final String DB_TYPE_ATT = "dbType";
+    public static final String VALUE_ATT = "value";
+    public static final String DEFAULT_ATT = "default";
+    public static final String INFO_ATT = "info";
+    public static final String ACTION_ATT = "action";
+    public static final String SUBACTION_ATT = "subaction";
+    public static final String OUTPUT_ATT = "output";
+    public static final String ADDRESS_ATT = "address";
+    public static final String LOCAL_SITE_ATT = "localSite";
+    public static final String LOCAL_SITE_NAME_ATT = "localSiteName";
+    public static final String STATUS_ERROR_CODE_ATT = "code";
+    public static final String STATUS_PROCESS_ID_ATT = "pid";
+    public static final String PARAM_SHORTNAME_ATT = "shortname";
+    public static final String PARAM_IGNORE_POS_ATT = "ignore";
+    public static final String CLASSIFIER_CONTENT_ATT = "content";
+    public static final String ERROR_TYPE_ATT = "type";
+    public static final String COLLECT_TYPE_ATT = "ct";
+    public static final String HIDDEN_ATT = "hidden";
+
+    // document stuff
+    public static final String DOC_TYPE_ATT = "docType";
+    public static final String DOC_NODE_ELEM = "documentNode";
+    public static final String NODE_CONTENT_ELEM = "nodeContent";
+    public static final String NODE_STRUCTURE_ELEM = "nodeStructure";
+    public static final String NODE_ID_ATT = "nodeID";
+    public static final String NODE_NAME_ATT = "nodeName";
+    public static final String NODE_TYPE_ATT = "nodeType";
+    public static final String NODE_RANK_ATT = "rank";
+    public static final String NODE_TYPE_ROOT = "root";
+    public static final String NODE_TYPE_INTERNAL = "internal";
+    public static final String NODE_TYPE_LEAF = "leaf";
+
+    public static final String DOC_TYPE_SIMPLE = "simple";
+    public static final String DOC_TYPE_PAGED = "paged";
+    public static final String DOC_TYPE_HIERARCHY = "hierarchy";
+
+    public static final String SESSION_EXPIRATION = "session_expiration";
+    public static final String USER_SESSION_CACHE_ATT = "user_session_cache";
+
+    // classifier stuff
+    public static final String CLASS_NODE_ELEM = "classifierNode";
+    public static final String CLASS_NODE_ORIENTATION_ATT = "orientation";
+
+    // parameter types
+    public static final String PARAM_TYPE_INTEGER = "integer";
+    public static final String PARAM_TYPE_BOOLEAN = "boolean";
+    public static final String PARAM_TYPE_ENUM_START = "enum";
+    public static final String PARAM_TYPE_ENUM_SINGLE = "enum_single";
+    public static final String PARAM_TYPE_ENUM_MULTI = "enum_multi";
+    public static final String PARAM_TYPE_STRING = "string";
+    public static final String PARAM_TYPE_TEXT = "text";
+    public static final String PARAM_TYPE_MULTI = "multi";
+    public static final String PARAM_TYPE_FILE = "file";
+    public static final String PARAM_TYPE_INVISIBLE = "invisible";
+    // stuff for text strings
+    public static final String DISPLAY_TEXT_ELEM = "displayItem";
+    // the following are used for the name attributes
+    public static final String DISPLAY_TEXT_NAME = "name";
+    public static final String DISPLAY_TEXT_SUBMIT = "submit";
+    public static final String DISPLAY_TEXT_DESCRIPTION = "description";
+
+    // request types
+    // get the module description
+    public static final String REQUEST_TYPE_DESCRIBE = "describe";
+    // startup a process
+    public static final String REQUEST_TYPE_PROCESS = "process";
+    // get the status of an ongoing process
+    public static final String REQUEST_TYPE_STATUS = "status";
+    // system type request - eg reload a collection
+    public static final String REQUEST_TYPE_SYSTEM = "system";
+    // page requests to the Receptionist/Actions
+    public static final String REQUEST_TYPE_PAGE = "page"; // used to be cgi
+    // get any format info for a service
+    public static final String REQUEST_TYPE_FORMAT = "format";
+    // modify the requests
+    public static final String REQUEST_TYPE_MESSAGING = "messaging";
+    // save the format string
+    public static final String REQUEST_TYPE_FORMAT_STRING = "formatString";
+
+    // service types
+    public static final String SERVICE_TYPE_QUERY = "query";
+    public static final String SERVICE_TYPE_RETRIEVE = "retrieve";
+    public static final String SERVICE_TYPE_BROWSE = "browse";
+    public static final String SERVICE_TYPE_APPLET = "applet";
+    public static final String SERVICE_TYPE_PROCESS = "process";
+    public static final String SERVICE_TYPE_ENRICH = "enrich";
+    public static final String SERVICE_TYPE_OAI = "oai";
+    public static final String FLAX_PAGE = "flaxPage";
+    public static final String FLAX_PAGE_GENERATION = "FlaxPageGeneration";  
+
+    // system command types and attributes
+    public static final String SYSTEM_TYPE_CONFIGURE = "configure";
+    public static final String SYSTEM_TYPE_ACTIVATE = "activate";
+    public static final String SYSTEM_TYPE_DEACTIVATE = "deactivate";
+
+    public static final String SYSTEM_SUBSET_ATT = "subset";
+    public static final String SYSTEM_MODULE_TYPE_ATT = "moduleType";
+    public static final String SYSTEM_MODULE_NAME_ATT = "moduleName";
+
+    // communicator types
+    public static final String COMM_TYPE_SOAP_JAVA = "soap";
+
+    // error types
+    public static final String ERROR_TYPE_SYNTAX = "syntax";
+    public static final String ERROR_TYPE_SYSTEM = "system";
+    public static final String ERROR_TYPE_INVALID_ID = "invalid_id";
+    public static final String ERROR_TYPE_OTHER = "other";
+
+    // some system wide param names
+    public static final String SUBSET_PARAM = "subset";
+
+    //for plugin
+    public static final String PLUGIN_ELEM = "plugin";
+    public static final String IMPORT_ELEM = "import";
+
+    //for authentication
+    public static final String AUTHEN_NODE_ELEM="authenticationNode";
+    public static final String USER_NODE_ELEM="userNode";
+
+    //for configure action results
+    public static final String SUCCESS = "success";
+    public static final String ERROR = "error";
+
+    /** takes a list of elements, and returns an array of strings
+* of the values of attribute att_name */
+    public static String [] getAttributeValuesFromList(Element list,
+    String att_name) {
+        
+        NodeList children = list.getChildNodes();
+        
+        int num_nodes = children.getLength();
+        String []ids = new String[num_nodes];
+        for (int i=0; i<num_nodes; i++) {
+            Element e = (Element)children.item(i);
+            String id = e.getAttribute(att_name);
+            ids[i] = id;
+        }
+        
+        return ids;
+    }
+
+    public static HashMap extractParams(Element xml, boolean deep) {
+        return extractParams(xml, deep, null);
+    }
+
+    /** takes a paramList element, and gets a HashMap of name-value pairs
+* if deep=true, extracts embedded params, otherwise just top level
+* params*/
+    public static HashMap extractParams(Element xml, boolean deep, String toFind) {
+        
+        if (!xml.getNodeName().equals(PARAM_ELEM+LIST_MODIFIER)) {
+            logger.error("paramList element should have been passed to extractParams, instead it was "+xml.getNodeName());
+            return null;
+        }
+        
+        NodeList params = null;
+        if (deep) { // get all the nested ones
+            params = xml.getElementsByTagName(PARAM_ELEM);
+        } else { // just get the top  level ones
+            params = xml.getChildNodes();
+        }
+        HashMap param_map = new HashMap();
+        for (int i=0; i<params.getLength(); i++) {
+            if (params.item(i).getNodeName().equals(PARAM_ELEM)) {
+                Element param = (Element)params.item(i);
+                String name=param.getAttribute(NAME_ATT);
+                String value=getValue(param); //att or content
+
+                // For only one parameter
+                if(toFind != null && name.equals(toFind)) {
+                    param_map.put(name, value);
+                    return param_map;
+                }       
+                else if(toFind != null)
+                continue;
+
+                int pos = name.indexOf('.');
+                if (pos == -1) { // a base param
+                    param_map.put(name, value);
+                } else { // a namespaced param
+                    
+                    String namespace = name.substring(0, pos);
+                    name = name.substring(pos+1);
+                    HashMap map = (HashMap)param_map.get(namespace);
+                    if (map == null) {
+                        map = new HashMap();
+                        param_map.put(namespace, map);
+                    }
+                    map.put(name, value);
+                }
+            }
+        }
         return param_map;
-    }       
-    else if(toFind != null)
-        continue;
-
-        int pos = name.indexOf('.');
-        if (pos == -1) { // a base param
-          param_map.put(name, value);
-        } else { // a namespaced param
-          
-          String namespace = name.substring(0, pos);
-          name = name.substring(pos+1);
-          HashMap map = (HashMap)param_map.get(namespace);
-          if (map == null) {
-            map = new HashMap();
-            param_map.put(namespace, map);
-          }
-          map.put(name, value);
-        }
-      }
-    }
-    return param_map;
-  }
-  
-  /** gets the value att or the text content */
-  public static String getValue(Element e) {
-    String val = e.getAttribute(VALUE_ATT);
-    if (val ==null || val.equals("")) {
-      // have to get it out of the text
-      val=getNodeText(e);
-      
-    } else {
-      // unescape the xml stuff
-      val = unXmlSafe(val);
-    }
-    return val;
-  }
-  
-  /** extracts the text out of a node */
-  public static Node getNodeTextNode(Element param) {
-    param.normalize();
-    Node n = param.getFirstChild();
-    while (n!=null && n.getNodeType() !=Node.TEXT_NODE) {
-      n=n.getNextSibling();
-    }
-    return n;
-  }
-  
-  /** extracts the text out of a node */
-  public static String getNodeText(Element param) {
-    Node text_node = getNodeTextNode(param);
-    if (text_node == null) {
-      return "";
-    }
-    return text_node.getNodeValue();
-  }
-  
-  public static void setNodeText(Element elem, String text) {
-    Node old_text_node = getNodeTextNode(elem);
-    if (old_text_node != null) {
-      elem.removeChild(old_text_node);
-    }
-    Text t = elem.getOwnerDocument().createTextNode(text);
-    elem.appendChild(t);
-  }
-  
-  /** add text to a document/subsection  element */
-  public static boolean addDocText(Document owner, Element doc, String text) {
-    
-    Element content = owner.createElement(NODE_CONTENT_ELEM);
-    Text t = owner.createTextNode(text);
-    content.appendChild(t);
-    doc.appendChild(content);
-    return true;
-  }
-  
-  /** add an error message, unknown error type */
-  public static boolean addError(Document owner, Element doc, String text) {
-    return addError(owner, doc, text, ERROR_TYPE_OTHER);
-  }
-  /** add an error message */
-  public static boolean addError(Document owner, Element doc, String text,
-    String error_type) {
-    
-    Element content = owner.createElement(ERROR_ELEM);
-    content.setAttribute(ERROR_TYPE_ATT, error_type);
-    Text t = owner.createTextNode(text);
-    content.appendChild(t);
-    doc.appendChild(content);
-    return true;
-  }
-  
-  /** add an error message */
-  public static boolean addError(Document owner, Element doc, Throwable error) {
-    return addError(owner, doc, error, ERROR_TYPE_OTHER);
-  }
-  
-  /** add an error message */
-  public static boolean addError(Document owner, Element doc,
-    Throwable error, String error_type) {
-    error.printStackTrace();
-    return addError(owner, doc, error.toString(), error_type);
-  }
-  
-  public static Element createMetadataParamList(Document owner, Vector meta_values) {
-    
-    Element meta_param_list = owner.createElement(PARAM_ELEM+LIST_MODIFIER);
-    Iterator i = meta_values.iterator();
-    while(i.hasNext()) {
-      String next = (String)i.next();
-      Element meta_param = owner.createElement(PARAM_ELEM);
-      meta_param_list.appendChild(meta_param);
-      meta_param.setAttribute(NAME_ATT, "metadata");
-      meta_param.setAttribute(VALUE_ATT, next);
-    }
-    return meta_param_list;
-  }
-  
-  /** adds a metadata elem to a list */
-  public static boolean addMetadata(Document owner, Element list,
-    String meta_name, String meta_value) {
-    if (meta_value==null || meta_value.equals("")) {
-      return false;
-    }
-    Element data = owner.createElement(METADATA_ELEM);
-    data.setAttribute(NAME_ATT, meta_name);
-    Text t = owner.createTextNode(meta_value);
-    data.appendChild(t);
-    list.appendChild(data);
-    return true;
-    
-  }
-  
-  /** copies the metadata out of the metadataList of 'from' into
-   * the metadataList of 'to' */
-  public static boolean mergeMetadataLists(Node to, Node from) {
-    Node from_meta = getChildByTagName(from, METADATA_ELEM+LIST_MODIFIER);
-    if  (from_meta == null) { // nothing to copy
-      return true;
-    }
-    return mergeMetadataFromList(to, from_meta);
-  }
-  
-
-  /** copies the metadata out of the meta_list metadataList  into
-   * the metadataList of 'to' */
-  public static boolean mergeMetadataFromList(Node to, Node meta_list) {
-    if (meta_list == null) return false;
-    Node to_meta = getChildByTagName(to, METADATA_ELEM+LIST_MODIFIER);
-    Document to_owner = to.getOwnerDocument();
-    if (to_meta == null) {
-      to.appendChild(to_owner.importNode(meta_list, true));
-      return true;
-    }
-    // copy individual metadata elements
-    NodeList meta_items = ((Element)meta_list).getElementsByTagName(METADATA_ELEM);
-    for (int i=0; i<meta_items.getLength(); i++) {
-      to_meta.appendChild(to_owner.importNode(meta_items.item(i),true));
-    }
-    return true;
-  }
-  
-  /** copies all the children from from to to */
-  public static boolean mergeElements(Element to, Element from) {
-    
-    Document owner = to.getOwnerDocument();
-    Node child = from.getFirstChild();
-    while (child != null) {
-      to.appendChild(owner.importNode(child, true));
-      child = child.getNextSibling();
-    }
-    return true;
-  }
-  /** returns the (first) element child of the node n */
-  public static Element getFirstElementChild(Node n) {
-    
-    Node child = n.getFirstChild();
-    while (child!=null) {
-      if (child.getNodeType() == Node.ELEMENT_NODE) {
-        return (Element)child;
-      }
-      child = child.getNextSibling();
-    }
-    return null; //no element child found
-  }
-  /** returns the (first) child element with the given name */
-  public static Node getChildByTagName(Node n, String name) {
-      if(n != null) { // this line is an attempted solution to the NullPointerException mentioned 
-      // in trac bug ticket #225. If n is null can't do n.getFirstChild() below. As per bug #225: 
-      // GSXML.getNodeByPath() is called by GS2BrowseAction, which then calls this method.
-      // If n is null, null will be returned which GS2BrowseAction already checks for. It's here
-      // that the NullPointerException was thrown.
- 
-      Node child = n.getFirstChild();
-      while (child!=null) {
-          if (child.getNodeName().equals(name)) {
-          return child;
-          }
-          child = child.getNextSibling();
-      }
-      }
-      return null; //not found
-  }
-  
-  /** returns the (nth) child element with the given name
-   * index numbers start at 0 */
-  public static Node getChildByTagNameIndexed(Node n, String name, int index) {
-    if (index == -1) {
-      return getChildByTagName(n, name);
-    }
-    int count = 0;
-    Node child = n.getFirstChild();
-    while (child!=null) {
-      if (child.getNodeName().equals(name)) {
-        if (count == index) {
-          return child;
-        } else {
-          count++;
-        }
-      }
-      child = child.getNextSibling();
-    }
-    return null; //not found
-  }
-  
-  /** takes an xpath type expression of the form name/name/...
-   * and returns the first node that matches, or null if not found */
-  public static Node getNodeByPath(Node n, String path) {
-    
-    String link = GSPath.getFirstLink(path);
-    path = GSPath.removeFirstLink(path);
-    while (!link.equals("")) {
-      n = getChildByTagName(n, link);
-      if (n==null) {
-        return null;
-      }
-      link = GSPath.getFirstLink(path);
-      path = GSPath.removeFirstLink(path);
-    }
-    return n;
-  }
-  
-  /** takes an xpath type expression of the form name/name/...
-   * and returns the first node that matches, or null if not found
-   * can include [i] indices. index numbers start at 0 */
-  public static Node getNodeByPathIndexed(Node n, String path) {
-    
-    String link = GSPath.getFirstLink(path);
-    int index = GSPath.getIndex(link);
-    if (index != -1) {
-      link = GSPath.removeIndex(link);
-    }
-    path = GSPath.removeFirstLink(path);
-    while (!link.equals("")) {
-      n = getChildByTagNameIndexed(n, link, index);
-      if (n==null) {
-        return null;
-      }
-      link = GSPath.getFirstLink(path);
-      index = GSPath.getIndex(link);
-      if (index != -1) {
-        link = GSPath.removeIndex(link);
-      }
-      path = GSPath.removeFirstLink(path);
-    }
-    return n;
-  }
-  
-  public static HashMap getChildrenMap(Node n) {
-    
-    HashMap map= new HashMap();
-    Node child = n.getFirstChild();
-    while (child!=null) {
-      String name = child.getNodeName();
-      map.put(name, child);
-      child = child.getNextSibling();
-    }
-    return map;
-  }
-  
-  public static NodeList getChildrenByTagName(Node n, String name) {
-    MyNodeList node_list = new MyNodeList();
-    Node child = n.getFirstChild();
-    while (child!=null) {
-      if (child.getNodeName().equals(name)) {
-        node_list.addNode(child);
-      }
-      child = child.getNextSibling();
-    }
-    return node_list;
-  }
-  
-  
-  /** Duplicates an element, but gives it a new name */
-  public static Element duplicateWithNewName(Document owner, Element element,
-    String element_name, boolean with_attributes) {
-    return duplicateWithNewNameNS(owner, element, element_name, null, with_attributes);
-  }
-  
-  /** Duplicates an element, but gives it a new name */
-  public static Element duplicateWithNewNameNS(Document owner,
-    Element element,
-    String element_name,
-    String namespace_uri,
-    boolean with_attributes) {
-    Element duplicate;
-    if (namespace_uri == null) {
-      duplicate = owner.createElement(element_name);
-    } else {
-      duplicate = owner.createElementNS(namespace_uri, element_name);
-    }
-    // Copy element attributes
-    if (with_attributes) {
-      NamedNodeMap attributes = element.getAttributes();
-      for (int i = 0; i < attributes.getLength(); i++) {
-        Node attribute = attributes.item(i);
-        duplicate.setAttribute(attribute.getNodeName(), attribute.getNodeValue());
-      }
-    }
-    
-    // Copy element children
-    NodeList children = element.getChildNodes();
-    for (int i = 0; i < children.getLength(); i++) {
-      Node child = children.item(i);
-      duplicate.appendChild(owner.importNode(child, true));
-    }
-    
-    return duplicate;
-  }
-  
-  public static void copyAllChildren(Element to, Element from) {
-    
-    Document to_doc = to.getOwnerDocument();
-    Node child = from.getFirstChild();
-    while (child != null) {
-      to.appendChild(to_doc.importNode(child, true));
-      child = child.getNextSibling();
-    }
-  }
-  /** returns a basic request message */
-  public static  Element createBasicRequest(Document owner,
-    String request_type, String to,
-    String lang,
-    String uid) {
-    Element request = owner.createElement(REQUEST_ELEM);
-    request.setAttribute(TYPE_ATT, request_type);
-    request.setAttribute(LANG_ATT, lang);
-    request.setAttribute(TO_ATT, to);
-    request.setAttribute(USER_ID_ATT, uid);
-    return request;
-  }
-  
-  public static Element createTextElement(Document owner, String elem_name,
-    String text) {
-    Element e = owner.createElement(elem_name);
-    Text t = owner.createTextNode(text);
-    e.appendChild(t);
-    return e;
-    
-  }
-  
-  public static Element createTextElement(Document owner, String elem_name,
-            String text, String att_name, String att_value) {
-            Element e = owner.createElement(elem_name);
-            e.setAttribute(att_name, att_value);
-            Text t = owner.createTextNode(text);
-            e.appendChild(t);
-            return e;
-            
-          }
-          
-  public static Element createDisplayTextElement(Document owner,
-    String text_name,
-    String text) {
-    Element e = owner.createElement(DISPLAY_TEXT_ELEM);
-    e.setAttribute(NAME_ATT, text_name);
-    Text t = owner.createTextNode(text);
-    e.appendChild(t);
-    return e;
-    
-  }
-  
-  
-  public static Element createParameter(Document owner, String name,
-    String value) {
-    Element param = owner.createElement(PARAM_ELEM);
-    param.setAttribute(NAME_ATT, name);
-    param.setAttribute(VALUE_ATT, value);
-    return param;
-  }
-  
-  public static void addParametersToList(Document owner, Element param_list,
-    HashMap params) {
-    if (params == null)
+    }
+
+    /** gets the value att or the text content */
+    public static String getValue(Element e) {
+        String val = e.getAttribute(VALUE_ATT);
+        if (val ==null || val.equals("")) {
+            // have to get it out of the text
+            val=getNodeText(e);
+            
+        } else {
+            // unescape the xml stuff
+            val = unXmlSafe(val);
+        }
+        return val;
+    }
+
+    /** extracts the text out of a node */
+    public static Node getNodeTextNode(Element param) {
+        param.normalize();
+        Node n = param.getFirstChild();
+        while (n!=null && n.getNodeType() !=Node.TEXT_NODE) {
+            n=n.getNextSibling();
+        }
+        return n;
+    }
+
+    /** extracts the text out of a node */
+    public static String getNodeText(Element param) {
+        Node text_node = getNodeTextNode(param);
+        if (text_node == null) {
+            return "";
+        }
+        return text_node.getNodeValue();
+    }
+
+    public static void setNodeText(Element elem, String text) {
+        Node old_text_node = getNodeTextNode(elem);
+        if (old_text_node != null) {
+            elem.removeChild(old_text_node);
+        }
+        Text t = elem.getOwnerDocument().createTextNode(text);
+        elem.appendChild(t);
+    }
+
+    /** add text to a document/subsection  element */
+    public static boolean addDocText(Document owner, Element doc, String text) {
+        
+        Element content = owner.createElement(NODE_CONTENT_ELEM);
+        Text t = owner.createTextNode(text);
+        content.appendChild(t);
+        doc.appendChild(content);
+        return true;
+    }
+
+    /** add an error message, unknown error type */
+    public static boolean addError(Document owner, Element doc, String text) {
+        return addError(owner, doc, text, ERROR_TYPE_OTHER);
+    }
+    /** add an error message */
+    public static boolean addError(Document owner, Element doc, String text,
+    String error_type) {
+        
+        Element content = owner.createElement(ERROR_ELEM);
+        content.setAttribute(ERROR_TYPE_ATT, error_type);
+        Text t = owner.createTextNode(text);
+        content.appendChild(t);
+        doc.appendChild(content);
+        return true;
+    }
+
+    /** add an error message */
+    public static boolean addError(Document owner, Element doc, Throwable error) {
+        return addError(owner, doc, error, ERROR_TYPE_OTHER);
+    }
+
+    /** add an error message */
+    public static boolean addError(Document owner, Element doc,
+    Throwable error, String error_type) {
+        error.printStackTrace();
+        return addError(owner, doc, error.toString(), error_type);
+    }
+
+    public static Element createMetadataParamList(Document owner, Vector meta_values) {
+        
+        Element meta_param_list = owner.createElement(PARAM_ELEM+LIST_MODIFIER);
+        Iterator i = meta_values.iterator();
+        while(i.hasNext()) {
+            String next = (String)i.next();
+            Element meta_param = owner.createElement(PARAM_ELEM);
+            meta_param_list.appendChild(meta_param);
+            meta_param.setAttribute(NAME_ATT, "metadata");
+            meta_param.setAttribute(VALUE_ATT, next);
+        }
+        return meta_param_list;
+    }
+
+    /** adds a metadata elem to a list */
+    public static boolean addMetadata(Document owner, Element list,
+    String meta_name, String meta_value) {
+        if (meta_value==null || meta_value.equals("")) {
+            return false;
+        }
+        Element data = owner.createElement(METADATA_ELEM);
+        data.setAttribute(NAME_ATT, meta_name);
+        Text t = owner.createTextNode(meta_value);
+        data.appendChild(t);
+        list.appendChild(data);
+        return true;
+        
+    }
+
+    /** copies the metadata out of the metadataList of 'from' into
+* the metadataList of 'to' */
+    public static boolean mergeMetadataLists(Node to, Node from) {
+        Node from_meta = getChildByTagName(from, METADATA_ELEM+LIST_MODIFIER);
+        if  (from_meta == null) { // nothing to copy
+            return true;
+        }
+        return mergeMetadataFromList(to, from_meta);
+    }
+
+
+    /** copies the metadata out of the meta_list metadataList  into
+* the metadataList of 'to' */
+    public static boolean mergeMetadataFromList(Node to, Node meta_list) {
+        if (meta_list == null) return false;
+        Node to_meta = getChildByTagName(to, METADATA_ELEM+LIST_MODIFIER);
+        Document to_owner = to.getOwnerDocument();
+        if (to_meta == null) {
+            to.appendChild(to_owner.importNode(meta_list, true));
+            return true;
+        }
+        // copy individual metadata elements
+        NodeList meta_items = ((Element)meta_list).getElementsByTagName(METADATA_ELEM);
+        for (int i=0; i<meta_items.getLength(); i++) {
+            to_meta.appendChild(to_owner.importNode(meta_items.item(i),true));
+        }
+        return true;
+    }
+
+    /** copies all the children from from to to */
+    public static boolean mergeElements(Element to, Element from) {
+        
+        Document owner = to.getOwnerDocument();
+        Node child = from.getFirstChild();
+        while (child != null) {
+            to.appendChild(owner.importNode(child, true));
+            child = child.getNextSibling();
+        }
+        return true;
+    }
+    /** returns the (first) element child of the node n */
+    public static Element getFirstElementChild(Node n) {
+        
+        Node child = n.getFirstChild();
+        while (child!=null) {
+            if (child.getNodeType() == Node.ELEMENT_NODE) {
+                return (Element)child;
+            }
+            child = child.getNextSibling();
+        }
+        return null; //no element child found
+    }
+    /** returns the (first) child element with the given name */
+    public static Node getChildByTagName(Node n, String name) {
+        if(n != null) { // this line is an attempted solution to the NullPointerException mentioned 
+            // in trac bug ticket #225. If n is null can't do n.getFirstChild() below. As per bug #225: 
+            // GSXML.getNodeByPath() is called by GS2BrowseAction, which then calls this method.
+            // If n is null, null will be returned which GS2BrowseAction already checks for. It's here
+            // that the NullPointerException was thrown.
+
+            Node child = n.getFirstChild();
+            while (child!=null) {
+                if (child.getNodeName().equals(name)) {
+                    return child;
+                }
+                child = child.getNextSibling();
+            }
+        }
+        return null; //not found
+    }
+
+    /** returns the (nth) child element with the given name
+* index numbers start at 0 */
+    public static Node getChildByTagNameIndexed(Node n, String name, int index) {
+        if (index == -1) {
+            return getChildByTagName(n, name);
+        }
+        int count = 0;
+        Node child = n.getFirstChild();
+        while (child!=null) {
+            if (child.getNodeName().equals(name)) {
+                if (count == index) {
+                    return child;
+                } else {
+                    count++;
+                }
+            }
+            child = child.getNextSibling();
+        }
+        return null; //not found
+    }
+
+    /** takes an xpath type expression of the form name/name/...
+* and returns the first node that matches, or null if not found */
+    public static Node getNodeByPath(Node n, String path) {
+        
+        String link = GSPath.getFirstLink(path);
+        path = GSPath.removeFirstLink(path);
+        while (!link.equals("")) {
+            n = getChildByTagName(n, link);
+            if (n==null) {
+                return null;
+            }
+            link = GSPath.getFirstLink(path);
+            path = GSPath.removeFirstLink(path);
+        }
+        return n;
+    }
+
+    /** takes an xpath type expression of the form name/name/...
+* and returns the first node that matches, or null if not found
+* can include [i] indices. index numbers start at 0 */
+    public static Node getNodeByPathIndexed(Node n, String path) {
+        
+        String link = GSPath.getFirstLink(path);
+        int index = GSPath.getIndex(link);
+        if (index != -1) {
+            link = GSPath.removeIndex(link);
+        }
+        path = GSPath.removeFirstLink(path);
+        while (!link.equals("")) {
+            n = getChildByTagNameIndexed(n, link, index);
+            if (n==null) {
+                return null;
+            }
+            link = GSPath.getFirstLink(path);
+            index = GSPath.getIndex(link);
+            if (index != -1) {
+                link = GSPath.removeIndex(link);
+            }
+            path = GSPath.removeFirstLink(path);
+        }
+        return n;
+    }
+
+    public static HashMap getChildrenMap(Node n) {
+        
+        HashMap map= new HashMap();
+        Node child = n.getFirstChild();
+        while (child!=null) {
+            String name = child.getNodeName();
+            map.put(name, child);
+            child = child.getNextSibling();
+        }
+        return map;
+    }
+
+    public static NodeList getChildrenByTagName(Node n, String name) {
+        MyNodeList node_list = new MyNodeList();
+        Node child = n.getFirstChild();
+        while (child!=null) {
+            if (child.getNodeName().equals(name)) {
+                node_list.addNode(child);
+            }
+            child = child.getNextSibling();
+        }
+        return node_list;
+    }
+
+
+    /** Duplicates an element, but gives it a new name */
+    public static Element duplicateWithNewName(Document owner, Element element,
+    String element_name, boolean with_attributes) {
+        return duplicateWithNewNameNS(owner, element, element_name, null, with_attributes);
+    }
+
+    /** Duplicates an element, but gives it a new name */
+    public static Element duplicateWithNewNameNS(Document owner,
+    Element element,
+    String element_name,
+    String namespace_uri,
+    boolean with_attributes) {
+        Element duplicate;
+        if (namespace_uri == null) {
+            duplicate = owner.createElement(element_name);
+        } else {
+            duplicate = owner.createElementNS(namespace_uri, element_name);
+        }
+        // Copy element attributes
+        if (with_attributes) {
+            NamedNodeMap attributes = element.getAttributes();
+            for (int i = 0; i < attributes.getLength(); i++) {
+                Node attribute = attributes.item(i);
+                duplicate.setAttribute(attribute.getNodeName(), attribute.getNodeValue());
+            }
+        }
+        
+        // Copy element children
+        NodeList children = element.getChildNodes();
+        for (int i = 0; i < children.getLength(); i++) {
+            Node child = children.item(i);
+            duplicate.appendChild(owner.importNode(child, true));
+        }
+        
+        return duplicate;
+    }
+
+    public static void copyAllChildren(Element to, Element from) {
+        
+        Document to_doc = to.getOwnerDocument();
+        Node child = from.getFirstChild();
+        while (child != null) {
+            to.appendChild(to_doc.importNode(child, true));
+            child = child.getNextSibling();
+        }
+    }
+    /** returns a basic request message */
+    public static  Element createBasicRequest(Document owner,
+    String request_type, String to,
+    String lang,
+    String uid) {
+        Element request = owner.createElement(REQUEST_ELEM);
+        request.setAttribute(TYPE_ATT, request_type);
+        request.setAttribute(LANG_ATT, lang);
+        request.setAttribute(TO_ATT, to);
+        request.setAttribute(USER_ID_ATT, uid);
+        return request;
+    }
+    
+    public static Element createBasicResponse(Document owner, String from)
     {
-        return;
+        Element response = owner.createElement(GSXML.RESPONSE_ELEM);
+        response.setAttribute(GSXML.FROM_ATT, from);
+        response.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
+        return response;
     }
     
-    Set items = params.entrySet();
-    Iterator i = items.iterator();
-    while(i.hasNext()) {
-      Map.Entry m = (Map.Entry)i.next();
-      param_list.appendChild(createParameter(owner, (String)m.getKey(), (String)m.getValue()));
-    }
-    
-  }
-  
-  public static Element createParameterDescription(Document owner,
-    String id,
-    String display_name,
-    String type,
-    String default_value,
-    String []option_ids,
-    String []option_names) {
-    
-    
-    Element p = owner.createElement(PARAM_ELEM);
-    p.setAttribute(NAME_ATT, id);
-    p.setAttribute(TYPE_ATT, type);
-    p.appendChild(createDisplayTextElement(owner, GSXML.DISPLAY_TEXT_NAME, display_name));
-    
-    if (default_value != null) {
-      p.setAttribute(DEFAULT_ATT, default_value);
-    }
-    if (option_ids!=null && option_names!=null) {
-      for (int i=0; i<option_ids.length; i++) {
-        Element e = owner.createElement(PARAM_OPTION_ELEM);
-        e.setAttribute(NAME_ATT, option_ids[i]);
-        e.appendChild(createDisplayTextElement(owner, GSXML.DISPLAY_TEXT_NAME, option_names[i]));
-        p.appendChild(e);
-      }
-    }
-    return p;
-  }
-  public static Element createParameterDescription2(Document owner,
-    String id,
-    String display_name,
-    String type,
-    String default_value,
-    ArrayList option_ids,
-    ArrayList option_names) {
-    
-    
-    Element p = owner.createElement(PARAM_ELEM);
-    p.setAttribute(NAME_ATT, id);
-    p.setAttribute(TYPE_ATT, type);
-    p.appendChild(createDisplayTextElement(owner, GSXML.DISPLAY_TEXT_NAME, display_name));
-    if (default_value != null) {
-      p.setAttribute(DEFAULT_ATT, default_value);
-    }
-    if (option_ids!=null && option_names!=null) {
-      for (int i=0; i<option_ids.size(); i++) {
-        Element e = owner.createElement(PARAM_OPTION_ELEM);
-        e.setAttribute(NAME_ATT, (String)option_ids.get(i));
-        e.appendChild(createDisplayTextElement(owner, GSXML.DISPLAY_TEXT_NAME, (String)option_names.get(i)));
-        p.appendChild(e);
-      }
-    }
-    return p;
-  }
-  
-  
-  /** returns the element parent/node_name[@attribute_name='attribute_value']
-   */
-  public static Element getNamedElement(Element parent, String node_name,
-    String attribute_name,
-    String attribute_value) {
-    
-    NodeList children = parent.getChildNodes();
-    for (int i=0; i<children.getLength(); i++) {
-      Node child = children.item(i);
-      if (child.getNodeName().equals(node_name)) {
-        if (((Element)child).getAttribute(attribute_name).equals(attribute_value))
-          return (Element)child;
-      }
-    }
-    // not found
-    return null;
-  }
-  /** returns a NodeList of elements: ancestor/node_name[@attribute_name='attribute_value']
-   */
-  public static NodeList getNamedElements(Element ancestor, String node_name, String attribute_name, String attribute_value) {
-        MyNodeList node_list = new MyNodeList();
-        NodeList children = ancestor.getElementsByTagName(node_name);
-        
+    public static Element createMetadataElement(Document owner, String name, String value)
+    {
+        Element metaElem = owner.createElement(GSXML.METADATA_ELEM);
+        metaElem.setAttribute(GSXML.NAME_ATT, name);
+        metaElem.setAttribute(GSXML.VALUE_ATT, value);
+        return metaElem;
+    }
+
+    public static Element createTextElement(Document owner, String elem_name,
+    String text) {
+        Element e = owner.createElement(elem_name);
+        Text t = owner.createTextNode(text);
+        e.appendChild(t);
+        return e;
+        
+    }
+
+    public static Element createTextElement(Document owner, String elem_name,
+    String text, String att_name, String att_value) {
+        Element e = owner.createElement(elem_name);
+        e.setAttribute(att_name, att_value);
+        Text t = owner.createTextNode(text);
+        e.appendChild(t);
+        return e;
+        
+    }
+    
+    public static Element createDisplayTextElement(Document owner,
+    String text_name,
+    String text) {
+        Element e = owner.createElement(DISPLAY_TEXT_ELEM);
+        e.setAttribute(NAME_ATT, text_name);
+        Text t = owner.createTextNode(text);
+        e.appendChild(t);
+        return e;
+        
+    }
+
+
+    public static Element createParameter(Document owner, String name,
+    String value) {
+        Element param = owner.createElement(PARAM_ELEM);
+        param.setAttribute(NAME_ATT, name);
+        param.setAttribute(VALUE_ATT, value);
+        return param;
+    }
+
+    public static void addParametersToList(Document owner, Element param_list,
+    HashMap params) {
+        if (params == null)
+        {
+            return;
+        }
+        
+        Set items = params.entrySet();
+        Iterator i = items.iterator();
+        while(i.hasNext()) {
+            Map.Entry m = (Map.Entry)i.next();
+            param_list.appendChild(createParameter(owner, (String)m.getKey(), (String)m.getValue()));
+        }
+        
+    }
+
+    public static Element createParameterDescription(Document owner,
+    String id,
+    String display_name,
+    String type,
+    String default_value,
+    String []option_ids,
+    String []option_names) {
+        
+        
+        Element p = owner.createElement(PARAM_ELEM);
+        p.setAttribute(NAME_ATT, id);
+        p.setAttribute(TYPE_ATT, type);
+        p.appendChild(createDisplayTextElement(owner, GSXML.DISPLAY_TEXT_NAME, display_name));
+        
+        if (default_value != null) {
+            p.setAttribute(DEFAULT_ATT, default_value);
+        }
+        if (option_ids!=null && option_names!=null) {
+            for (int i=0; i<option_ids.length; i++) {
+                Element e = owner.createElement(PARAM_OPTION_ELEM);
+                e.setAttribute(NAME_ATT, option_ids[i]);
+                e.appendChild(createDisplayTextElement(owner, GSXML.DISPLAY_TEXT_NAME, option_names[i]));
+                p.appendChild(e);
+            }
+        }
+        return p;
+    }
+    public static Element createParameterDescription2(Document owner,
+    String id,
+    String display_name,
+    String type,
+    String default_value,
+    ArrayList option_ids,
+    ArrayList option_names) {
+        
+        
+        Element p = owner.createElement(PARAM_ELEM);
+        p.setAttribute(NAME_ATT, id);
+        p.setAttribute(TYPE_ATT, type);
+        p.appendChild(createDisplayTextElement(owner, GSXML.DISPLAY_TEXT_NAME, display_name));
+        if (default_value != null) {
+            p.setAttribute(DEFAULT_ATT, default_value);
+        }
+        if (option_ids!=null && option_names!=null) {
+            for (int i=0; i<option_ids.size(); i++) {
+                Element e = owner.createElement(PARAM_OPTION_ELEM);
+                e.setAttribute(NAME_ATT, (String)option_ids.get(i));
+                e.appendChild(createDisplayTextElement(owner, GSXML.DISPLAY_TEXT_NAME, (String)option_names.get(i)));
+                p.appendChild(e);
+            }
+        }
+        return p;
+    }
+
+
+    /** returns the element parent/node_name[@attribute_name='attribute_value']
+*/
+    public static Element getNamedElement(Element parent, String node_name,
+    String attribute_name,
+    String attribute_value) {
+        
+        NodeList children = parent.getChildNodes();
+        for (int i=0; i<children.getLength(); i++) {
+            Node child = children.item(i);
+            if (child.getNodeName().equals(node_name)) {
+                if (((Element)child).getAttribute(attribute_name).equals(attribute_value))
+                return (Element)child;
+            }
+        }
+        // not found
+        return null;
+    }
+    /** returns a NodeList of elements: ancestor/node_name[@attribute_name='attribute_value']
+*/
+    public static NodeList getNamedElements(Element ancestor, String node_name, String attribute_name, String attribute_value) {
+        MyNodeList node_list = new MyNodeList();
+        NodeList children = ancestor.getElementsByTagName(node_name);
+        
         if(children != null && children.getLength() > 0) {
             
@@ -789 +808 @@
                 if (child.getNodeName().equals(node_name)) {
                     if (((Element)child).getAttribute(attribute_name).equals(attribute_value))
-                        node_list.addNode(child);
+                    node_list.addNode(child);
                 }           
             }           
-        }
-        return node_list;
-  }
-  
-  public static int SORT_TYPE_STRING = 0;
-  public static int SORT_TYPE_INT = 1;
-  public static int SORT_TYPE_FLOAT = 2;
-  
-  // sort type:
-  public static Element insertIntoOrderedList(Element parent_node,
-    String node_name,
-    Element start_from_elem,
-    Element new_elem, String sort_att,
-    boolean descending) {
-    if (new_elem == null) return null;
-    Element cloned_elem = (Element)parent_node.getOwnerDocument().importNode(new_elem, true);
-    if (start_from_elem == null) {
-      parent_node.appendChild(cloned_elem);
-      return cloned_elem;
-    }
-    
-    Node current_node = start_from_elem;
-    String insert_att = cloned_elem.getAttribute(sort_att);
-    String list_att = start_from_elem.getAttribute(sort_att);
-    while ((!descending && list_att.compareTo(insert_att)<0) || (descending && list_att.compareTo(insert_att)>0)) {
-      current_node = current_node.getNextSibling();
-      if (current_node == null) break; // end of the list
-      if (!current_node.getNodeName().equals(node_name)) {
-        continue; // not a valid node
-      }
-      list_att = ((Element)current_node).getAttribute(sort_att);
-    }
-    
-    parent_node.insertBefore(cloned_elem, current_node);
-    return cloned_elem;
-  }
-  
-  
-  /** Returns the appropriate language element from a display elem,
-   * display is the containing element, name is the name of the element to
-   * look for, lang is the preferred language, lang_default is the fall back
-   * lang if neither lang is found, will return the first one it finds*/
-  public static String getDisplayText(Element display, String name,
-    String lang, String lang_default) {
-    
-    String def = null;
-    String first = null;
-    NodeList elems = display.getElementsByTagName(DISPLAY_TEXT_ELEM);
-    if (elems.getLength() == 0) return "";
-    for (int i=0; i<elems.getLength(); i++) {
-      Element e = (Element)elems.item(i);
-      String n = e.getAttribute(NAME_ATT);
-      if (name.equals(n)) {
-        String l = e.getAttribute(LANG_ATT);
-        if (lang.equals(l)) {
-          return getNodeText(e);
-        } else if (lang_default.equals(l)) {
-          def = getNodeText(e);
-        } else if (first == null) {
-          first = getNodeText(e);
-        }
-      } else {
-        continue;
-      }
-    }
-    
-    if (def != null) {
-      return def;
-    }
-    if (first != null) {
-      return first;
-    }
-    return "";
-  }
-  
-  // replaces < > " ' & in the original with their entities
-  public static String xmlSafe(String original) {
-    
-    StringBuffer filtered = new StringBuffer(original.length());
-    char c;
-    for (int i=0; i<original.length(); i++) {
-      c = original.charAt(i);
-      if (c == '>') {
-        filtered.append("&gt;");
-      } else if (c == '<') {
-        filtered.append("&lt;");
-      } else if (c == '"') {
-        filtered.append("&quot;");
-      } else if (c == '&') {
-        filtered.append("&amp;");
-      } else if (c == '\'') {
-        filtered.append("&apos;");
-      } else {
-        filtered.append(c);
-      }
-    }
-    return filtered.toString();
-  }
-  
-  
-  // replaces < > " ' & entities with their originals
-  public static String unXmlSafe(String original) {
-    
-    StringBuffer filtered = new StringBuffer(original.length());
-    char c;
-    for (int i=0; i<original.length(); i++) {
-      c = original.charAt(i);
-      if (c == '&') {
-        int pos = original.indexOf(";", i);
-        String entity = original.substring(i+1, pos);
-        if (entity.equals("gt")) {
-          filtered.append(">");
-        } else if (entity.equals("lt")) {
-          filtered.append("<");
-        } else if (entity.equals("apos")) {
-          filtered.append("'");
-        } else if (entity.equals("amp")) {
-          filtered.append("&");
-        } else if (entity.equals("quot")) {
-          filtered.append("\"");
-        } else {
-          filtered.append("&"+entity+";");
-        }
-        i = pos;
-      } else {
-        filtered.append(c);
-      }
-    }
-    return filtered.toString();
-  }
-  
-  public static void printXMLNode(Node e, boolean printText) {
-    printXMLNode(e, 0, printText) ;
-  }
-  
-  public static String xmlNodeToString(Node e){
-    StringBuffer sb = new StringBuffer("");
-    xmlNodeToString(sb,e,0);
-    return sb.toString();
-  }
-  
-  private static void xmlNodeToString(StringBuffer sb, Node e, int depth){
-    
-    for (int i=0 ; i<depth ; i++)
-      sb.append(' ') ;
-    
-    if (e.getNodeType() == Node.TEXT_NODE){
-      sb.append("text") ;
-      return ;
-    }
-    
-    sb.append('<');
-    sb.append(e.getNodeName());
-    NamedNodeMap attrs = e.getAttributes();
-    if(attrs != null)
-    {
-        for (int i = 0; i < attrs.getLength(); i++) {
-            Node attr = attrs.item(i);
-            sb.append(' ');
-            sb.append(attr.getNodeName());
-            sb.append("=\"");
-            sb.append(attr.getNodeValue());
-            sb.append('"');
-        }
-    }
-    
-    NodeList children = e.getChildNodes();
-    
-    if (children == null || children.getLength() == 0)
-      sb.append("/>\n") ;
-    else {
-      
-      sb.append(">\n") ;
-      
-      int len = children.getLength();
-      for (int i = 0; i < len; i++) {
-        xmlNodeToString(sb,children.item(i), depth + 1);
-      }
-      
-      for (int i=0 ; i<depth ; i++)
-        sb.append(' ') ;
-      
-      sb.append("</" + e.getNodeName() + ">\n");
-    }
-    
-    
-  }
-  
-  public static void printXMLNode(Node e, int depth, boolean printText) { //recursive method call using DOM API...
-    
-    if(e == null){return;}
-    
-    for (int i=0 ; i<depth ; i++)
-      System.out.print(' ') ;
-    
-    if (e.getNodeType() == Node.TEXT_NODE){
-      if(printText){
-        System.out.println(e.getNodeValue());
-      }
-      else {
-        System.out.println("text");
-      }
-      return ;
-    }
-    
-    System.out.print('<');
-    System.out.print(e.getNodeName());
-    NamedNodeMap attrs = e.getAttributes();
-    
-    if (attrs != null)
-    {
-        for (int i = 0; i < attrs.getLength(); i++) {
-            Node attr = attrs.item(i);
-            System.out.print(' ');
-            System.out.print(attr.getNodeName());
-            System.out.print("=\"");
-            System.out.print(attr.getNodeValue());
-            System.out.print('"');
-        }
-    }
-    
-    NodeList children = e.getChildNodes();
-    
-    if (children == null || children.getLength() == 0)
-      System.out.println("/>") ;
-    else {
-      
-      System.out.println('>') ;
-      
-      int len = children.getLength();
-      for (int i = 0; i < len; i++) {
-        printXMLNode(children.item(i), depth + 1, printText);
-      }
-      
-      for (int i=0 ; i<depth ; i++)
-        System.out.print(' ') ;
-      
-      System.out.println("</" + e.getNodeName() + ">");
-    }
-    
-  }
-
-  public static void elementToLogAsString(Element e) {
-    try {
-      TransformerFactory tf = TransformerFactory.newInstance();
-      Transformer trans = tf.newTransformer();
-      StringWriter sw = new StringWriter();
-      trans.transform(new DOMSource(e), new StreamResult(sw));
-      System.err.println( sw.toString() ); // logger.info( sw.toString() );
-    } catch( Exception ex ) {
-      System.err.println( "couldn't write " + e + " to log" );
-    }
-
-  }
+        }
+        return node_list;
+    }
+
+    public static int SORT_TYPE_STRING = 0;
+    public static int SORT_TYPE_INT = 1;
+    public static int SORT_TYPE_FLOAT = 2;
+
+    // sort type:
+    public static Element insertIntoOrderedList(Element parent_node,
+    String node_name,
+    Element start_from_elem,
+    Element new_elem, String sort_att,
+    boolean descending) {
+        if (new_elem == null) return null;
+        Element cloned_elem = (Element)parent_node.getOwnerDocument().importNode(new_elem, true);
+        if (start_from_elem == null) {
+            parent_node.appendChild(cloned_elem);
+            return cloned_elem;
+        }
+        
+        Node current_node = start_from_elem;
+        String insert_att = cloned_elem.getAttribute(sort_att);
+        String list_att = start_from_elem.getAttribute(sort_att);
+        while ((!descending && list_att.compareTo(insert_att)<0) || (descending && list_att.compareTo(insert_att)>0)) {
+            current_node = current_node.getNextSibling();
+            if (current_node == null) break; // end of the list
+            if (!current_node.getNodeName().equals(node_name)) {
+                continue; // not a valid node
+            }
+            list_att = ((Element)current_node).getAttribute(sort_att);
+        }
+        
+        parent_node.insertBefore(cloned_elem, current_node);
+        return cloned_elem;
+    }
+
+
+    /** Returns the appropriate language element from a display elem,
+* display is the containing element, name is the name of the element to
+* look for, lang is the preferred language, lang_default is the fall back
+* lang if neither lang is found, will return the first one it finds*/
+    public static String getDisplayText(Element display, String name,
+    String lang, String lang_default) {
+        
+        String def = null;
+        String first = null;
+        NodeList elems = display.getElementsByTagName(DISPLAY_TEXT_ELEM);
+        if (elems.getLength() == 0) return "";
+        for (int i=0; i<elems.getLength(); i++) {
+            Element e = (Element)elems.item(i);
+            String n = e.getAttribute(NAME_ATT);
+            if (name.equals(n)) {
+                String l = e.getAttribute(LANG_ATT);
+                if (lang.equals(l)) {
+                    return getNodeText(e);
+                } else if (lang_default.equals(l)) {
+                    def = getNodeText(e);
+                } else if (first == null) {
+                    first = getNodeText(e);
+                }
+            } else {
+                continue;
+            }
+        }
+        
+        if (def != null) {
+            return def;
+        }
+        if (first != null) {
+            return first;
+        }
+        return "";
+    }
+
+    // replaces < > " ' & in the original with their entities
+    public static String xmlSafe(String original) {
+        
+        StringBuffer filtered = new StringBuffer(original.length());
+        char c;
+        for (int i=0; i<original.length(); i++) {
+            c = original.charAt(i);
+            if (c == '>') {
+                filtered.append("&gt;");
+            } else if (c == '<') {
+                filtered.append("&lt;");
+            } else if (c == '"') {
+                filtered.append("&quot;");
+            } else if (c == '&') {
+                filtered.append("&amp;");
+            } else if (c == '\'') {
+                filtered.append("&apos;");
+            } else {
+                filtered.append(c);
+            }
+        }
+        return filtered.toString();
+    }
+
+
+    // replaces < > " ' & entities with their originals
+    public static String unXmlSafe(String original) {
+        
+        StringBuffer filtered = new StringBuffer(original.length());
+        char c;
+        for (int i=0; i<original.length(); i++) {
+            c = original.charAt(i);
+            if (c == '&') {
+                int pos = original.indexOf(";", i);
+                String entity = original.substring(i+1, pos);
+                if (entity.equals("gt")) {
+                    filtered.append(">");
+                } else if (entity.equals("lt")) {
+                    filtered.append("<");
+                } else if (entity.equals("apos")) {
+                    filtered.append("'");
+                } else if (entity.equals("amp")) {
+                    filtered.append("&");
+                } else if (entity.equals("quot")) {
+                    filtered.append("\"");
+                } else {
+                    filtered.append("&"+entity+";");
+                }
+                i = pos;
+            } else {
+                filtered.append(c);
+            }
+        }
+        return filtered.toString();
+    }
+
+    public static void printXMLNode(Node e, boolean printText) {
+        printXMLNode(e, 0, printText) ;
+    }
+
+    public static String xmlNodeToString(Node e){
+        StringBuffer sb = new StringBuffer("");
+        xmlNodeToString(sb,e,0);
+        return sb.toString();
+    }
+
+    private static void xmlNodeToString(StringBuffer sb, Node e, int depth){
+        
+        for (int i=0 ; i<depth ; i++)
+        sb.append(' ') ;
+        
+        if (e.getNodeType() == Node.TEXT_NODE){
+            sb.append("text") ;
+            return ;
+        }
+        
+        sb.append('<');
+        sb.append(e.getNodeName());
+        NamedNodeMap attrs = e.getAttributes();
+        if(attrs != null)
+        {
+            for (int i = 0; i < attrs.getLength(); i++) {
+                Node attr = attrs.item(i);
+                sb.append(' ');
+                sb.append(attr.getNodeName());
+                sb.append("=\"");
+                sb.append(attr.getNodeValue());
+                sb.append('"');
+            }
+        }
+        
+        NodeList children = e.getChildNodes();
+        
+        if (children == null || children.getLength() == 0)
+        sb.append("/>\n") ;
+        else {
+            
+            sb.append(">\n") ;
+            
+            int len = children.getLength();
+            for (int i = 0; i < len; i++) {
+                xmlNodeToString(sb,children.item(i), depth + 1);
+            }
+            
+            for (int i=0 ; i<depth ; i++)
+            sb.append(' ') ;
+            
+            sb.append("</" + e.getNodeName() + ">\n");
+        }
+        
+        
+    }
+
+    public static void printXMLNode(Node e, int depth, boolean printText) { //recursive method call using DOM API...
+        
+        if(e == null){return;}
+        
+        for (int i=0 ; i<depth ; i++)
+        System.out.print(' ') ;
+        
+        if (e.getNodeType() == Node.TEXT_NODE){
+            if(printText){
+                System.out.println(e.getNodeValue());
+            }
+            else {
+                System.out.println("text");
+            }
+            return ;
+        }
+        
+        System.out.print('<');
+        System.out.print(e.getNodeName());
+        NamedNodeMap attrs = e.getAttributes();
+        
+        if (attrs != null)
+        {
+            for (int i = 0; i < attrs.getLength(); i++) {
+                Node attr = attrs.item(i);
+                System.out.print(' ');
+                System.out.print(attr.getNodeName());
+                System.out.print("=\"");
+                System.out.print(attr.getNodeValue());
+                System.out.print('"');
+            }
+        }
+        
+        NodeList children = e.getChildNodes();
+        
+        if (children == null || children.getLength() == 0)
+        System.out.println("/>") ;
+        else {
+            
+            System.out.println('>') ;
+            
+            int len = children.getLength();
+            for (int i = 0; i < len; i++) {
+                printXMLNode(children.item(i), depth + 1, printText);
+            }
+            
+            for (int i=0 ; i<depth ; i++)
+            System.out.print(' ') ;
+            
+            System.out.println("</" + e.getNodeName() + ">");
+        }   
+    }
+
+    public static void elementToLogAsString(Element e) {
+        try {
+            TransformerFactory tf = TransformerFactory.newInstance();
+            Transformer trans = tf.newTransformer();
+            StringWriter sw = new StringWriter();
+            trans.transform(new DOMSource(e), new StreamResult(sw));
+            System.err.println( sw.toString() );
+        } catch( Exception ex ) {
+            System.err.println( "couldn't write " + e + " to log" );
+        }
+    }
 }

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

@@ -36 +36 @@
 import jdbm.htree.HTree;
 
-public class JDBMWrapper
-  implements FlatDatabaseWrapper {
-  
-  static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.JDBMWrapper.class.getName());
-
-    static String TNAME = "greenstone";
-
-    RecordManager  recman_ = null;
-    HTree          hashtable_;
-
-    String db_filename_;
-
-    static private PrintWriter utf8out = null;
-
-    static
-    {
-        try {
-            OutputStreamWriter osw = new OutputStreamWriter(System.out, "UTF-8");
-            utf8out = new PrintWriter(osw, true);
-        }
-        catch (UnsupportedEncodingException e) {
-            System.out.println(e);
-        }
-    }
-
-
-  /** open database named filename, using mode */
-  public boolean openDatabase(String db_filename, int mode) {
-      
-
-      if (db_filename.endsWith(".jdb")) {
-      // remove file extension as JDBM does not expect it
-      db_filename = db_filename.substring(0,db_filename.length()-4);
-      }
-
-      // Map the mode value into equivalent JDBM 'must_exist' value
-      // currently this is very simple as there is only READ and WRITE
-      // (no WRITER_CREATE)
-      // => assume the database must exist
-      boolean must_exist = true; // default
-
-      if (recman_ != null) {
-      String message = "openDatabase() called when the class already has a database open\n";
-      message += "  Use closeDatabase before opening the next one.\n";
-      message += "  Existing database file: " + db_filename_ + "\n";
-      message += "  New database file:      " + db_filename + "\n";
-      logger.warn(message);
-      // consider closing it automatically?
-      }
-
-
-      try {
-      // create or open a record manager
-      Properties props = new Properties();
-      recman_ = RecordManagerFactory.createRecordManager(db_filename, props);
-      
-      // load existing table (if exists) otherwise create new one
-      long recid = recman_.getNamedObject(TNAME);
-      
-      if (recid != 0) {
-          System.err.println("# Loading existing database table '" + TNAME +"' ...");
-          hashtable_ = HTree.load(recman_, recid);
-      }
-      else {
-          
-          if (must_exist) {
-          recman_.close();
-          recman_ = null;
-          db_filename_ = null;
-
-          System.err.println("Database table '" + TNAME +"' does not exist.");
-          throw new IOException();
-          }
-          else {
-          System.err.println("# No database table '" + TNAME +"' to set.  Creating new one");
-            hashtable_ = HTree.createInstance(recman_);
-            recman_.setNamedObject(TNAME, hashtable_.getRecid());
-        }
-      }
-      }
-      catch (IOException e) {     
-    logger.error("couldn't open database "+ db_filename);
-    return false;
-      }
-
-      db_filename_ = db_filename;
-
-      return true;
-  }
-
-
-  /** close the database associated with this wrapper */
-  public void closeDatabase() {
-      try {
-      if (recman_ != null) {
-          recman_.close();
-          recman_ = null;
-          db_filename_ = null;
-      }
-      }
-      catch (IOException e) {     
-    logger.error("Failed to close JDBM database");
-      }
-  }
-
-  /** returns the value associated with the key */
-  public String getValue(String key) {
-
-      String val;
-
-      try {
-      val = (String) hashtable_.get(key);
-        
-      recman_.commit();
-      }
-      catch (IOException e) {     
-    logger.error("Failed get key " + key + "from JDBM database");
-    return null;
-      }
-
-      return val;
-  }
-
-  /** returns a string of key-value entries that can be 
-   *    printed for debugging purposes*/
-  public String displayAllEntries() {
-
-      StringBuffer keys = new StringBuffer();
-
-      try {
-      FastIterator   iter = hashtable_.keys();
-      String         key  = (String) iter.next();
-      
-      String nl = System.getProperty("line.separator");
-      
-      while (key != null) {
-          String val = (String) hashtable_.get(key);
-          keys.append("[" + key + "]" + nl);
-          keys.append(val + nl);
-          // 70 hypens
-          keys.append("----------------------------------------------------------------------" + nl);
-          key = (String) iter.next();
-      }
-
-      recman_.commit();
-      }
-      catch (IOException e) {     
-    logger.error("Failed get all keys and values from JDBM database");
-    return null;
-      }
-        
-      return keys.toString();
-  }
+public class JDBMWrapper implements FlatDatabaseWrapper
+{
+
+    static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.JDBMWrapper.class.getName());
+
+    static String TNAME = "greenstone";
+
+    RecordManager recman_ = null;
+    HTree hashtable_;
+
+    String db_filename_;
+
+    static private PrintWriter utf8out = null;
+
+    static
+    {
+        try
+        {
+            OutputStreamWriter osw = new OutputStreamWriter(System.out, "UTF-8");
+            utf8out = new PrintWriter(osw, true);
+        }
+        catch (UnsupportedEncodingException e)
+        {
+            System.out.println(e);
+        }
+    }
+
+    /** open database named filename, using mode */
+    public boolean openDatabase(String db_filename, int mode)
+    {
+
+        if (db_filename.endsWith(".jdb"))
+        {
+            // remove file extension as JDBM does not expect it
+            db_filename = db_filename.substring(0, db_filename.length() - 4);
+        }
+
+        // Map the mode value into equivalent JDBM 'must_exist' value
+        // currently this is very simple as there is only READ and WRITE
+        // (no WRITER_CREATE)
+        // => assume the database must exist
+        boolean must_exist = true; // default
+
+        if (recman_ != null)
+        {
+            String message = "openDatabase() called when the class already has a database open\n";
+            message += "  Use closeDatabase before opening the next one.\n";
+            message += "  Existing database file: " + db_filename_ + "\n";
+            message += "  New database file:      " + db_filename + "\n";
+            logger.warn(message);
+            // consider closing it automatically?
+        }
+
+        try
+        {
+            // create or open a record manager
+            Properties props = new Properties();
+            recman_ = RecordManagerFactory.createRecordManager(db_filename, props);
+
+            // load existing table (if exists) otherwise create new one
+            long recid = recman_.getNamedObject(TNAME);
+
+            if (recid != 0)
+            {
+                System.err.println("# Loading existing database table '" + TNAME + "' ...");
+                hashtable_ = HTree.load(recman_, recid);
+            }
+            else
+            {
+
+                if (must_exist)
+                {
+                    recman_.close();
+                    recman_ = null;
+                    db_filename_ = null;
+
+                    System.err.println("Database table '" + TNAME + "' does not exist.");
+                    throw new IOException();
+                }
+                else
+                {
+                    System.err.println("# No database table '" + TNAME + "' to set.  Creating new one");
+                    hashtable_ = HTree.createInstance(recman_);
+                    recman_.setNamedObject(TNAME, hashtable_.getRecid());
+                }
+            }
+        }
+        catch (IOException e)
+        {
+            logger.error("couldn't open database " + db_filename);
+            return false;
+        }
+
+        db_filename_ = db_filename;
+
+        return true;
+    }
+
+    /** close the database associated with this wrapper */
+    public void closeDatabase()
+    {
+        try
+        {
+            if (recman_ != null)
+            {
+                recman_.close();
+                recman_ = null;
+                db_filename_ = null;
+            }
+        }
+        catch (IOException e)
+        {
+            logger.error("Failed to close JDBM database");
+        }
+    }
+
+    /** returns the value associated with the key */
+    public String getValue(String key)
+    {
+
+        String val;
+
+        try
+        {
+            val = (String) hashtable_.get(key);
+            
+            recman_.commit();
+        }
+        catch (IOException e)
+        {
+            logger.error("Failed get key " + key + "from JDBM database");
+            return null;
+        }
+        
+        return val;
+    }
+    
+    /**
+     * Sets the given key to the given value in the database
+     */
+    public boolean setValue(String key, String value)
+    {
+        try
+        {
+            hashtable_.put(key, value);
+            recman_.commit();
+        }
+        catch (Exception ex)
+        {
+            logger.error("Failed to set " + key + " = " + value + " in the JDBM database");
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * Deletes the given key (and corresponding value) from the database
+     */
+    public boolean deleteKey(String key)
+    {
+        try
+        {
+            hashtable_.remove(key);
+            recman_.commit();
+        }
+        catch (Exception ex)
+        {
+            logger.error("Failed to delete key " + key + " in the JDBM database");
+            return false;
+        }
+        return true;
+    }
+
+    /**
+     * returns a string of key-value entries that can be printed for debugging
+     * purposes
+     */
+    public String displayAllEntries()
+    {
+
+        StringBuffer keys = new StringBuffer();
+
+        try
+        {
+            FastIterator iter = hashtable_.keys();
+            String key = (String) iter.next();
+
+            String nl = System.getProperty("line.separator");
+
+            while (key != null)
+            {
+                String val = (String) hashtable_.get(key);
+                keys.append("[" + key + "]" + nl);
+                keys.append(val + nl);
+                // 70 hypens
+                keys.append("----------------------------------------------------------------------" + nl);
+                key = (String) iter.next();
+            }
+
+            recman_.commit();
+        }
+        catch (IOException e)
+        {
+            logger.error("Failed get all keys and values from JDBM database");
+            return null;
+        }
+
+        return keys.toString();
+    }
 }

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

@@ -19 +19 @@
 package org.greenstone.gsdl3.util;
 
+import java.util.Iterator;
+import java.util.Set;
+import java.util.Vector;
+
 import org.apache.log4j.*;
 
 import org.apache.commons.lang3.StringUtils;
 
-public class SimpleCollectionDatabase implements OID.OIDTranslatable {
-  
-  static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.SimpleCollectionDatabase.class.getName());
-
-  /* just read access, many readers can share a database */
-  public final static int READ = FlatDatabaseWrapper.READ;
-  /* read/write, exclusive access */
-  public final static int WRITE = FlatDatabaseWrapper.WRITE;
-  
-  protected FlatDatabaseWrapper coll_db = null;
-  
-  public SimpleCollectionDatabase(String db_type) {
-
-      // Access databaseWrapper through reflection (forName) so code
-      // can be more dynamic as to the database backends that are
-      // supported for this installation of Greenstone
-
-      String dbwrap_name = db_type.toUpperCase() + "Wrapper";
-      Class dbwrap_class = null;
-
-      try {
-      String full_dbwrap_name = "org.greenstone.gsdl3.util."+dbwrap_name;
-      dbwrap_class = Class.forName(full_dbwrap_name);
-      } 
-      catch(ClassNotFoundException e) {
-      try {
-          //try the dbwrap_name alone in case the package name is
-          //already specified
-          dbwrap_class = Class.forName(dbwrap_name);
-      } 
-      catch(ClassNotFoundException ae) {
-          logger.error("Couldn't create SimpleCollectionDatabase of type "+db_type);
-          logger.info(ae.getMessage());
-      }
-      }
-
-      try {
-      this.coll_db = (FlatDatabaseWrapper)dbwrap_class.newInstance();
-      }
-      catch(Exception e) {
-          logger.error("Failed to call the constructor "+dbwrap_name+"()");
-      }
-
-
-  }
-  
-  public boolean databaseOK() {
-      // Previously failed to open database
-      // Most likely cause is that this installation of Greenstone3 has not 
-      // been compiled with support for this database type
-      return coll_db != null;
-  }
-
-  /** open the database filename, with mode mode - uses the FlatDatabaseWrapper modes */
-  public boolean openDatabase(String filename, int mode){
-    return this.coll_db.openDatabase(filename, mode);
-  }
-  
-  /** close the database */
-  public void closeDatabase() {
-    this.coll_db.closeDatabase();
-  }
-  
-  /** Returns a DBInfo structure of the key-value pairs associated with a 
-    particular main key in the database */
-  public DBInfo getInfo(String main_key) {
-      //   logger.warn("All the entries of the db are:");
-      //   this.coll_db.displayAllEntries();
-
-      
-    if (this.coll_db==null) {
-    // Most likely cause is that this installation of Greenstone3 has not 
-    // been compiled with support for this database type
-    return null;
-    }
-
-    String key_info = this.coll_db.getValue(main_key);
-    if (key_info == null || key_info.equals("")) {
-      return null;
-    }
-    
-    DBInfo info = new DBInfo();
-    
-    String [] lines = StringUtils.split(key_info, "\n");
-    String key;
-    String value;
-    for (int i=0; i<lines.length; i++) {
-      logger.debug("line:"+lines[i]);
-      int a = lines[i].indexOf('<');
-      int b= lines[i].indexOf('>');
-      if (a==-1 || b==-1) {
-    logger.error("bad format in db");
-      }
-      else {
-    key=lines[i].substring(a+1, b);
-    value=lines[i].substring(b+1);
-    logger.debug("key="+key+", val="+value);
-    info.addInfo(key, value);
-
-      }
-    }
-    return info;
-    
-  }
-  
-  /** converts a greenstone OID to internal docnum */
-  public String OID2Docnum(String OID) {
-    DBInfo info = getInfo(OID);
-    if (info != null) {
-      return info.getInfo("docnum");
-    }
-    return null;
-  }
-    
-  /** converts a greenstone OID to an internal docnum, returning a Long 
-   - convenience method*/
-  public long OID2DocnumLong(String OID) {
-    DBInfo info = getInfo(OID);
-    if (info != null) {
-      long real_num = Long.parseLong(info.getInfo("docnum"));
-      return real_num;
-    }
-    return -1;
-  }
-
-
-  /** converts a docnum to greenstone OID */
-  public String docnum2OID(String docnum) {
-    DBInfo info = getInfo(docnum);
-    if (info!=null){
-      String oid = info.getInfo("section");
-      return oid;
-    } else{
-      return null;
-    }
-  }
-
-  /** converts a docnum to greenstone OID 
-      - convenience method */
-  public String docnum2OID(long docnum) {
-    return docnum2OID(Long.toString(docnum));
-  }
-
-  /** converts an external id to greenstone OID */
-  public String externalId2OID(String extid) {
-    DBInfo info = getInfo(extid);
-    if (info != null) {
-      String oid = info.getInfo("section");
-      return oid;
-    }
-    return null;
-  }
-
-  /** After OID.translateOID() is through, this method processes OID further 
-   * to translate relative oids into proper oids:
-   * .pr (parent), .rt (root) .fc (first child), .lc (last child),
-   * .ns (next sibling), .ps (previous sibling) 
-   * .np (next page), .pp (previous page) : links sections in the order that you'd read the document
-   * a suffix is expected to be present so test before using 
-   */
-    public String processOID(String doc_id, String top, String suff, int sibling_num) {
-    DBInfo info = getInfo(doc_id);
-    if (info==null) {
-      logger.info("info is null!!");
-      return top;
-    }
+public class SimpleCollectionDatabase implements OID.OIDTranslatable
+{
+
+    static Logger logger = Logger.getLogger(org.greenstone.gsdl3.util.SimpleCollectionDatabase.class.getName());
+
+    /* just read access, many readers can share a database */
+    public final static int READ = FlatDatabaseWrapper.READ;
+    /* read/write, exclusive access */
+    public final static int WRITE = FlatDatabaseWrapper.WRITE;
+
+    protected FlatDatabaseWrapper coll_db = null;
+
+    public SimpleCollectionDatabase(String db_type)
+    {
+
+        // Access databaseWrapper through reflection (forName) so code
+        // can be more dynamic as to the database backends that are
+        // supported for this installation of Greenstone
+
+        String dbwrap_name = db_type.toUpperCase() + "Wrapper";
+        Class dbwrap_class = null;
+
+        try
+        {
+            String full_dbwrap_name = "org.greenstone.gsdl3.util." + dbwrap_name;
+            dbwrap_class = Class.forName(full_dbwrap_name);
+        }
+        catch (ClassNotFoundException e)
+        {
+            try
+            {
+                //try the dbwrap_name alone in case the package name is
+                //already specified
+                dbwrap_class = Class.forName(dbwrap_name);
+            }
+            catch (ClassNotFoundException ae)
+            {
+                logger.error("Couldn't create SimpleCollectionDatabase of type " + db_type);
+                logger.info(ae.getMessage());
+            }
+        }
+
+        try
+        {
+            this.coll_db = (FlatDatabaseWrapper) dbwrap_class.newInstance();
+        }
+        catch (Exception e)
+        {
+            logger.error("Failed to call the constructor " + dbwrap_name + "()");
+        }
+
+    }
+
+    public boolean databaseOK()
+    {
+        // Previously failed to open database
+        // Most likely cause is that this installation of Greenstone3 has not 
+        // been compiled with support for this database type
+        return coll_db != null;
+    }
+
+    /**
+     * open the database filename, with mode mode - uses the FlatDatabaseWrapper
+     * modes
+     */
+    public boolean openDatabase(String filename, int mode)
+    {
+        return this.coll_db.openDatabase(filename, mode);
+    }
+
+    /** close the database */
+    public void closeDatabase()
+    {
+        this.coll_db.closeDatabase();
+    }
+
+    /**
+     * Returns a DBInfo structure of the key-value pairs associated with a
+     * particular main key in the database
+     */
+    public DBInfo getInfo(String main_key)
+    {
+        //   logger.warn("All the entries of the db are:");
+        //   this.coll_db.displayAllEntries();
+
+        if (this.coll_db == null)
+        {
+            // Most likely cause is that this installation of Greenstone3 has not 
+            // been compiled with support for this database type
+            return null;
+        }
+
+        String key_info = this.coll_db.getValue(main_key);
+        if (key_info == null || key_info.equals(""))
+        {
+            return null;
+        }
+        
+        DBInfo info = new DBInfo();
+
+        String[] lines = StringUtils.split(key_info, "\n");
+        String key;
+        String value;
+        for (int i = 0; i < lines.length; i++)
+        {
+            logger.debug("line:" + lines[i]);
+            int a = lines[i].indexOf('<');
+            int b = lines[i].indexOf('>');
+            if (a == -1 || b == -1)
+            {
+                logger.error("bad format in db");
+            }
+            else
+            {
+                key = lines[i].substring(a + 1, b);
+                value = lines[i].substring(b + 1);
+                logger.debug("key=" + key + ", val=" + value);
+                info.addInfo(key, value);
+            }
+        }
+        
+        return info;
+    }
     
-    String contains = info.getInfo("contains");
-    if (contains.equals("")) {
-      // something is wrong
-      return top;
-    }
-    contains = StringUtils.replace(contains, "\"", doc_id);
-    String [] children = StringUtils.split(contains, ";");
-    if (suff.equals("fc")) {
-      return children[0];
-    } else if (suff.equals("lc")) {
-      return children[children.length-1];
-    } else {
-      if (suff.equals("ss")) {
-    return children[sibling_num-1];
-      }
-      // find the position that we are at.
-      int i=0;
-      while (i<children.length) {
-    if (children[i].equals(top)) {
-      break;
-    }
-    i++;
-      }
-        
-      if (suff.equals("ns")) {
-    if (i==children.length-1) {
-      return children[i];
-    }
-    return children[i+1];
-      } else if (suff.equals("ps")) {
-    if (i==0) {
-      return children[i];
-    }
-    return children[i-1];
-      }
-    }
+    public boolean setInfo(String mainKey, DBInfo info)
+    {
+        StringBuilder valueToAdd = new StringBuilder();
+        Iterator i = info.getKeys().iterator();
+        while (i.hasNext())
+        {
+            String currentKey = (String)i.next();
+            Vector currentValues = (Vector)info.getMultiInfo(currentKey);
+            
+            if(currentValues.size() == 0)
+            {
+                valueToAdd.append("<" + currentKey + ">\n");
+                continue;
+            }
+            
+            for(int j = 0; j < currentValues.size(); j++)
+            {
+                valueToAdd.append("<" + currentKey + ">" + currentValues.get(j) + "\n");
+            }
+        }
+        
+        //Remove the final \n
+        if (valueToAdd.length() > 0)
+        {
+            valueToAdd.delete(valueToAdd.length() - 1, valueToAdd.length());
+        }
+        
+        return this.coll_db.setValue(mainKey, valueToAdd.toString());
+    }
     
-    return top;
-    }  
+    public String getValue(String key)
+    {
+        return this.coll_db.getValue(key);
+    }
+    
+    public boolean setValue(String key, String value)
+    {
+        return this.coll_db.setValue(key, value);
+    }
+    
+    public boolean deleteKey(String key)
+    {
+        return this.coll_db.deleteKey(key);
+    }
+
+    /** converts a greenstone OID to internal docnum */
+    public String OID2Docnum(String OID)
+    {
+        DBInfo info = getInfo(OID);
+        if (info != null)
+        {
+            return info.getInfo("docnum");
+        }
+        return null;
+    }
+
+    /**
+     * converts a greenstone OID to an internal docnum, returning a Long -
+     * convenience method
+     */
+    public long OID2DocnumLong(String OID)
+    {
+        DBInfo info = getInfo(OID);
+        if (info != null)
+        {
+            long real_num = Long.parseLong(info.getInfo("docnum"));
+            return real_num;
+        }
+        return -1;
+    }
+
+    /** converts a docnum to greenstone OID */
+    public String docnum2OID(String docnum)
+    {
+        DBInfo info = getInfo(docnum);
+        if (info != null)
+        {
+            String oid = info.getInfo("section");
+            return oid;
+        }
+        else
+        {
+            return null;
+        }
+    }
+
+    /**
+     * converts a docnum to greenstone OID - convenience method
+     */
+    public String docnum2OID(long docnum)
+    {
+        return docnum2OID(Long.toString(docnum));
+    }
+
+    /** converts an external id to greenstone OID */
+    public String externalId2OID(String extid)
+    {
+        DBInfo info = getInfo(extid);
+        if (info != null)
+        {
+            String oid = info.getInfo("section");
+            return oid;
+        }
+        return null;
+    }
+
+    /**
+     * After OID.translateOID() is through, this method processes OID further to
+     * translate relative oids into proper oids: .pr (parent), .rt (root) .fc
+     * (first child), .lc (last child), .ns (next sibling), .ps (previous
+     * sibling) .np (next page), .pp (previous page) : links sections in the
+     * order that you'd read the document a suffix is expected to be present so
+     * test before using
+     */
+    public String processOID(String doc_id, String top, String suff, int sibling_num)
+    {
+        DBInfo info = getInfo(doc_id);
+        if (info == null)
+        {
+            logger.info("info is null!!");
+            return top;
+        }
+
+        String contains = info.getInfo("contains");
+        if (contains.equals(""))
+        {
+            // something is wrong
+            return top;
+        }
+        contains = StringUtils.replace(contains, "\"", doc_id);
+        String[] children = StringUtils.split(contains, ";");
+        if (suff.equals("fc"))
+        {
+            return children[0];
+        }
+        else if (suff.equals("lc"))
+        {
+            return children[children.length - 1];
+        }
+        else
+        {
+            if (suff.equals("ss"))
+            {
+                return children[sibling_num - 1];
+            }
+            // find the position that we are at.
+            int i = 0;
+            while (i < children.length)
+            {
+                if (children[i].equals(top))
+                {
+                    break;
+                }
+                i++;
+            }
+
+            if (suff.equals("ns"))
+            {
+                if (i == children.length - 1)
+                {
+                    return children[i];
+                }
+                return children[i + 1];
+            }
+            else if (suff.equals("ps"))
+            {
+                if (i == 0)
+                {
+                    return children[i];
+                }
+                return children[i - 1];
+            }
+        }
+
+        return top;
+    }
 }

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

@@ -177 +177 @@
             // Use the TransformerFactory to process the stylesheet Source and generate a Transformer.
             Transformer transformer = this.t_factory.newTransformer(new DOMSource(stylesheet));
-            logger.debug("XMLTransformer transformer is " + transformer);
+            logger.error("XMLTransformer transformer is " + transformer);
             transformer.setErrorListener(new TransformErrorListener());
             if (parameters != null) {

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

@@ -138 +138 @@
     }
     public static String getInterfaceText(String interface_name, String lang, String key, String args_str) {
+    
+    key = key.replaceAll("__INTERFACE_NAME__", interface_name);
+        
     String [] args = null;
     if (args_str!=null && !args_str.equals("")) {