Changeset 3471 for trunk/gsdl3

Timestamp:

2002-10-16T09:38:16+13:00 (22 years ago)

Author:

kjdon

Message:

service modules now belong to a serviceCluster or colleciton - collection_name has been changed to the more general cluster_name. service module cant configure itself from a file - we no longer know where the appropriate file is. so must be configured by passing the xml node to the configure method

Location:

trunk/gsdl3/src/java/org/greenstone/gsdl3/service

Files:

• GSDL2ClassifierService.java (modified) (3 diffs)
• MGPPGDBMService.java (modified) (6 diffs)
• PhindService.java (modified) (2 diffs)
• ServiceModule.java (modified) (4 diffs)

trunk/gsdl3/src/java/org/greenstone/gsdl3/service/GSDL2ClassifierService.java

@@ -53 +53 @@
     // the response element
     Element result = doc_.createElement("response");
-    String from = GSPath.appendLink(collection_name_, "ClassifierBrowse");
+    String from = GSPath.appendLink(cluster_name_, "ClassifierBrowse");
     result.setAttribute("from", from);
     result.setAttribute("type", "query");
@@ -183 +183 @@
     }
     
-    System.out.println("classifier result:");
-    System.out.println(converter_.getString(result));
     return result;
     
@@ -215 +213 @@
     service_info_map_.put("ClassifierBrowse", e);
     
