Changeset 7312 for trunk

Timestamp:

2004-05-12T14:04:09+12:00 (20 years ago)

Author:

kjdon

Message:

GS3REtrieve now is not abstract, and provides the structure and metadata retrieval services, while GS3MGRetrieve just provides the content retrieve service. soem small modifications for an updated collection format

Location:

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

Files:

• GS3MGRetrieve.java (modified) (6 diffs)
• GS3MGSearch.java (modified) (2 diffs)
• GS3Retrieve.java (modified) (12 diffs)
• GS3Search.java (modified) (5 diffs)

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

@@ -31 +31 @@
 
 
-/**
+/** The content retrieval class for GS3 building
  *
  * @author <a href="mailto:[email protected]">Katherine Don</a>
@@ -38 +38 @@
 
 public class GS3MGRetrieve
-    extends GS3Retrieve {
-
+    extends ServiceRack {
+    // the services on offer
+    protected static final String DOCUMENT_CONTENT_RETRIEVE_SERVICE = "DocumentContentRetrieve";
+    
     // Parameters used
     private static final String INDEX_PARAM = "index";
@@ -47 +49 @@
 
     private MGWrapper mg_src = null;
+    protected SQLQuery database = null;
+    
+    protected Element config_info = null; // the xml from the config file
 
     private String default_index = null;
-
 
     /** constructor */
     public GS3MGRetrieve()
     {
+    this.database = new SQLQuery();
     this.mg_src = new MGWrapper();
     }
@@ -61 +66 @@
     public boolean configure(Element info, Element extra_info)
     {
+    this.config_info = info;
     // Do specific configuration
     System.out.println("Configuring GS3MGRetrieve...");
@@ -75 +81 @@
         return false;
     }
+
     // System.out.println("Default index: " + this.default_index);
-
-    // Do generic configuration
-    return super.configure(info, extra_info);
-    }
-
-
+    Element dcr_service = this.doc.createElement(GSXML.SERVICE_ELEM);
+    dcr_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
+    dcr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_CONTENT_RETRIEVE_SERVICE);
+    this.short_service_info.appendChild(dcr_service);
+
+    // check that site_home is set
+    if (this.site_home == null || this.site_home.equals("")) {
+        System.err.println("GS3Retrieve Error: site_home is not set, so cannot work out the site name and cannot determine the database name");
+        return false;
+    }
+    String site_name = this.site_home.substring(this.site_home.lastIndexOf(File.separator)+1);
+    if (site_name.equals("")) {
+        System.err.println("GS3Retrieve Error: Cannot extract the site name from site home: "+this.site_home);
+        return false;
+    }
+    if (!database.setDatabase(site_name+"_"+this.cluster_name)) {
+        System.err.println("GS3Retrieve Error: Could not open SQL database!");
+        return false;
+    }
+
+    // look for document display format
+    String path = GSPath.appendLink(GSXML.DISPLAY_ELEM, GSXML.FORMAT_ELEM);
+    Element display_format = (Element)GSXML.getNodeByPath(extra_info, path);
+    if (display_format != null) {
+        this.format_info_map.put(DOCUMENT_CONTENT_RETRIEVE_SERVICE, this.doc.importNode(display_format, true));
+        // should we make a copy?
+    }
+
+    return true;
+    }
+
+    protected Element getServiceDescription(String service_id, String lang, String subset) {
+    if (service_id.equals(DOCUMENT_CONTENT_RETRIEVE_SERVICE)) {
+        Element dcr_service = this.doc.createElement(GSXML.SERVICE_ELEM);
+        dcr_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
+        dcr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_CONTENT_RETRIEVE_SERVICE);
+        return dcr_service;
+    }
+
+    return null;
+    }
     /** Retrieve the content of a document */
     protected Element processDocumentContentRetrieve(Element request)
@@ -117 +159 @@
         //ystem.out.println("getting doc id "+doc_ids[i]);
         String doc_id = doc_ids[i];
-        if (OID.needsTranslating(doc_id)) {
+        if (GS3OID.needsTranslating(doc_id)) {
         //doc_id = this.gdbm_src.translateOID(doc_id);
-        doc_id = translateOID(doc_id);
+        doc_id = GS3OID.translateOID(doc_id);
         //ystem.out.println("translated id = "+doc_id);
         }

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

@@ -49 +49 @@
 
     private MGWrapper mg_src = null;
-
 
     /** constructor */
@@ -140 +139 @@
     for (int d = 0; d < docs.size(); d++) {
         long docnum = ((MGDocInfo) docs.elementAt(d)).num_;
-        String mg_id = index+"."+docnum;
+        ////String mg_id = index+"."+docnum;
+        String mg_id = this.base_index_prefix+"."+docnum;
         String doc_id = database.MGNum2OID(mg_id);
+        // hack !!!
+        if (doc_id.endsWith("-All")) {
+        System.err.print("replacing doc id "+doc_id+" with ");
+        doc_id=doc_id.replaceAll("All","1");
+        System.err.println(doc_id);
+        }
+        
         //String doc_id = this.gdbm_src.docnum2Oid(docnum);
         Element doc_node = createDocumentNodeElement(doc_id);

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

@@ -37 +37 @@
 import java.util.ArrayList;
 
-/** Implements the generic retrieval and classifier services for GS3 
+/** Implements the generic structure and metadata retrieval and classifier services for GS3 
  * collections.
  *
@@ -45 +45 @@
  */
 
-public abstract class GS3Retrieve
+public class GS3Retrieve
     extends ServiceRack {
 
@@ -52 +52 @@
     protected static final String DOCUMENT_STRUCTURE_RETRIEVE_SERVICE = "DocumentStructureRetrieve";
     protected static final String DOCUMENT_METADATA_RETRIEVE_SERVICE = "DocumentMetadataRetrieve";
-    protected static final String DOCUMENT_CONTENT_RETRIEVE_SERVICE = "DocumentContentRetrieve";
-
 
     // the browsing services -  now in here, these will only be advertised if classifiers have been specified in the config file
@@ -76 +74 @@
     protected static final int CLASSIFIER=2;
 
-    //protected GDBMWrapper gdbm_src = null;
     protected SQLQuery database = null;
     
@@ -82 +79 @@
 
     /** constructor */
-    protected GS3Retrieve()
+    public GS3Retrieve()
     {
-    //this.gdbm_src = new GDBMWrapper();
     this.database = new SQLQuery();
     }
@@ -105 +101 @@
     dmr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_METADATA_RETRIEVE_SERVICE);
     this.short_service_info.appendChild(dmr_service);
-
-    Element dcr_service = this.doc.createElement(GSXML.SERVICE_ELEM);
-    dcr_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
-    dcr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_CONTENT_RETRIEVE_SERVICE);
-    this.short_service_info.appendChild(dcr_service);
 
     // open the database for querying
@@ -186 +177 @@
     }
 
