Changeset 15485

Timestamp:

2008-05-15T13:32:29+12:00 (16 years ago)

Author:

ak19

Message:

Added in basicQuery method and merged query with protected queryProcess method

File:

• other-projects/trunk/gs3-webservices-democlient/src/GS3DemoClient/org/greenstone/gs3services/QBRSOAPServer.java (modified) (7 diffs)

other-projects/trunk/gs3-webservices-democlient/src/GS3DemoClient/org/greenstone/gs3services/QBRSOAPServer.java

@@ -35 +35 @@
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
+import org.w3c.dom.NodeList;
 
 import org.greenstone.gsdl3.core.MessageRouter;
@@ -288 +289 @@
         return this.processInternal(message);
     }
-
+    
     /* (2) Process-type message, QUERY-TYPE SERVICES - p.45 */
     /** For executing a (process-type message) query-type service.
@@ -320 +321 @@
                     this.doc, name, value));
         }
-        return queryProcess(collection+"/"+service, lang, paramList);
-    }
-    
-    /** Values for field Names given in the paramList must exist for the 
-     * (Collection-)Service Query that this message is sent To (as given in the 
-     * 'to' argument). 
-     * @see <a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - page 45</a>
-     * @param to - the (Collection-)Service Query that this message is sent To 
-     * @param lang - the language of the display items in the response 
-     * @param paramList - XML Dom Element representing the list of field names, 
-     * and associated values required for executing the query. 
-     * For names of Greenstone-accepted arguments,
-     * @see <a href="http://wiki.greenstone.org/wiki/index.php/Actions_and_Arguments">Greenstone wiki - Actions and Arguments<a>
-    */
-    protected String queryProcess(String to, String lang, Element paramList) {
-        // must work with whatever Document was used to create the
-        // <paramList>: other elements must be created using this 
-        // document object too
-        Document ownerDoc = paramList.getOwnerDocument();
-        Element message = ownerDoc.createElement(GSXML.MESSAGE_ELEM);
+        
+        Element message = this.doc.createElement(GSXML.MESSAGE_ELEM);
         Element request = GSXML.createBasicRequest(
-                ownerDoc, GSXML.REQUEST_TYPE_PROCESS, to, lang, "");
+                this.doc, GSXML.REQUEST_TYPE_PROCESS, 
+                collection+"/"+service, lang, "");
         
         request.appendChild(paramList);
@@ -348 +332 @@
         // Send it off to the Message Router and return the response
         return this.processInternal(message);
+    }
+    
+    /** 
+     * This method is used to perform the most basic query of them:
+     * it assumes defaults for all other parameters and provides only
+     * the query string. It is built on top of a TextQuery.
+     * @param collection is the Greenstone collection to be searched
+     * @param lang is the preferred language of the display content in 
+     * the response to be returned.
+     * @param query is the string to be sought in the Greenstone collection
+     * @return a Greenstone 3 XML response message for the query specifying 
+     * the search results.
+     */
+    public String basicQuery(String collection, String lang, String query) {
+        // The basicQuery is built on top of the TextQuery service
+        final String queryService = "TextQuery";
+        
+        // (1) describe request on the TextQuery
+        String queryDescription = describeCollectionService(
+                collection, queryService, "en", "paramList"); // just get paramList
+        //System.out.println(queryDescription);
+        
+        Document doc = this.converter.getDOM(queryDescription);
+        NodeList nl = doc.getElementsByTagName(
+                GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
+        
+        Element paramList = null;
+        if(nl.getLength() <= 0) { // no paramList in textQuery description means
+                // no query field either: that means we can't continue
+            return this.error("BasicQuery is not available for this collection" 
+                + " as it provides no TextQuery service.");
+        } //else
+        
+        paramList = (Element)nl.item(0);
+        nl = paramList.getElementsByTagName(GSXML.PARAM_ELEM);
+        if(nl.getLength() <= 0) { // no params, means no query field, so return
+            return this.error("BasicQuery is not available for this collection.");
+        }
+        
+        // (2) get the defaults for each parameter and use that to set
+        // the defaults
+        Map params = new HashMap(nl.getLength()); // field name to value map
+        for(int i = 0; i < nl.getLength(); i++) {
+            Element param = (Element)nl.item(i);
+            String paramName = param.getAttribute(GSXML.NAME_ATT);
+            String def = param.getAttribute(GSXML.DEFAULT_ATT);
+            if(def.equals("")) { 
+                // if there's no default, the field must want the query String
+                params.put(paramName, query);
+            } else { // there is a default, use the default for this param
+                params.put(paramName, def);
+            }
+        }
+        
+        // (3) Perform the query using defaults and return the response
+        return this.query(collection, queryService, lang, params);
     }
         
@@ -782 +822 @@
         System.out.println(ws.describeService("AddItem", "", ""));
                 
-        // (2) try 3 query methods (simplerFieldQuery twice) + getFieldNameMappings()
+        // (2) try 2 query methods: query and basicQuery
         HashMap map = new HashMap();
         map.put("maxDocs", "100");
@@ -796 +836 @@
         System.out.println("Regular query: " + response);
         
+        // basicQuery
+        response = ws.basicQuery("gs2mgppdemo", "", "cat");
+        System.out.println("Basic query on 'cat' over collection gs2mgppdemo:"
+                + response);
+
         // (3) try 2 browse
         System.out.println("describe browse:\n" 
@@ -854 +899 @@
         System.out.println(ws.helpWithMethod("helpWithMethod"));
 
+        
         System.out.println("Finished executing");