Changeset 9266

Timestamp:

2005-03-03T16:25:02+13:00 (19 years ago)

Author:

kjdon

Message:

added a does chunking flag - whether or not the service provides maxdocs to return. put default implementations for some of the abstract methods, so new classes don't need to implement them

File:

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

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

@@ -46 +46 @@
     // compulsory params
     protected static final String INDEX_PARAM = "index";
+    protected static final String QUERY_PARAM = "query";
+
+    // optional standard params - some of these have to be implemented
     protected static final String MAXDOCS_PARAM = "maxDocs";
-    protected static final String QUERY_PARAM = "query";
-
-    // optional standard params
     protected static final String HITS_PER_PAGE_PARAM = "hitsPerPage";
     protected static final String START_PAGE_PARAM = "startPage";
@@ -64 +64 @@
 
     protected boolean does_paging = false;
+    protected boolean does_chunking = true;
     protected String default_document_type = null;
 
@@ -70 +71 @@
     }
 
+    /** sets up the short service info for TextQuery. If other services 
+     * will be provided, should be added in the subclass configure
+     * also looks for search format info, and document format info
+     */
     public boolean configure(Element info, Element extra_info)
     {
@@ -122 +127 @@
     }
     
+    /** returns the description of the TextQuery service. If a subclass 
+     * provides other services they need to provides their own descriptions */
     protected Element getServiceDescription(String service, String lang, String subset) 
     {
@@ -146 +153 @@
     }
     
-    abstract protected Element processTextQuery(Element request); 
-    
-    
+    /** adds the standard query params into the service description */
     protected void addStandardQueryParams(Element param_list, String lang) 
     {
     createParameter(INDEX_PARAM, param_list, lang);
-    createParameter(MAXDOCS_PARAM, param_list, lang);
+    if (does_chunking) {
+        createParameter(MAXDOCS_PARAM, param_list, lang);
+    }
     if (does_paging) {
         createParameter(HITS_PER_PAGE_PARAM, param_list, lang);
@@ -160 +167 @@
     }
 
-    
+    /** adds any service specific query params into the service
+     *  default implementation: add nothing. subclasses may need to 
+     * override this to add in their specific parameters
+     */
     protected void addCustomQueryParams(Element param_list, String lang) 
     {
@@ -253 +263 @@
     }
 
-    abstract protected void getIndexData(ArrayList index_ids, ArrayList index_names, String lang);
 
     /** returns the document type of the doc that the specified node 
@@ -260 +269 @@
     GSXML.DOC_TYPE_PAGED, 
     GSXML.DOC_TYPE_HIERARCHY
+    default implementation returns GSXML.DOC_TYPE_SIMPLE, over ride 
+    if documents can be hierarchical
     */
-    abstract protected String getDocType(String node_id);
+    protected String getDocType(String node_id) {
+    return GSXML.DOC_TYPE_SIMPLE;
+    }
     
-    /** returns true if the node has child nodes */
-    abstract protected boolean hasChildren(String node_id);
-    /** returns true if the node has a parent */
-    abstract protected boolean hasParent(String node_id);
-
- }
-
+    /** returns true if the node has child nodes 
+     * default implementation returns false, over ride if documents can be 
+     * hierarchical 
+     */
+    protected boolean hasChildren(String node_id) {
+    return false;
+    }
+    /** returns true if the node has a parent 
+     * default implementation returns false, over ride if documents can be 
+     * hierarchical*/
+    protected boolean hasParent(String node_id) {
+    return false;
+    }
+
+    /** do the actual query 
+     * must be implemented by subclass */
+    abstract protected Element processTextQuery(Element request); 
+    
+    /** get the details about the indexes available
+     * must be implemented by subclass
+     * there must be at least one index */
+    abstract protected void getIndexData(ArrayList index_ids, ArrayList index_names, String lang);
+
+}
+