-    // look for document display format
-    String path = GSPath.appendLink(GSXML.DISPLAY_ELEM, GSXML.FORMAT_ELEM);
-    Element display_format = (Element)GSXML.getNodeByPath(extra_info, path);
-    if (display_format != null) {
-        this.format_info_map.put(DOCUMENT_CONTENT_RETRIEVE_SERVICE, this.doc.importNode(display_format, true));
-        // should we make a copy?
-    }
     return true;
     }
@@ -272 +256 @@
         dmr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_METADATA_RETRIEVE_SERVICE);
         return dmr_service;
-    }
-
-    if (service_id.equals(DOCUMENT_CONTENT_RETRIEVE_SERVICE)) {
-        Element dcr_service = this.doc.createElement(GSXML.SERVICE_ELEM);
-        dcr_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
-        dcr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_CONTENT_RETRIEVE_SERVICE);
-        return dcr_service;
     }
 
@@ -598 +575 @@
         
         if (GS3OID.needsTranslating(doc_id)) {
-        doc_id = translateOID(doc_id);
+        doc_id = GS3OID.translateOID(doc_id);
         }
         if (type==DOCUMENT && GS3OID.isDocTop(doc_id)) {
@@ -756 +733 @@
         if (GS3OID.needsTranslating(node_id)) {
         //node_id = this.gdbm_src.translateOID(node_id);
-        node_id = translateOID(node_id);
+        node_id = GS3OID.translateOID(node_id);
         }
         
@@ -866 +843 @@
 //      }
     
-    /** Retrieve the content of a document - implemented by concrete subclasses */
-    protected abstract Element processDocumentContentRetrieve(Element request);
 
     /** needs to get info from gdbm database - if the calling code gets it already it may pay to pass it in instead */
@@ -930 +905 @@
 //      }
     
-    protected String translateOID(String oid) {
-    
-    int p = oid.lastIndexOf('.');
-    if (p != oid.length()-3) {
-        System.out.println("translateoid error: '.' is not the third to last char!!");
-        return oid;
-    }
-    
-    String top = oid.substring(0, p);
-    String suff = oid.substring(p+1);
-    if (suff.equals("pr")) {
-        return GS3OID.getParent(top);
-    } else if (suff.equals("rt")) {
-        return GS3OID.getTop(top);
-    } 
-    return oid;
-
-    }
     
 }   

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

@@ -32 +32 @@
 /**
  *
- * @author <a href="mailto:[email protected]">Michael Dewsnip</a>
+ * @author Katherine Don
  * @version $Revision$
  */
@@ -74 +74 @@
     /** the default index */
     protected String default_index = null;
-
+    /** the base index prefix */
+    protected String base_index_prefix = null;
 
     /** constructor */
@@ -80 +81 @@
     {
     this.database = new SQLQuery();
-    //this.gdbm_src = new GDBMWrapper();
     }
 
@@ -101 +101 @@
     }
 
+    // get the base prefix
+    def = (Element) GSXML.getChildByTagName(info, "baseIndexPrefix");
+    if (def != null) {
+        this.base_index_prefix = def.getAttribute(GSXML.NAME_ATT);
+    }
+    if (this.base_index_prefix == null || this.base_index_prefix.equals("")) {
+        System.err.println("Error: base index prefix not specified!");
+        return false;
+    }
     // these entries should reflect the build config file - some services may not be available depending on how the collection was built.
     // set up short_service_info_ - for now just has id and type. the name (lang dependent) will be added in if the list is requested.
@@ -108 +117 @@
     this.short_service_info.appendChild(tq_service);
 
-
-    // Open GDBM database for querying
-    //String gdbm_db_file = GSFile.GDBMDatabaseFile(this.site_home, this.cluster_name);
-    //if (!this.gdbm_src.openDatabase(gdbm_db_file, GDBMWrapper.READER)) {
-    //    System.err.println("Error: Could not open GDBM database!");
-    //    return false;
-    //}
     // open the database for querying
     // the database name is a combination of site name and collection name