Changeset 4903 for trunk/gsdl3/src/java/org/greenstone/gsdl3/service/GS2Retrieve.java

Timestamp:

2003-07-11T16:29:16+12:00 (21 years ago)

Author:

kjdon

Message:

tidied up a lot of stuff, particularly the display text stuff, including how its formatted, and some of the service rack methods

File:

• trunk/gsdl3/src/java/org/greenstone/gsdl3/service/GS2Retrieve.java (modified) (8 diffs)

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

@@ -75 +75 @@
 
     protected GDBMWrapper gdbm_src_ = null;
-    
     protected Element config_info_ = null; // the xml from the config file
 
@@ -106 +105 @@
     dcr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_CONTENT_RETRIEVE_SERVICE);
     short_service_info_.appendChild(dcr_service);
-
-    // set up service_info_map_ - for now, just has the same elements as above
-    // should have full details about each service incl params lists etc.
-    service_info_map_.put(DOCUMENT_STRUCTURE_RETRIEVE_SERVICE, dsr_service);
-    service_info_map_.put(DOCUMENT_METADATA_RETRIEVE_SERVICE, dmr_service);
-    service_info_map_.put(DOCUMENT_CONTENT_RETRIEVE_SERVICE, dcr_service);
 
     // Open GDBM database for querying
@@ -146 +139 @@
         short_service_info_.appendChild(cbmr_service);
 
-        // service_info_map_
-
-    // the metadata one has the same info for now  - should this advertise what metadata is available??
-    Element cbmr_service_info = (Element) cbmr_service.cloneNode(true);
-    service_info_map_.put(CLASSIFIER_METADATA_SERVICE, cbmr_service_info);
-
-    //the browse one
-    Element cb_service_info = (Element)cb_service.cloneNode(true);
-    Element cl_list = doc_.createElement(GSXML.CLASSIFIER_ELEM+GSXML.LIST_MODIFIER);
-    cb_service_info.appendChild(cl_list);
-    
     // the format info
     Element cb_format_info = doc_.createElement(GSXML.FORMAT_ELEM);
@@ -166 +148 @@
         Element new_cl = (Element)doc_.importNode(cl, false); // just import this node, not the children
         
-        cl_list.appendChild(new_cl);
-
         // get the format info out, and put inside a classifier element
         Element format_cl = (Element)new_cl.cloneNode(false);
@@ -185 +165 @@
     }
         
-    
-    service_info_map_.put(CLASSIFIER_SERVICE, cb_service_info);
     if (format_found) {
         format_info_map_.put(CLASSIFIER_SERVICE, cb_format_info);
@@ -201 +179 @@
     return true;
     }