-    if (gdbm_src_.openDatabase(GSFile.GDBMDatabaseFile(site_home_, collection_name_), GDBMWrapper.READER)) {
+    if (gdbm_src_.openDatabase(GSFile.GDBMDatabaseFile(site_home_, cluster_name_), GDBMWrapper.READER)) {
         return true;
     }

trunk/gsdl3/src/java/org/greenstone/gsdl3/service/MGPPGDBMService.java

@@ -189 +189 @@
     service_info_map_.put("MetadataRetrieve", e);
 
-    if (gdbm_src_.openDatabase(GSFile.GDBMDatabaseFile(site_home_, collection_name_), GDBMWrapper.READER)) {
+    if (gdbm_src_.openDatabase(GSFile.GDBMDatabaseFile(site_home_, cluster_name_), GDBMWrapper.READER)) {
         return true;
     }
@@ -223 +223 @@
 
     Element result = doc_.createElement("response");
-    String from = GSPath.appendLink(collection_name_, "TextQuery");
+    String from = GSPath.appendLink(cluster_name_, "TextQuery");
     result.setAttribute("from", from);
     result.setAttribute("type", "query");
@@ -261 +261 @@
     // now set up the mgpp stuff
     String basedir = GSFile.collectionBaseDir(site_home_, 
-                          collection_name_);
-    String indexdir = GSFile.collectionIndexPath(collection_name_, index);
+                          cluster_name_);
+    String indexdir = GSFile.collectionIndexPath(cluster_name_, index);
 
     mgpp_src_.loadIndexData(basedir, indexdir);
@@ -294 +294 @@
     protected Element processFieldQuery(Element request) {
     Element result = doc_.createElement("response");
-    String from = GSPath.appendLink(collection_name_, "FieldQuery");
+    String from = GSPath.appendLink(cluster_name_, "FieldQuery");
     result.setAttribute("from", from);
     result.setAttribute("type", "query");
@@ -311 +311 @@
     // where the mgpp text files are
     String basedir = GSFile.collectionBaseDir(site_home_, 
-                          collection_name_);
-    String textdir = GSFile.collectionTextPath(collection_name_);
+                          cluster_name_);
+    String textdir = GSFile.collectionTextPath(cluster_name_);
 
     // an empty result
     Element result = doc_.createElement("response");
-    String from = GSPath.appendLink(collection_name_, "ResourceRetrieve");
+    String from = GSPath.appendLink(cluster_name_, "ResourceRetrieve");
     result.setAttribute("from", from);
     result.setAttribute("type", "query");
@@ -409 +409 @@
     protected Element processMetadataRetrieve(Element request) {
     Element result = doc_.createElement("response");
-    String from = GSPath.appendLink(collection_name_, "MetadataRetrieve");
+    String from = GSPath.appendLink(cluster_name_, "MetadataRetrieve");
     result.setAttribute("from", from);
     result.setAttribute("type", "query");

trunk/gsdl3/src/java/org/greenstone/gsdl3/service/PhindService.java

@@ -77 +77 @@
     String app_info = "<applet CODEBASE='lib/java' CODE='org.greenstone.applet.phind.Phind.class' ARCHIVE='phind.jar, xercesImpl.jar, gsdl3.jar, jaxp.jar, xml-apis.jar' WIDTH='500' HEIGHT='400'><PARAM NAME='library' VALUE=''/> <PARAM NAME='phindcgi' VALUE='?a=a&amp;sa=r&amp;sn=Phind'/>";
     app_info +="<PARAM NAME='collection'   VALUE='";
-    app_info += collection_name_;
+    app_info += cluster_name_;
     app_info += "'/> <PARAM NAME='classifier' VALUE='1'/>  <PARAM NAME='orientation'  VALUE='vertical'/> <PARAM NAME='depth' VALUE='2'/> <PARAM NAME='resultorder' VALUE='L,l,E,e,D,d'/> <PARAM NAME='backdrop' VALUE='interfaces/default/images/phindbg1.jpg'/><PARAM NAME='fontsize' VALUE='10'/> <PARAM NAME='blocksize'    VALUE='10'/>The Phind java applet.</applet>";
     
@@ -115 +115 @@
     String phind_index = (String)params.get("pc");
     // the location of the mgpp database files
-    basepath_ = GSFile.phindBaseDir(site_home_, collection_name_, phind_index);
+    basepath_ = GSFile.phindBaseDir(site_home_, cluster_name_, phind_index);
 
     // the result element
     Element result = doc_.createElement("response");
-    String from = GSPath.appendLink(collection_name_, "PhindApplet");
+    String from = GSPath.appendLink(cluster_name_, "PhindApplet");
     result.setAttribute("from", from);
     result.setAttribute("type", "query");

trunk/gsdl3/src/java/org/greenstone/gsdl3/service/ServiceModule.java

@@ -40 +40 @@
  * ServiceModule - abstract base class 
  *
- * A ServiceModule provides Services to a collection/system. 
+ * A ServiceModule provides Services to a collection/cluster/site. 
  * It may provide more than one Service. for eg
  * MGGDBMServiceModule may support "DocRetrieve", "TextQuery", "MetadataRetrieve" services
@@ -50 +50 @@
     implements ModuleInterface
 {
+
+
     /** the absolute address of the site home */
     protected String site_home_ =null;
-    /** the name of the collection directory that this service belongs to -
+    /** the name of the cluster that this service belongs to -
     if any */ 
-    protected String collection_name_ = null;
+    protected String cluster_name_ = null;
 
     /** some services can talk back to the message router */
@@ -72 +74 @@
     protected HashMap service_info_map_ = null;
 
+    /** sets the cluster name */
+    public void setClusterName(String cluster_name) {
+    cluster_name_ = cluster_name;
+    }
     /** sets the collect name */
     public void setCollectionName(String coll_name) {
-    collection_name_ = coll_name;
+    setClusterName(coll_name);
     }
     
@@ -95 +101 @@
     }
     
-    /**
-     * Configure the object. - default method for service modules
-     *
-     * reads either collection (if a collection name has been set), or system 
-     * configuration file, and configures itself
-     * this calls configure(Element) with the XML element node from the config
-     * file.
-     * configure(Element) should be used if the config file has already been 
-     * parsed.  This method will work with any subclass.
-     * 
-     * @return true if configure successful, false otherwise.
-     */
-    public boolean configure(){
-    
-    if (site_home_==null) {
-        System.err.println("setSiteHome() must be called before configure()");
-        return false;
-    }
-
-    File config_file=null;
-    if (collection_name_ !=null) {
-        
-        config_file = new File(GSFile.collectionBuildConfigFile(site_home_, collection_name_));
-    }
-    else {
-        config_file = new File(GSFile.siteConfigFile(site_home_));
-    }
-
-    if (config_file.exists() ) {
-        
-        Document doc = converter_.getDOM(config_file);
-        
-        try {
-        // get the service list and look for own service
-        // Note: XPathAPI is slow apparently
-        String xpath = "//ServiceModule[@name='"+this.getClass().getName()+"']";
-        System.out.println("xpath="+xpath);
-        Node n = XPathAPI.selectSingleNode(doc, xpath);
-        if (n !=null) {
-            return this.configure((Element)n);
-        }
-        } catch (Exception e) {
-        System.err.println("ServiceModule configure exception: "+e.getMessage());
-        return false;
-        }
-    }
-    System.err.println("ServiceModule error: unable to configure ServiceModule " + this.getClass().getName() );
-    return false;
-    
-    
-    } 
-
-    /** The configure method that does the real work
+
+    /** configure the service module
      *
      * @param info the XML node <serviceModule name="XXX"/> with name equal