Changeset 24891 for main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/AbstractGS2FieldSearch.java

Timestamp:

2011-12-13T10:04:04+13:00 (12 years ago)

Author:

sjm84

Message:

Added the ability to perform a raw query (a query whose arguments are not parsed in any way)

File:

• main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/AbstractGS2FieldSearch.java (modified) (12 diffs)

main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/AbstractGS2FieldSearch.java

@@ -39 +39 @@
 abstract public class AbstractGS2FieldSearch extends AbstractGS2TextSearch
 {
-
     // extra services offered by mgpp collections
     protected static final String FIELD_QUERY_SERVICE = "FieldQuery";
     protected static final String ADVANCED_FIELD_QUERY_SERVICE = "AdvancedFieldQuery";
+    protected static final String RAW_QUERY_SERVICE = "RawQuery";
 
     // extra parameters used
@@ -51 +51 @@
     protected static final String SIMPLE_FIELD_PARAM = "simpleField";
     protected static final String ADVANCED_FIELD_PARAM = "complexField";
+
+    protected static final String RAW_PARAM = "rawquery";
 
     // more params for field query
@@ -68 +70 @@
     protected static final String SEARCH_TYPE_SIMPLE_FORM = "simpleform";
     protected static final String SEARCH_TYPE_ADVANCED_FORM = "advancedform";
+    protected static final String SEARCH_TYPE_RAW = "raw";
 
     protected static final String DEFAULT_LEVEL_ELEM = "defaultLevel";
@@ -77 +80 @@
     protected static final int SIMPLE_QUERY = 1;
     protected static final int ADVANCED_QUERY = 2;
+    protected static final int RAW_QUERY = 3;
 
     protected String AND_OPERATOR = "&";
@@ -90 +94 @@
     protected boolean simple_form_search = false;
     protected boolean advanced_form_search = false;
+    protected boolean raw_search = true;
 
     static Logger logger = Logger.getLogger(org.greenstone.gsdl3.service.AbstractGS2FieldSearch.class.getName());
@@ -166 +171 @@
                         this.advanced_form_search = true;
                     }
+                    else if (type_name.equals(SEARCH_TYPE_RAW))
+                    {
+                        this.raw_search = true;
+                    }
                 }
             }
@@ -242 +251 @@
         }
 
+        if (this.raw_search)
+        {
+            Element rq_service = this.doc.createElement(GSXML.SERVICE_ELEM);
+            rq_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
+            rq_service.setAttribute(GSXML.NAME_ATT, RAW_QUERY_SERVICE);
+            this.short_service_info.appendChild(rq_service);
+
+            if (format_info != null)
+            {
+                this.format_info_map.put(RAW_QUERY_SERVICE, format_info);
+            }
+        }
+
         return true;
     }
@@ -249 +271 @@
         // should we check that the service is actually on offer? presumably we wont get asked for services that we haven't advertised previously.
 
-        if (!service_id.equals(FIELD_QUERY_SERVICE) && !service_id.equals(ADVANCED_FIELD_QUERY_SERVICE))
+        if (!service_id.equals(FIELD_QUERY_SERVICE) && !service_id.equals(ADVANCED_FIELD_QUERY_SERVICE) && !service_id.equals(RAW_QUERY_SERVICE))
         {
             return super.getServiceDescription(service_id, lang, subset);
@@ -295 +317 @@
 
             }
-            else
+            else if (service_id.equals(ADVANCED_FIELD_QUERY_SERVICE))
             {
                 createParameter(LEVEL_PARAM, param_list, lang);
@@ -335 +357 @@
                 createParameter(FIELD_FIELD_PARAM, multiparam, lang);
 
+            }
+            else if (service_id.equals(RAW_QUERY_SERVICE))
+            {
+                if (does_chunking)
+                {
+                    createParameter(MAXDOCS_PARAM, param_list, lang);
+                }
+                if (does_paging)
+                {
+                    createParameter(HITS_PER_PAGE_PARAM, param_list, lang);
+                    createParameter(START_PAGE_PARAM, param_list, lang);
+                }
+                createParameter(RAW_PARAM, param_list, lang);
+                service.appendChild(param_list);
             }
         }
@@ -477 +513 @@
     {
         return processAnyQuery(request, ADVANCED_QUERY);
+    }
+
+    protected Element processRawQuery(Element request)
+    {
+        return processAnyQuery(request, RAW_QUERY);
     }
 
@@ -499 +540 @@
             empty_query_test_param = FIELD_QUERY_PARAM;
             break;
+        case RAW_QUERY:
+            service_name = RAW_QUERY_SERVICE;
+            empty_query_test_param = RAW_PARAM;
+            break;
         default:
             // should never get here