-    
+
+    protected Element getServiceDescription(String service_id, String lang) {
+
+    if (service_id.equals(CLASSIFIER_SERVICE)) {
+        
+        Element class_list = (Element)GSXML.getChildByTagName(config_info_, GSXML.CLASSIFIER_ELEM+GSXML.LIST_MODIFIER);
+        if (class_list == null) {
+            // no classifiers specified
+        return null;
+        }
+        
+        Element cb_service = doc_.createElement(GSXML.SERVICE_ELEM);
+        cb_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_BROWSE);
+        cb_service.setAttribute(GSXML.NAME_ATT, CLASSIFIER_SERVICE);
+        cb_service.appendChild(GSXML.createDisplayTextElement(doc_, GSXML.DISPLAY_TEXT_NAME,  getTextString(CLASSIFIER_SERVICE+".name", lang)));
+        
+        Element cl_list = doc_.createElement(GSXML.CLASSIFIER_ELEM+GSXML.LIST_MODIFIER);
+        cb_service.appendChild(cl_list);
+        NodeList classifiers = class_list.getElementsByTagName(GSXML.CLASSIFIER_ELEM);
+        for(int i=0; i<classifiers.getLength(); i++) {
+        Element cl = (Element)classifiers.item(i);
+        Element new_cl = (Element)doc_.importNode(cl, false); // just import this node, not the children
+        
+        cl_list.appendChild(new_cl);
+        String text = GSXML.getDisplayText(cl, 
+                        GSXML.DISPLAY_TEXT_NAME, 
+                        lang, "en");
+        if (text == null || text.equals("")) {
+            // no display element was specified, use the metadata name
+            // for now this looks in the class properties file
+            // this needs to use a general metadata thing instead
+            text = getTextString(cl.getAttribute(GSXML.CLASSIFIER_CONTENT_ATT), lang);
+        }
+        
+        Element cl_name = GSXML.createDisplayTextElement(doc_, GSXML.DISPLAY_TEXT_NAME, text);
+        new_cl.appendChild(cl_name);
+        
+        }
+        return cb_service;
+    }
+    
+    // these ones are probably never called, but put them here just in case
+    
+    if (service_id.equals(CLASSIFIER_METADATA_SERVICE)) {
+        
+        Element cbmr_service = doc_.createElement(GSXML.SERVICE_ELEM);
+        cbmr_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
+        cbmr_service.setAttribute(GSXML.NAME_ATT, CLASSIFIER_METADATA_SERVICE);
+        return cbmr_service;
+    }
+
+    if (service_id.equals(DOCUMENT_STRUCTURE_RETRIEVE_SERVICE)) {
+        Element dsr_service = doc_.createElement(GSXML.SERVICE_ELEM);
+        dsr_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
+        dsr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_STRUCTURE_RETRIEVE_SERVICE);
+        return dsr_service;
+    }
+    if (service_id.equals(DOCUMENT_METADATA_RETRIEVE_SERVICE)) {
+        Element dmr_service = doc_.createElement(GSXML.SERVICE_ELEM);
+        dmr_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
+        dmr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_METADATA_RETRIEVE_SERVICE);
+        return dmr_service;
+    }
+
+    if (service_id.equals(DOCUMENT_CONTENT_RETRIEVE_SERVICE)) {
+        Element dcr_service = 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;
+    }
+
     /** this looks for any classifier specific display or format info from extra_info and adds it in to the correct place in info */
     protected boolean extractExtraClassifierInfo(Element info, Element extra_info) {
@@ -227 +278 @@
         
         // get the display elements if any - displayName
-        NodeList display_names = node_extra.getElementsByTagName(GSXML.DISPLAYNAME_ELEM);
+        NodeList display_names = node_extra.getElementsByTagName(GSXML.DISPLAY_TEXT_ELEM);
         if (display_names !=null) {
         Element display = owner.createElement(GSXML.DISPLAY_ELEM);
         for (int j=0; j<display_names.getLength(); j++) {
             Element e = (Element)display_names.item(j);
+            cl.appendChild(owner.importNode(e, true));
             
-            Element display_name = GSXML.createTextElement(owner, GSXML.DISPLAY_NAME_ELEM, GSXML.getNodeText(e));
-            display_name.setAttribute(GSXML.LANG_ATT, e.getAttribute(GSXML.LANG_ATT));
-            display.appendChild(display_name);
-        }
-        cl.appendChild(display);
+        }
         }
         
@@ -253 +301 @@
     }
         
-
-    /** creates a display element containing all the text strings needed to display the service page, in the language specified 
-     * the retrieval services dont get displayed to the users - they are only used internally by the actions. so this returns an empty display element
-     * for those services. CLASSIFIER_BROWSE service returns some info */
-    protected Element createServiceDisplay(String service, String lang)
-    {
-    Element display = doc_.createElement(GSXML.DISPLAY_ELEM);
-    if (!service.equals(CLASSIFIER_SERVICE)) {
-        return display;
-    }
-
-    // CLASSIFIER_SERVICE
-    display.appendChild(GSXML.createTextElement(doc_, GSXML.DISPLAY_NAME_ELEM,  getTextString(service+".name", lang)));
-    //display.appendChild(GSXML.createTextElement(doc_,  GSXML.DISPLAY_SUBMIT_ELEM, getTextString(service+".submit", lang)));
-    
-    // need to add in the classifier name info
-    // add <classifier name="CL1">text name</classifier> to the 
-    // display node
-    NodeList classifiers = config_info_.getElementsByTagName(GSXML.CLASSIFIER_ELEM);
-    for (int i=0; i<classifiers.getLength(); i++) {
-        Element cl = (Element)classifiers.item(i);
-        Element disp = (Element)GSXML.getChildByTagName(cl, GSXML.DISPLAY_ELEM);
-        String text = null;
-        if (disp !=null) {
-        text = GSXML.getDisplayText(disp, 
-                        GSXML.DISPLAY_NAME_ELEM, 
-                        lang, "en");
-        }
-        if (text == null || text.equals("")) {
-        // no display element was specified, use the metadata name
-        // for now this looks in the class properties file
-        // this needs to use a general metadata thing instead
-        text = getTextString(cl.getAttribute(GSXML.CLASSIFIER_CONTENT_ATT), lang);
-        }
-        
-        Element cl_elem = doc_.createElement(GSXML.CLASSIFIER_ELEM);
-        cl_elem.setAttribute(GSXML.NAME_ATT, cl.getAttribute(GSXML.NAME_ATT));
-        Element cl_name = GSXML.createTextElement(doc_, GSXML.DISPLAY_NAME_ELEM, text);
-        cl_elem.appendChild(cl_name);
-        
-        display.appendChild(cl_elem);
-        
-    }
-    
-    return display;
-    
-    }
 
     /** parent is true if this node is definitely the  parent of something,