source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/AbstractGS2FieldSearch.java@ 21437

Last change on this file since 21437 was 21437, checked in by davidb, 14 years ago

Removal of import statement.
  • Property svn:keywords set to Author Date Id Revision
File size: 24.9 KB
Line 
1/*
2 * AbstractGS2FieldSearch.java
3 * Copyright (C) 2006 New Zealand Digital Library, http://www.nzdl.org
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 */
18package org.greenstone.gsdl3.service;
19
20
21// Greenstone classes
22import org.greenstone.gsdl3.util.*;
23
24// XML classes
25import org.w3c.dom.Document;
26import org.w3c.dom.Element;
27import org.w3c.dom.NodeList;
28
29// java classes
30import java.util.Iterator;
31import java.util.Set;
32import java.util.HashMap;
33import java.util.Map;
34import java.util.ArrayList;
35import java.util.Vector;
36import java.io.File;
37
38import org.apache.log4j.*;
39
40
41abstract public class AbstractGS2FieldSearch
42 extends AbstractGS2Search
43{
44
45 // extra services offered by mgpp collections
46 protected static final String FIELD_QUERY_SERVICE = "FieldQuery";
47 protected static final String ADVANCED_FIELD_QUERY_SERVICE = "AdvancedFieldQuery";
48
49 // extra parameters used
50 protected static final String LEVEL_PARAM = "level";
51 protected static final String RANK_PARAM = "sortBy";
52 protected static final String RANK_PARAM_RANK = "1";
53 protected static final String RANK_PARAM_NONE = "0";
54 protected static final String SIMPLE_FIELD_PARAM = "simpleField";
55 protected static final String ADVANCED_FIELD_PARAM = "complexField";
56
57 // more params for field query
58 protected static final String FIELD_QUERY_PARAM = "fqv";
59 protected static final String FIELD_STEM_PARAM = "fqs";
60 protected static final String FIELD_CASE_PARAM = "fqc";
61 protected static final String FIELD_ACCENT_PARAM="fqa";
62 protected static final String FIELD_FIELD_PARAM = "fqf";
63 protected static final String FIELD_COMBINE_PARAM = "fqk";
64 protected static final String FIELD_COMBINE_PARAM_AND = "0";
65 protected static final String FIELD_COMBINE_PARAM_OR = "1";
66 protected static final String FIELD_COMBINE_PARAM_NOT = "2";
67
68 // some stuff for config files
69 protected static final String SEARCH_TYPE_ELEM = "searchType";
70 protected static final String SEARCH_TYPE_PLAIN = "plain";
71 protected static final String SEARCH_TYPE_FORM = "form";
72 protected static final String SEARCH_TYPE_FORM_SIMPLE = "simple";
73 protected static final String SEARCH_TYPE_FORM_ADVANCED = "advanced";
74
75 protected static final String DEFAULT_LEVEL_ELEM = "defaultLevel";
76 protected static final String DEFAULT_DB_LEVEL_ELEM = "defaultDBLevel";
77 protected static final String LEVEL_ELEM = "level";
78 protected static final String FIELD_ATT = "field";
79
80
81 protected static final int TEXT_QUERY = 0;
82 protected static final int SIMPLE_QUERY = 1;
83 protected static final int ADVANCED_QUERY = 2;
84
85 protected String AND_OPERATOR = "&";
86 protected String OR_OPERATOR = "|";
87 protected String NOT_OPERATOR = "!";
88
89 // the default level for searching
90 protected String default_level=null;
91 // default level for collection db
92 protected String default_db_level = null;
93 // which search services will we offer??
94 protected boolean plain_search = false;
95 protected boolean simple_form_search = false;
96 protected boolean advanced_form_search = false;
97
98
99 static Logger logger = Logger.getLogger(org.greenstone.gsdl3.service.AbstractGS2FieldSearch.class.getName());
100
101 /** constructor */
102 public AbstractGS2FieldSearch()
103 {
104 }
105
106 public void cleanUp() {
107 super.cleanUp();
108 }
109
110 /** configure this service */
111 public boolean configure(Element info, Element extra_info)
112 {
113 if (!super.configure(info, extra_info)){
114 return false;
115 }
116 // the generic config has set up the text query service, but we may not want it
117 Element search_type_list = (Element) GSXML.getChildByTagName(info, SEARCH_TYPE_ELEM + GSXML.LIST_MODIFIER);
118 if (search_type_list == null) {
119 // assume form and plain
120 this.plain_search = true;
121 this.simple_form_search = true;
122 this.advanced_form_search = true;
123 } else {
124 NodeList types = search_type_list.getElementsByTagName(SEARCH_TYPE_ELEM);
125 for (int i=0; i<types.getLength(); i++) {
126 Element t = (Element)types.item(i);
127 String type_name = t.getAttribute(GSXML.NAME_ATT);
128 if (type_name.equals(SEARCH_TYPE_PLAIN)) {
129 this.plain_search = true;
130 } else if (type_name.equals(SEARCH_TYPE_FORM)) {
131 String type_type = t.getAttribute(GSXML.TYPE_ATT);
132 if (type_type.equals("")) {
133 this.simple_form_search = true;
134 this.advanced_form_search = true;
135 } else if (type_type.equals(SEARCH_TYPE_FORM_SIMPLE)) {
136 this.simple_form_search = true;
137 } else if (type_type.equals(SEARCH_TYPE_FORM_ADVANCED)) {
138 this.advanced_form_search = true;
139
140 }
141 }
142 }
143 }
144
145 if (!this.plain_search) {
146 // need to remove the TextQuery service
147 Element tq_service = GSXML.getNamedElement(short_service_info, GSXML.SERVICE_ELEM, GSXML.NAME_ATT, TEXT_QUERY_SERVICE);
148 short_service_info.removeChild(tq_service);
149
150 }
151
152
153 // Get the default level out of <defaultLevel> (buildConfig.xml)
154 Element def = (Element) GSXML.getChildByTagName(info, DEFAULT_LEVEL_ELEM);
155 if (def != null) {
156 this.default_level = def.getAttribute(GSXML.SHORTNAME_ATT);
157 }
158 if (this.default_level == null || this.default_level.equals("")) {
159 logger.error("default level not specified!, assuming Doc");
160 this.default_level = "Doc";
161 }
162
163 // Get the default DB level
164 def = (Element) GSXML.getChildByTagName(info, DEFAULT_DB_LEVEL_ELEM);
165 if (def != null) {
166 this.default_db_level = def.getAttribute(GSXML.SHORTNAME_ATT);
167 }
168 if (this.default_db_level == null || this.default_db_level.equals("")) {
169 logger.error("default database level (defaultDBLevel) not specified!, assuming Sec");
170 this.default_db_level = "Sec";
171 }
172
173 // get display info from extra info - for levels
174 if (extra_info !=null) {
175 Document owner = info.getOwnerDocument();
176
177 NodeList levels = info.getElementsByTagName(GSXML.LEVEL_ELEM);
178 Element config_search = (Element)GSXML.getChildByTagName(extra_info, GSXML.SEARCH_ELEM);
179
180 for (int i=0; i<levels.getLength();i++) {
181 Element lev = (Element)levels.item(i);
182 String name = lev.getAttribute(GSXML.NAME_ATT);
183 Element node_extra = GSXML.getNamedElement(config_search,
184 GSXML.LEVEL_ELEM,
185 GSXML.NAME_ATT,
186 name);
187 if (node_extra == null) {
188 logger.error("haven't found extra info for level named "+name);
189 continue;
190 }
191
192 // get the display elements if any - displayName
193 NodeList display_names = node_extra.getElementsByTagName(GSXML.DISPLAY_TEXT_ELEM);
194 if (display_names !=null) {
195 for (int j=0; j<display_names.getLength(); j++) {
196 Element e = (Element)display_names.item(j);
197 lev.appendChild(owner.importNode(e, true));
198 }
199 }
200 } // for each level
201 }
202
203 // the format info is the same for all services
204 Element format_info = (Element)format_info_map.get(TEXT_QUERY_SERVICE);
205
206 // set up the extra services which are available for this collection
207 if (this.simple_form_search) {
208 // set up short_service_info_ - for now just has id and type - name will be added in on the fly
209 Element fq_service = this.doc.createElement(GSXML.SERVICE_ELEM);
210 fq_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
211 fq_service.setAttribute(GSXML.NAME_ATT, FIELD_QUERY_SERVICE);
212 this.short_service_info.appendChild(fq_service);
213
214 if (format_info != null) {
215 this.format_info_map.put(FIELD_QUERY_SERVICE, format_info);
216 }
217 }
218
219 if (this.advanced_form_search) {
220 Element afq_service = this.doc.createElement(GSXML.SERVICE_ELEM);
221 afq_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
222 afq_service.setAttribute(GSXML.NAME_ATT, ADVANCED_FIELD_QUERY_SERVICE);
223 this.short_service_info.appendChild(afq_service);
224
225 if (format_info != null) {
226 this.format_info_map.put(ADVANCED_FIELD_QUERY_SERVICE, format_info);
227 }
228 }
229
230 return true;
231 }
232
233
234 protected Element getServiceDescription(String service_id, String lang, String subset) {
235 // should we check that the service is actually on offer? presumably we wont get asked for services that we haven't advertised previously.
236
237 if (!service_id.equals(FIELD_QUERY_SERVICE) && !service_id.equals(ADVANCED_FIELD_QUERY_SERVICE)) {
238 return super.getServiceDescription(service_id, lang, subset);
239 }
240
241
242 Element service = this.doc.createElement(GSXML.SERVICE_ELEM);
243 service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
244 service.setAttribute(GSXML.NAME_ATT, service_id);
245 if (subset == null || subset.equals(GSXML.DISPLAY_TEXT_ELEM+GSXML.LIST_MODIFIER)) {
246 service.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_NAME, getTextString(service_id+".name", lang)));
247 service.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_SUBMIT, getTextString(service_id+".submit", lang)));
248 service.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_DESCRIPTION, getTextString(service_id+".description", lang)));
249
250 }
251 if (subset == null || subset.equals(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER)) {
252 Element param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
253 service.appendChild(param_list);
254 if (service_id.equals(FIELD_QUERY_SERVICE)) {
255
256 addCustomQueryParams(param_list, lang);
257 createParameter(MAXDOCS_PARAM, param_list, lang);
258 if (!default_index_subcollection.equals("")){
259 createParameter(INDEX_SUBCOLLECTION_PARAM,param_list, lang);
260 }
261 if (!default_index_language.equals("")){
262 createParameter(INDEX_LANGUAGE_PARAM,param_list, lang);
263 }
264 // create a multi param for the fields etc
265 // text box, field
266 Element multiparam = null;
267 Element param=null;
268 multiparam = GSXML.createParameterDescription(this.doc, SIMPLE_FIELD_PARAM, "", GSXML.PARAM_TYPE_MULTI, null, null, null);
269 multiparam.setAttribute("occurs", "4");
270 param_list.appendChild(multiparam);
271
272 // the components
273
274 createParameter(FIELD_QUERY_PARAM, multiparam, lang);
275 createParameter(FIELD_FIELD_PARAM, multiparam, lang);
276
277 } else {
278 createParameter(LEVEL_PARAM, param_list, lang);
279 createParameter(RANK_PARAM, param_list, lang);
280 createParameter(MAXDOCS_PARAM, param_list, lang);
281 if (!default_index_subcollection.equals("")){
282 createParameter(INDEX_SUBCOLLECTION_PARAM,param_list, lang);
283 }
284 if (!default_index_language.equals("")){
285 createParameter(INDEX_LANGUAGE_PARAM,param_list, lang);
286 }
287
288 // create a multi param for the fields etc
289 // text box, stem, case, field
290
291 Element multiparam = null;
292 Element param=null;
293
294 multiparam = GSXML.createParameterDescription(this.doc, ADVANCED_FIELD_PARAM, "", GSXML.PARAM_TYPE_MULTI, null, null, null);
295 multiparam.setAttribute("occurs", "4");
296 param_list.appendChild(multiparam);
297
298 createParameter(FIELD_COMBINE_PARAM, multiparam, lang);
299 createParameter(FIELD_QUERY_PARAM, multiparam, lang);
300 if (this.does_case) {
301 createParameter(FIELD_CASE_PARAM, multiparam, lang);
302 }
303 if (this.does_stem) {
304 createParameter(FIELD_STEM_PARAM, multiparam, lang);
305 }
306 if (this.does_accent) {
307 createParameter(FIELD_ACCENT_PARAM, multiparam, lang);
308 }
309 createParameter(FIELD_FIELD_PARAM, multiparam, lang);
310
311 }
312 }
313 return service;
314
315 }
316
317 /** add in the level params to TextQuery */
318 protected void addCustomQueryParams(Element param_list, String lang)
319 {
320 createParameter(LEVEL_PARAM, param_list, lang);
321 super.addCustomQueryParams(param_list, lang);
322 }
323
324 /** create a param and add to the list */
325 protected void createParameter(String name, Element param_list, String lang)
326 {
327 Element param = null;
328 if (name.equals(LEVEL_PARAM)) {
329 ArrayList level_ids = new ArrayList();
330 ArrayList level_names = new ArrayList();
331 getLevelData(level_ids, level_names, lang);
332 if (level_ids.size()>1) {
333 // the first one is the default
334 //param = GSXML.createParameterDescription2(this.doc, LEVEL_PARAM, getTextString("param."+LEVEL_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, (String)level_ids.get(0), level_ids, level_names);
335 param = GSXML.createParameterDescription2(this.doc, LEVEL_PARAM, getTextString("param."+LEVEL_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, this.default_level, level_ids, level_names);
336 } else {
337 // we need to set the level, but hidden, in case there is an invalid level saved
338 //param = GSXML.createParameterDescription(this.doc, LEVEL_PARAM, "", GSXML.PARAM_TYPE_INVISIBLE, (String)level_ids.get(0), null, null);
339 param = GSXML.createParameterDescription(this.doc, LEVEL_PARAM, "", GSXML.PARAM_TYPE_INVISIBLE, this.default_level, null, null);
340 }
341 } else if (name.equals(RANK_PARAM)) {
342 String [] vals1 = {RANK_PARAM_RANK, RANK_PARAM_NONE };
343 String [] vals1_texts = { getTextString("param."+RANK_PARAM+"."+RANK_PARAM_RANK, lang), getTextString("param."+RANK_PARAM+"."+RANK_PARAM_NONE, lang)};
344
345 param = GSXML.createParameterDescription(this.doc, RANK_PARAM, getTextString("param."+RANK_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, RANK_PARAM_RANK, vals1, vals1_texts );
346
347 } else if (name.equals(FIELD_QUERY_PARAM)) {
348 param = GSXML.createParameterDescription(this.doc, FIELD_QUERY_PARAM, getTextString("param."+FIELD_QUERY_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
349
350
351 } else if (name.equals(FIELD_CASE_PARAM) || name.equals(FIELD_STEM_PARAM) || name.equals(FIELD_ACCENT_PARAM)) {
352 String[] bool_ops = {"0", "1"};
353 String[] bool_texts = {getTextString("param.boolean.off", lang, "AbstractSearch"),getTextString("param.boolean.on", lang, "AbstractSearch")};
354 param = GSXML.createParameterDescription(this.doc, name, getTextString("param."+name, lang), GSXML.PARAM_TYPE_BOOLEAN, BOOLEAN_PARAM_ON, bool_ops, bool_texts);
355
356 } else if (name.equals(FIELD_FIELD_PARAM)) {
357 ArrayList fields = new ArrayList();
358 ArrayList field_names = new ArrayList();
359 getIndexData(fields, field_names, lang);
360 // the field list - read from config file
361
362 // Fix for http://trac.greenstone.org/ticket/245 "java crash, index out of bounds"
363 // org.greenstone.gsdl3.service.AbstractGS2FieldSearch.createParameter(AbstractGS2FieldSearch.java:362)
364 // Changed from:
365 // param = GSXML.createParameterDescription2(this.doc, name, getTextString("param."+name, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, (String)fields.get(0), fields, field_names );
366 String default_value = (fields.size() > 0) ? (String)fields.get(0) : null;
367 // don't want to access element 0 if fields.size()==0, and
368 // GSXML.createParameterDescription2 checks for default_value==null condition
369 param = GSXML.createParameterDescription2(this.doc, name, getTextString("param."+name, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, default_value, fields, field_names );
370
371 } else if (name.equals(FIELD_COMBINE_PARAM)) {
372
373 String []vals = {FIELD_COMBINE_PARAM_AND, FIELD_COMBINE_PARAM_OR, FIELD_COMBINE_PARAM_NOT};
374 String []val_texts = {getTextString("param."+FIELD_COMBINE_PARAM+"."+FIELD_COMBINE_PARAM_AND, lang), getTextString("param."+FIELD_COMBINE_PARAM+"."+FIELD_COMBINE_PARAM_OR, lang), getTextString("param."+FIELD_COMBINE_PARAM+"."+FIELD_COMBINE_PARAM_NOT, lang)};
375
376
377 param = GSXML.createParameterDescription(this.doc, FIELD_COMBINE_PARAM, "", GSXML.PARAM_TYPE_ENUM_SINGLE, FIELD_COMBINE_PARAM_AND, vals, val_texts);
378 param.setAttribute(GSXML.PARAM_IGNORE_POS_ATT, "0");
379 }
380
381 if (param != null) {
382 param_list.appendChild(param);
383 } else {
384 super.createParameter(name, param_list, lang);
385 }
386 }
387
388 // should cache some of this
389 protected void getLevelData(ArrayList level_ids, ArrayList level_names, String lang)
390 {
391 Element level_list = (Element)GSXML.getChildByTagName(this.config_info, LEVEL_ELEM+GSXML.LIST_MODIFIER);
392 NodeList levels = level_list.getElementsByTagName(LEVEL_ELEM);
393 for (int i=0; i<levels.getLength(); i++) {
394 Element level = (Element)levels.item(i);
395 String shortname = level.getAttribute(GSXML.SHORTNAME_ATT);
396 if (shortname.equals("")) {
397 continue;
398 }
399 level_ids.add(shortname);
400 String display_name = GSXML.getDisplayText(level, GSXML.DISPLAY_TEXT_NAME, lang, "en");
401 if (display_name.equals("")) {
402 // we'll use the name, and the dictionary
403 display_name = level.getAttribute(GSXML.NAME_ATT);
404 if (display_name.equals("")) {
405 display_name = shortname;
406 } else {
407 display_name = getTextString("level."+display_name, lang);
408 }
409 }
410 level_names.add(display_name);
411 }
412 }
413
414 // the following three functions are needed so the base class can
415 // call the process+SERVICE_NAME methods
416 /** process a text query */
417 protected Element processTextQuery(Element request) {
418 return processAnyQuery(request, TEXT_QUERY);
419 }
420
421 /** process a field query */
422 protected Element processFieldQuery(Element request) {
423 return processAnyQuery(request, SIMPLE_QUERY);
424 }
425
426 /** process an advanced field query */
427 protected Element processAdvancedFieldQuery(Element request) {
428 return processAnyQuery(request, ADVANCED_QUERY);
429 }
430
431 /** process a query */
432 protected Element processAnyQuery(Element request, int query_type)
433 {
434
435 String service_name=null;
436 String empty_query_test_param=null;
437 // set up the type specific bits
438 switch (query_type) {
439 case TEXT_QUERY:
440 service_name = TEXT_QUERY_SERVICE;
441 empty_query_test_param = QUERY_PARAM;
442 break;
443 case SIMPLE_QUERY:
444 service_name = FIELD_QUERY_SERVICE;
445 empty_query_test_param = FIELD_QUERY_PARAM;
446 break;
447 case ADVANCED_QUERY:
448 service_name = ADVANCED_FIELD_QUERY_SERVICE;
449 empty_query_test_param = FIELD_QUERY_PARAM;
450 break;
451 default:
452 // should never get here
453 logger.error("wrong query type!!");
454 return null;
455 }
456
457 // Create a new (empty) result message
458 Element result = this.doc.createElement(GSXML.RESPONSE_ELEM);
459 result.setAttribute(GSXML.FROM_ATT, service_name);
460 result.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
461
462 // Get the parameters of the request
463 Element param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
464 if (param_list == null) {
465 logger.error("TextQuery request had no paramList.");
466 return result; // Return the empty result
467 }
468
469 // Process the request parameters
470 HashMap params = GSXML.extractParams(param_list, false);
471
472 // Make sure a query has been specified
473 String query = (String) params.get(empty_query_test_param);
474 if (query == null || query.equals("")) {
475 return result; // Return the empty result
476 }
477
478 // If a field hasn't been specified, use the default - for textQuery
479 String field = (String) params.get(INDEX_PARAM);
480 if (field == null) {
481 field = default_index;
482 }
483
484 // set up the appropriate query system
485 if (!setUpQueryer(params)) {
486 return result;
487 }
488
489 // if field search, create the query string
490 switch (query_type) {
491 case TEXT_QUERY:
492 query = addFieldInfo(query, field);
493 break;
494 case SIMPLE_QUERY:
495 query = parseFieldQueryParams(params);
496 break;
497 case ADVANCED_QUERY:
498 query = parseAdvancedFieldQueryParams(params);
499 break;
500 }
501
502 // run the query
503 Object query_result = runQuery(query);
504
505 // build up the response
506
507 // Create a metadata list to store information about the query results
508 // should we be using metadataList? or something else?
509 Element metadata_list = this.doc.createElement(GSXML.METADATA_ELEM+GSXML.LIST_MODIFIER);
510 result.appendChild(metadata_list);
511
512 // Add a metadata element specifying the number of matching documents
513 long totalDocs = numDocsMatched(query_result);
514
515 GSXML.addMetadata(this.doc, metadata_list, "numDocsMatched", ""+totalDocs);
516
517 // Create a document list to store the matching documents, and add them
518 String [] docs = getDocIDs(query_result);
519 String [] doc_ranks = getDocRanks(query_result);
520
521 // add a metadata item to specify docs returned
522 int docs_returned = docs.length;
523 if (does_paging) {
524 String maxdocs_str = (String)params.get(MAXDOCS_PARAM);
525 if (maxdocs_str != null) {
526 int maxdocs = Integer.parseInt(maxdocs_str);
527 docs_returned = (maxdocs < (int)totalDocs ? maxdocs : (int)totalDocs);
528 }
529 }
530 GSXML.addMetadata(this.doc, metadata_list, "numDocsReturned", ""+docs_returned);
531
532 // add a metadata item to specify what actual query was done - eg if stuff was stripped out etc. and then we can use the query later, cos we don't know which parameter was the query
533 GSXML.addMetadata(this.doc, metadata_list, "query", query);
534 if (docs.length>0) {
535 Element document_list = this.doc.createElement(GSXML.DOC_NODE_ELEM+GSXML.LIST_MODIFIER);
536 result.appendChild(document_list);
537 for (int d = 0; d < docs.length; d++) {
538 String doc_id = internalNum2OID(docs[d]);
539 Element doc_node = createDocNode(doc_id, doc_ranks[d]);
540 document_list.appendChild(doc_node);
541 }
542 }
543
544 // Create a term list to store the term information, and add it
545 Element term_list = this.doc.createElement(GSXML.TERM_ELEM+GSXML.LIST_MODIFIER);
546 result.appendChild(term_list);
547 addTermInfo(term_list, params, query_result);
548
549 return result;
550
551 }
552
553 /** methods to handle actually doing the query */
554 /** do any initialisation of the query object */
555 abstract protected boolean setUpQueryer(HashMap params);
556 /** do the query */
557 abstract protected Object runQuery(String query);
558 /** get the total number of docs that match */
559 abstract protected long numDocsMatched(Object query_result);
560 /** get the list of doc ids */
561 abstract protected String [] getDocIDs(Object query_result);
562 /** get the list of doc ranks */
563 abstract protected String [] getDocRanks(Object query_result);
564 /** add in term info if available */
565 abstract protected boolean addTermInfo(Element term_list, HashMap params,
566 Object query_result);
567
568 /** combines all the field params into a single query
569 * - for simple field query */
570 /** We assume the combination (AND/OR) is done by the match param */
571 protected String parseFieldQueryParams(HashMap params) {
572
573 StringBuffer final_query = new StringBuffer(256);
574 String text_line = (String)params.get(FIELD_QUERY_PARAM);
575 String[] texts = text_line.split(",", -1);
576 String field_line = (String)params.get(FIELD_FIELD_PARAM);
577 String[] fields = field_line.split(",", -1);
578
579 for (int i=0; i<texts.length; i++) {
580 String q = texts[i].trim();
581 if (!q.equals("")) {
582 final_query.append(" "+addFieldInfo(q, fields[i]));
583 }
584 }
585
586 return final_query.toString();
587 }
588
589 abstract protected String addFieldInfo(String query, String field);
590
591 /** combines all the field params into a single query
592 * - for advanced field query */
593 protected String parseAdvancedFieldQueryParams(HashMap params) {
594
595 StringBuffer final_query = new StringBuffer(256);
596 String text_line = (String)params.get(FIELD_QUERY_PARAM);
597 String[] texts = text_line.split(",", -1);
598 String field_line = (String)params.get(FIELD_FIELD_PARAM);
599 String[] fields = field_line.split(",", -1);
600 String [] cases = null;
601 String [] stems = null;
602 String [] accents = null;
603 if (does_case) {
604 String case_line = (String)params.get(FIELD_CASE_PARAM);
605 if (case_line !=null)
606 cases = case_line.split(",", -1);
607 }
608 if (does_stem) {
609 String stem_line = (String)params.get(FIELD_STEM_PARAM);
610 if (stem_line !=null)
611 stems = stem_line.split(",", -1);
612 }
613 if (does_accent) {
614 String accent_line = (String)params.get(FIELD_ACCENT_PARAM);
615 if (accent_line !=null)
616 accents = accent_line.split(",", -1);
617 }
618 String combine_line = (String)params.get(FIELD_COMBINE_PARAM);
619 String [] combines = combine_line.split(",", -1);
620 String combine = "";
621 for (int i=0; i<texts.length; i++) {
622 if (i==0) {// assume first one is blank
623 combine = "";
624 } else {
625 String x = combines[i];
626 if (x.equals(FIELD_COMBINE_PARAM_AND)) {
627 combine = AND_OPERATOR;
628 } else if (x.equals(FIELD_COMBINE_PARAM_OR)) {
629 combine = OR_OPERATOR;
630 } else if (x.equals(FIELD_COMBINE_PARAM_NOT)) {
631 combine = NOT_OPERATOR;
632 }
633
634 }
635
636 String q = texts[i].trim();
637 boolean modified = false;
638 if (!q.equals("")) {
639 String c = null;
640 String s = null;
641 String a = null;
642 if (does_case) {
643 modified = true;
644 c = cases[i];
645 }
646 if (does_stem) {
647 modified = true;
648 s = stems[i];
649 }
650 if (does_accent) {
651 modified = true;
652 a = accents[i];
653 }
654 if (modified) {
655 q = addStemOptions(q, s, c, a);
656 }
657 addQueryElem(final_query, q, fields[i], combine);
658 }
659 }
660 return final_query.toString();
661 }
662
663 abstract protected void addQueryElem(StringBuffer final_query,
664 String query, String field,
665 String combine);
666 abstract protected String addStemOptions(String query, String stem,
667 String casef, String accent);
668
669}
670
671
Note: See TracBrowser for help on using the repository browser.