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

Last change on this file since 26198 was 25893, checked in by sjm84, 12 years ago

Removed some unused import code for Solr facets
  • Property svn:keywords set to Author Date Id Revision
File size: 27.4 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// Greenstone classes
21import java.io.Serializable;
22import java.util.ArrayList;
23import java.util.HashMap;
24
25import org.apache.log4j.Logger;
26import org.greenstone.gsdl3.util.FacetWrapper;
27import org.greenstone.gsdl3.util.GSXML;
28import org.w3c.dom.Document;
29import org.w3c.dom.Element;
30import org.w3c.dom.NodeList;
31
32abstract public class AbstractGS2FieldSearch extends AbstractGS2TextSearch
33{
34 // extra services offered by mgpp collections
35 protected static final String FIELD_QUERY_SERVICE = "FieldQuery";
36 protected static final String ADVANCED_FIELD_QUERY_SERVICE = "AdvancedFieldQuery";
37 protected static final String RAW_QUERY_SERVICE = "RawQuery";
38
39 // extra parameters used
40 protected static final String LEVEL_PARAM = "level";
41 protected static final String RANK_PARAM = "sortBy";
42 protected static final String RANK_PARAM_RANK = "1";
43 protected static final String RANK_PARAM_NONE = "0";
44 protected static final String SIMPLE_FIELD_PARAM = "simpleField";
45 protected static final String ADVANCED_FIELD_PARAM = "complexField";
46
47 protected static final String RAW_PARAM = "rawquery";
48
49 // more params for field query
50 protected static final String FIELD_QUERY_PARAM = "fqv";
51 protected static final String FIELD_STEM_PARAM = "fqs";
52 protected static final String FIELD_CASE_PARAM = "fqc";
53 protected static final String FIELD_ACCENT_PARAM = "fqa";
54 protected static final String FIELD_FIELD_PARAM = "fqf";
55 protected static final String FIELD_COMBINE_PARAM = "fqk";
56 protected static final String FIELD_COMBINE_PARAM_AND = "0";
57 protected static final String FIELD_COMBINE_PARAM_OR = "1";
58 protected static final String FIELD_COMBINE_PARAM_NOT = "2";
59
60 // some stuff for config files
61 protected static final String SEARCH_TYPE_ELEM = "searchType";
62 protected static final String SEARCH_TYPE_PLAIN = "plain";
63 protected static final String SEARCH_TYPE_SIMPLE_FORM = "simpleform";
64 protected static final String SEARCH_TYPE_ADVANCED_FORM = "advancedform";
65 protected static final String SEARCH_TYPE_RAW = "raw";
66
67 protected static final String DEFAULT_LEVEL_ELEM = "defaultLevel";
68 protected static final String DEFAULT_DB_LEVEL_ELEM = "defaultDBLevel";
69 protected static final String LEVEL_ELEM = "level";
70 protected static final String FIELD_ATT = "field";
71
72 protected static final int TEXT_QUERY = 0;
73 protected static final int SIMPLE_QUERY = 1;
74 protected static final int ADVANCED_QUERY = 2;
75 protected static final int RAW_QUERY = 3;
76
77 protected String AND_OPERATOR = "&";
78 protected String OR_OPERATOR = "|";
79 protected String NOT_OPERATOR = "!";
80
81 // the default level for searching
82 protected String default_level = null;
83 // default level for collection db
84 protected String default_db_level = null;
85 // which search services will we offer??
86 protected boolean plain_search = false;
87 protected boolean simple_form_search = false;
88 protected boolean advanced_form_search = false;
89 protected boolean raw_search = false;
90
91 static Logger logger = Logger.getLogger(org.greenstone.gsdl3.service.AbstractGS2FieldSearch.class.getName());
92
93 /** constructor */
94 public AbstractGS2FieldSearch()
95 {
96 }
97
98 public void cleanUp()
99 {
100 super.cleanUp();
101 }
102
103 /** configure this service */
104 public boolean configure(Element info, Element extra_info)
105 {
106 if (!super.configure(info, extra_info))
107 {
108 return false;
109 }
110
111 // Get the default level out of <defaultLevel> (buildConfig.xml)
112 Element def = (Element) GSXML.getChildByTagName(info, DEFAULT_LEVEL_ELEM);
113 if (def != null)
114 {
115 this.default_level = def.getAttribute(GSXML.SHORTNAME_ATT);
116 }
117 if (this.default_level == null || this.default_level.equals(""))
118 {
119 logger.error("default level not specified!, assuming Doc");
120 this.default_level = "Doc";
121 }
122
123 // Get the default DB level
124 def = (Element) GSXML.getChildByTagName(info, DEFAULT_DB_LEVEL_ELEM);
125 if (def != null)
126 {
127 this.default_db_level = def.getAttribute(GSXML.SHORTNAME_ATT);
128 }
129 if (this.default_db_level == null || this.default_db_level.equals(""))
130 {
131 logger.error("default database level (defaultDBLevel) not specified!, assuming Sec");
132 this.default_db_level = "Sec";
133 }
134
135 // get stuff from from extra info (which is collectionConfig.xml)
136 if (extra_info != null)
137 {
138
139 // the search element
140 Element config_search = (Element) GSXML.getChildByTagName(extra_info, GSXML.SEARCH_ELEM);
141
142 NodeList search_types = config_search.getElementsByTagName(SEARCH_TYPE_ELEM);
143 if (search_types == null)
144 {
145 // none specified, assume plain only
146 this.plain_search = true;
147 }
148 else
149 {
150 for (int i = 0; i < search_types.getLength(); i++)
151 {
152 Element t = (Element) search_types.item(i);
153
154 String type_name = t.getAttribute(GSXML.NAME_ATT);
155 if (type_name.equals(SEARCH_TYPE_PLAIN))
156 {
157 this.plain_search = true;
158 }
159 else if (type_name.equals(SEARCH_TYPE_SIMPLE_FORM))
160 {
161 this.simple_form_search = true;
162 }
163 else if (type_name.equals(SEARCH_TYPE_ADVANCED_FORM))
164 {
165 this.advanced_form_search = true;
166 }
167 else if (type_name.equals(SEARCH_TYPE_RAW))
168 {
169 this.raw_search = true;
170 }
171 }
172 }
173
174 // AbstractGS2TextSearch has set up the TextQuery service, but we may not want it
175 if (!this.plain_search)
176 {
177 // need to remove the TextQuery service
178 Element tq_service = GSXML.getNamedElement(short_service_info, GSXML.SERVICE_ELEM, GSXML.NAME_ATT, QUERY_SERVICE);
179 short_service_info.removeChild(tq_service);
180 }
181
182 Document owner = info.getOwnerDocument();
183
184 NodeList levels = info.getElementsByTagName(GSXML.LEVEL_ELEM);
185
186 for (int i = 0; i < levels.getLength(); i++)
187 {
188 Element lev = (Element) levels.item(i);
189 String name = lev.getAttribute(GSXML.NAME_ATT);
190 Element node_extra = GSXML.getNamedElement(config_search, GSXML.LEVEL_ELEM, GSXML.NAME_ATT, name);
191 if (node_extra == null)
192 {
193 logger.error("haven't found extra info for level named " + name);
194 continue;
195 }
196
197 // get the display elements if any - displayName
198 NodeList display_names = node_extra.getElementsByTagName(GSXML.DISPLAY_TEXT_ELEM);
199 if (display_names != null)
200 {
201 for (int j = 0; j < display_names.getLength(); j++)
202 {
203 Element e = (Element) display_names.item(j);
204 lev.appendChild(owner.importNode(e, true));
205 }
206 }
207 } // for each level
208 }
209 else
210 {
211 // for soem reason we don't have the collectionConfig file. assume plain only
212 this.plain_search = true;
213 }
214
215 // the format info is the same for all services
216 Element format_info = (Element) format_info_map.get(QUERY_SERVICE);
217
218 // set up the extra services which are available for this collection
219 if (this.simple_form_search)
220 {
221 // set up short_service_info_ - for now just has id and type - name will be added in on the fly
222 Element fq_service = this.doc.createElement(GSXML.SERVICE_ELEM);
223 fq_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
224 fq_service.setAttribute(GSXML.NAME_ATT, FIELD_QUERY_SERVICE);
225 this.short_service_info.appendChild(fq_service);
226
227 if (format_info != null)
228 {
229 this.format_info_map.put(FIELD_QUERY_SERVICE, format_info);
230 }
231 }
232
233 if (this.advanced_form_search)
234 {
235 Element afq_service = this.doc.createElement(GSXML.SERVICE_ELEM);
236 afq_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
237 afq_service.setAttribute(GSXML.NAME_ATT, ADVANCED_FIELD_QUERY_SERVICE);
238 this.short_service_info.appendChild(afq_service);
239
240 if (format_info != null)
241 {
242 this.format_info_map.put(ADVANCED_FIELD_QUERY_SERVICE, format_info);
243 }
244 }
245
246 if (this.raw_search)
247 {
248 Element rq_service = this.doc.createElement(GSXML.SERVICE_ELEM);
249 rq_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
250 rq_service.setAttribute(GSXML.NAME_ATT, RAW_QUERY_SERVICE);
251 this.short_service_info.appendChild(rq_service);
252
253 if (format_info != null)
254 {
255 this.format_info_map.put(RAW_QUERY_SERVICE, format_info);
256 }
257 }
258
259 return true;
260 }
261
262 protected Element getServiceDescription(String service_id, String lang, String subset)
263 {
264 // should we check that the service is actually on offer? presumably we wont get asked for services that we haven't advertised previously.
265
266 if (!service_id.equals(FIELD_QUERY_SERVICE) && !service_id.equals(ADVANCED_FIELD_QUERY_SERVICE) && !service_id.equals(RAW_QUERY_SERVICE))
267 {
268 return super.getServiceDescription(service_id, lang, subset);
269 }
270
271 Element service = this.doc.createElement(GSXML.SERVICE_ELEM);
272 service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
273 service.setAttribute(GSXML.NAME_ATT, service_id);
274 if (subset == null || subset.equals(GSXML.DISPLAY_TEXT_ELEM + GSXML.LIST_MODIFIER))
275 {
276 service.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_NAME, getTextString(service_id + ".name", lang)));
277 service.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_SUBMIT, getTextString(service_id + ".submit", lang)));
278 service.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_DESCRIPTION, getTextString(service_id + ".description", lang)));
279
280 }
281 if (subset == null || subset.equals(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER))
282 {
283 Element param_list = this.doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
284 service.appendChild(param_list);
285 if (service_id.equals(FIELD_QUERY_SERVICE))
286 {
287
288 addCustomQueryParams(param_list, lang);
289 createParameter(MAXDOCS_PARAM, param_list, lang);
290 if (!default_index_subcollection.equals(""))
291 {
292 createParameter(INDEX_SUBCOLLECTION_PARAM, param_list, lang);
293 }
294 if (!default_index_language.equals(""))
295 {
296 createParameter(INDEX_LANGUAGE_PARAM, param_list, lang);
297 }
298
299 if (does_paging)
300 {
301 createParameter(HITS_PER_PAGE_PARAM, param_list, lang);
302 createParameter(START_PAGE_PARAM, param_list, lang);
303 }
304
305 // create a multi param for the fields etc
306 // text box, field
307 Element multiparam = null;
308 Element param = null;
309 multiparam = GSXML.createParameterDescription(this.doc, SIMPLE_FIELD_PARAM, "", GSXML.PARAM_TYPE_MULTI, null, null, null);
310 multiparam.setAttribute("occurs", "4");
311 param_list.appendChild(multiparam);
312
313 // the components
314
315 createParameter(FIELD_QUERY_PARAM, multiparam, lang);
316 createParameter(FIELD_FIELD_PARAM, multiparam, lang);
317
318 }
319 else if (service_id.equals(ADVANCED_FIELD_QUERY_SERVICE))
320 {
321 createParameter(LEVEL_PARAM, param_list, lang);
322 createParameter(RANK_PARAM, param_list, lang);
323 createParameter(MAXDOCS_PARAM, param_list, lang);
324 if (!default_index_subcollection.equals(""))
325 {
326 createParameter(INDEX_SUBCOLLECTION_PARAM, param_list, lang);
327 }
328 if (!default_index_language.equals(""))
329 {
330 createParameter(INDEX_LANGUAGE_PARAM, param_list, lang);
331 }
332
333 // create a multi param for the fields etc
334 // text box, stem, case, field
335
336 Element multiparam = null;
337 Element param = null;
338
339 multiparam = GSXML.createParameterDescription(this.doc, ADVANCED_FIELD_PARAM, "", GSXML.PARAM_TYPE_MULTI, null, null, null);
340 multiparam.setAttribute("occurs", "4");
341 param_list.appendChild(multiparam);
342
343 createParameter(FIELD_COMBINE_PARAM, multiparam, lang);
344 createParameter(FIELD_QUERY_PARAM, multiparam, lang);
345 if (this.does_case)
346 {
347 createParameter(FIELD_CASE_PARAM, multiparam, lang);
348 }
349 if (this.does_stem)
350 {
351 createParameter(FIELD_STEM_PARAM, multiparam, lang);
352 }
353 if (this.does_accent)
354 {
355 createParameter(FIELD_ACCENT_PARAM, multiparam, lang);
356 }
357 if (does_paging)
358 {
359 createParameter(HITS_PER_PAGE_PARAM, param_list, lang);
360 createParameter(START_PAGE_PARAM, param_list, lang);
361 }
362 createParameter(FIELD_FIELD_PARAM, multiparam, lang);
363
364 }
365 else if (service_id.equals(RAW_QUERY_SERVICE))
366 {
367 if (does_chunking)
368 {
369 createParameter(MAXDOCS_PARAM, param_list, lang);
370 }
371 if (does_paging)
372 {
373 createParameter(HITS_PER_PAGE_PARAM, param_list, lang);
374 createParameter(START_PAGE_PARAM, param_list, lang);
375 }
376 createParameter(RAW_PARAM, param_list, lang);
377 service.appendChild(param_list);
378 }
379 }
380 return service;
381
382 }
383
384 /** add in the level params to TextQuery */
385 protected void addCustomQueryParams(Element param_list, String lang)
386 {
387 createParameter(LEVEL_PARAM, param_list, lang);
388 super.addCustomQueryParams(param_list, lang);
389 }
390
391 /** create a param and add to the list */
392 protected void createParameter(String name, Element param_list, String lang)
393 {
394 Element param = null;
395 if (name.equals(LEVEL_PARAM))
396 {
397 ArrayList<String> level_ids = new ArrayList<String>();
398 ArrayList<String> level_names = new ArrayList<String>();
399 getLevelData(level_ids, level_names, lang);
400 if (level_ids.size() > 1)
401 {
402 // the first one is the default
403 //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);
404 param = GSXML.createParameterDescription2(this.doc, LEVEL_PARAM, getTextString("param." + LEVEL_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, this.default_level, level_ids, level_names);
405 }
406 else
407 {
408 // we need to set the level, but hidden, in case there is an invalid level saved
409 //param = GSXML.createParameterDescription(this.doc, LEVEL_PARAM, "", GSXML.PARAM_TYPE_INVISIBLE, (String)level_ids.get(0), null, null);
410 param = GSXML.createParameterDescription(this.doc, LEVEL_PARAM, "", GSXML.PARAM_TYPE_INVISIBLE, this.default_level, null, null);
411 }
412 }
413 else if (name.equals(RANK_PARAM))
414 {
415 String[] vals1 = { RANK_PARAM_RANK, RANK_PARAM_NONE };
416 String[] vals1_texts = { getTextString("param." + RANK_PARAM + "." + RANK_PARAM_RANK, lang), getTextString("param." + RANK_PARAM + "." + RANK_PARAM_NONE, lang) };
417
418 param = GSXML.createParameterDescription(this.doc, RANK_PARAM, getTextString("param." + RANK_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, RANK_PARAM_RANK, vals1, vals1_texts);
419
420 }
421 else if (name.equals(FIELD_QUERY_PARAM))
422 {
423 param = GSXML.createParameterDescription(this.doc, FIELD_QUERY_PARAM, getTextString("param." + FIELD_QUERY_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
424
425 }
426 else if (name.equals(FIELD_CASE_PARAM) || name.equals(FIELD_STEM_PARAM) || name.equals(FIELD_ACCENT_PARAM))
427 {
428 String[] bool_ops = { "0", "1" };
429 String[] bool_texts = { getTextString("param.boolean.off", lang, "AbstractTextSearch"), getTextString("param.boolean.on", lang, "AbstractTextSearch") };
430 param = GSXML.createParameterDescription(this.doc, name, getTextString("param." + name, lang), GSXML.PARAM_TYPE_BOOLEAN, BOOLEAN_PARAM_ON, bool_ops, bool_texts);
431
432 }
433 else if (name.equals(FIELD_FIELD_PARAM))
434 {
435 ArrayList<String> fields = new ArrayList<String>();
436 ArrayList<String> field_names = new ArrayList<String>();
437 getIndexData(fields, field_names, lang);
438 // the field list - read from config file
439
440 // Fix for http://trac.greenstone.org/ticket/245 "java crash, index out of bounds"
441 // org.greenstone.gsdl3.service.AbstractGS2FieldSearch.createParameter(AbstractGS2FieldSearch.java:362)
442 // Changed from:
443 // param = GSXML.createParameterDescription2(this.doc, name, getTextString("param."+name, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, (String)fields.get(0), fields, field_names );
444 String default_value = (fields.size() > 0) ? fields.get(0) : null;
445 // don't want to access element 0 if fields.size()==0, and
446 // GSXML.createParameterDescription2 checks for default_value==null condition
447 param = GSXML.createParameterDescription2(this.doc, name, getTextString("param." + name, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, default_value, fields, field_names);
448
449 }
450 else if (name.equals(FIELD_COMBINE_PARAM))
451 {
452
453 String[] vals = { FIELD_COMBINE_PARAM_AND, FIELD_COMBINE_PARAM_OR, FIELD_COMBINE_PARAM_NOT };
454 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) };
455
456 param = GSXML.createParameterDescription(this.doc, FIELD_COMBINE_PARAM, "", GSXML.PARAM_TYPE_ENUM_SINGLE, FIELD_COMBINE_PARAM_AND, vals, val_texts);
457 param.setAttribute(GSXML.PARAM_IGNORE_POS_ATT, "0");
458 }
459
460 if (param != null)
461 {
462 param_list.appendChild(param);
463 }
464 else
465 {
466 super.createParameter(name, param_list, lang);
467 }
468 }
469
470 // should cache some of this
471 protected void getLevelData(ArrayList<String> level_ids, ArrayList<String> level_names, String lang)
472 {
473 Element level_list = (Element) GSXML.getChildByTagName(this.config_info, LEVEL_ELEM + GSXML.LIST_MODIFIER);
474 NodeList levels = level_list.getElementsByTagName(LEVEL_ELEM);
475 for (int i = 0; i < levels.getLength(); i++)
476 {
477 Element level = (Element) levels.item(i);
478 String shortname = level.getAttribute(GSXML.SHORTNAME_ATT);
479 if (shortname.equals(""))
480 {
481 continue;
482 }
483 level_ids.add(shortname);
484 String display_name = GSXML.getDisplayText(level, GSXML.DISPLAY_TEXT_NAME, lang, "en");
485 if (display_name.equals(""))
486 {
487 // we'll use the name, and the dictionary
488 display_name = level.getAttribute(GSXML.NAME_ATT);
489 if (display_name.equals(""))
490 {
491 display_name = shortname;
492 }
493 else
494 {
495 display_name = getTextString("level." + display_name, lang);
496 }
497 }
498 level_names.add(display_name);
499 }
500 }
501
502 // the following three functions are needed so the base class can
503 // call the process+SERVICE_NAME methods
504 /** process a text query */
505 protected Element processTextQuery(Element request)
506 {
507 return processAnyQuery(request, TEXT_QUERY);
508 }
509
510 /** process a field query */
511 protected Element processFieldQuery(Element request)
512 {
513 return processAnyQuery(request, SIMPLE_QUERY);
514 }
515
516 /** process an advanced field query */
517 protected Element processAdvancedFieldQuery(Element request)
518 {
519 return processAnyQuery(request, ADVANCED_QUERY);
520 }
521
522 protected Element processRawQuery(Element request)
523 {
524 return processAnyQuery(request, RAW_QUERY);
525 }
526
527 /** process a query */
528 protected Element processAnyQuery(Element request, int query_type)
529 {
530 String service_name = null;
531 String empty_query_test_param = null;
532 // set up the type specific bits
533 switch (query_type)
534 {
535 case TEXT_QUERY:
536 service_name = QUERY_SERVICE;
537 empty_query_test_param = QUERY_PARAM;
538 break;
539 case SIMPLE_QUERY:
540 service_name = FIELD_QUERY_SERVICE;
541 empty_query_test_param = FIELD_QUERY_PARAM;
542 break;
543 case ADVANCED_QUERY:
544 service_name = ADVANCED_FIELD_QUERY_SERVICE;
545 empty_query_test_param = FIELD_QUERY_PARAM;
546 break;
547 case RAW_QUERY:
548 service_name = RAW_QUERY_SERVICE;
549 empty_query_test_param = RAW_PARAM;
550 break;
551 default:
552 // should never get here
553 logger.error("wrong query type!!");
554 return null;
555 }
556
557 // Create a new (empty) result message
558 Element result = this.doc.createElement(GSXML.RESPONSE_ELEM);
559 result.setAttribute(GSXML.FROM_ATT, service_name);
560 result.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
561
562 // Get the parameters of the request
563 Element param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
564 if (param_list == null)
565 {
566 logger.error("TextQuery request had no paramList.");
567 return result; // Return the empty result
568 }
569
570 // Process the request parameters
571 HashMap<String, Serializable> params = GSXML.extractParams(param_list, false);
572
573 // Make sure a query has been specified
574 String query = (String) params.get(empty_query_test_param);
575 if (query == null || query.equals(""))
576 {
577 return result; // Return the empty result
578 }
579
580 // If a field hasn't been specified, use the default - for textQuery
581 String field = (String) params.get(INDEX_PARAM);
582 if (field == null)
583 {
584 field = default_index;
585 }
586
587 // set up the appropriate query system
588 if (!setUpQueryer(params))
589 {
590 return result;
591 }
592
593 // if field search, create the query string
594 switch (query_type)
595 {
596 case TEXT_QUERY:
597 query = addFieldInfo(query, field);
598 break;
599 case SIMPLE_QUERY:
600 query = parseFieldQueryParams(params);
601 break;
602 case ADVANCED_QUERY:
603 query = parseAdvancedFieldQueryParams(params);
604 break;
605 }
606
607 // run the query
608 Object query_result = runQuery(query);
609
610 // build up the response
611
612 // Create a metadata list to store information about the query results
613 // should we be using metadataList? or something else?
614 Element metadata_list = this.doc.createElement(GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
615 result.appendChild(metadata_list);
616
617 // Add a metadata element specifying the number of matching documents
618 long totalDocs = numDocsMatched(query_result);
619
620 GSXML.addMetadata(this.doc, metadata_list, "numDocsMatched", "" + totalDocs);
621
622 // Create a document list to store the matching documents, and add them
623 String[] docs = getDocIDs(query_result);
624 String[] doc_ranks = getDocRanks(query_result);
625
626 // add a metadata item to specify docs returned
627 int docs_returned = docs.length;
628 if (does_paging)
629 {
630 String maxdocs_str = (String) params.get(MAXDOCS_PARAM);
631 if (maxdocs_str != null)
632 {
633 int maxdocs = Integer.parseInt(maxdocs_str);
634 docs_returned = (maxdocs < (int) totalDocs ? maxdocs : (int) totalDocs);
635 }
636 }
637 GSXML.addMetadata(this.doc, metadata_list, "numDocsReturned", "" + docs_returned);
638
639 // 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
640 GSXML.addMetadata(this.doc, metadata_list, "query", query);
641 if (docs.length > 0)
642 {
643 Element document_list = this.doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
644 result.appendChild(document_list);
645 for (int d = 0; d < docs.length; d++)
646 {
647 String doc_id = internalNum2OID(docs[d]);
648 Element doc_node = createDocNode(doc_id, doc_ranks[d]);
649 document_list.appendChild(doc_node);
650 }
651 }
652
653 // Create a term list to store the term information, and add it
654 Element term_list = this.doc.createElement(GSXML.TERM_ELEM + GSXML.LIST_MODIFIER);
655 result.appendChild(term_list);
656 addTermInfo(term_list, params, query_result);
657
658 if(does_faceting)
659 {
660 ArrayList<FacetWrapper> facets = getFacets(query_result);
661 if(facets != null)
662 {
663 Element facet_list = this.doc.createElement(GSXML.FACET_ELEM + GSXML.LIST_MODIFIER);
664 result.appendChild(facet_list);
665
666 for(FacetWrapper currentFacet : facets)
667 {
668 Element facet_elem = this.doc.createElement(GSXML.FACET_ELEM);
669 facet_elem.setAttribute(GSXML.NAME_ATT, currentFacet.getName());
670 facet_list.appendChild(facet_elem);
671
672 HashMap<String, Long> countMap = currentFacet.getCounts();
673
674 for(String countName : countMap.keySet())
675 {
676 long countValue = countMap.get(countName);
677 if(countValue > 0)
678 {
679 Element count_elem = this.doc.createElement(GSXML.COUNT_ELEM);
680 count_elem.setAttribute(GSXML.NAME_ATT, countName);
681 count_elem.setTextContent("" + countValue);
682
683 facet_elem.appendChild(count_elem);
684 }
685 }
686 }
687 }
688 }
689
690 return result;
691
692 }
693
694 /** methods to handle actually doing the query */
695 /** do any initialisation of the query object */
696 abstract protected boolean setUpQueryer(HashMap<String, Serializable> params);
697
698 /** do the query */
699 abstract protected Object runQuery(String query);
700
701 /** get the total number of docs that match */
702 abstract protected long numDocsMatched(Object query_result);
703
704 /** get the list of doc ids */
705 abstract protected String[] getDocIDs(Object query_result);
706
707 /** get the list of doc ranks */
708 abstract protected String[] getDocRanks(Object query_result);
709
710 /** get the list of facets */
711 abstract protected ArrayList<FacetWrapper> getFacets(Object query_result);
712
713 /** add in term info if available */
714 abstract protected boolean addTermInfo(Element term_list, HashMap<String, Serializable> params, Object query_result);
715
716 /**
717 * combines all the field params into a single query - for simple field
718 * query
719 */
720 /** We assume the combination (AND/OR) is done by the match param */
721 protected String parseFieldQueryParams(HashMap<String, Serializable> params)
722 {
723
724 StringBuffer final_query = new StringBuffer(256);
725 String text_line = (String) params.get(FIELD_QUERY_PARAM);
726 String[] texts = text_line.split(",", -1);
727 String field_line = (String) params.get(FIELD_FIELD_PARAM);
728 String[] fields = field_line.split(",", -1);
729
730 for (int i = 0; i < texts.length; i++)
731 {
732 String q = texts[i].trim();
733 if (!q.equals(""))
734 {
735 final_query.append(" " + addFieldInfo(q, fields[i]));
736 }
737 }
738
739 return final_query.toString();
740 }
741
742 abstract protected String addFieldInfo(String query, String field);
743
744 /**
745 * combines all the field params into a single query - for advanced field
746 * query
747 */
748 protected String parseAdvancedFieldQueryParams(HashMap<String, Serializable> params)
749 {
750
751 StringBuffer final_query = new StringBuffer(256);
752 String text_line = (String) params.get(FIELD_QUERY_PARAM);
753 String[] texts = text_line.split(",", -1);
754 String field_line = (String) params.get(FIELD_FIELD_PARAM);
755 String[] fields = field_line.split(",", -1);
756 String[] cases = null;
757 String[] stems = null;
758 String[] accents = null;
759 if (does_case)
760 {
761 String case_line = (String) params.get(FIELD_CASE_PARAM);
762 if (case_line != null)
763 cases = case_line.split(",", -1);
764 }
765 if (does_stem)
766 {
767 String stem_line = (String) params.get(FIELD_STEM_PARAM);
768 if (stem_line != null)
769 stems = stem_line.split(",", -1);
770 }
771 if (does_accent)
772 {
773 String accent_line = (String) params.get(FIELD_ACCENT_PARAM);
774 if (accent_line != null)
775 accents = accent_line.split(",", -1);
776 }
777 String combine_line = (String) params.get(FIELD_COMBINE_PARAM);
778 String[] combines = combine_line.split(",", -1);
779 String combine = "";
780 for (int i = 0; i < texts.length; i++)
781 {
782 if (i == 0)
783 {// assume first one is blank
784 combine = "";
785 }
786 else
787 {
788 String x = combines[i];
789 if (x.equals(FIELD_COMBINE_PARAM_AND))
790 {
791 combine = AND_OPERATOR;
792 }
793 else if (x.equals(FIELD_COMBINE_PARAM_OR))
794 {
795 combine = OR_OPERATOR;
796 }
797 else if (x.equals(FIELD_COMBINE_PARAM_NOT))
798 {
799 combine = NOT_OPERATOR;
800 }
801
802 }
803
804 String q = texts[i].trim();
805 boolean modified = false;
806 if (!q.equals(""))
807 {
808 String c = null;
809 String s = null;
810 String a = null;
811 if (does_case)
812 {
813 modified = true;
814 c = cases[i];
815 }
816 if (does_stem)
817 {
818 modified = true;
819 s = stems[i];
820 }
821 if (does_accent)
822 {
823 modified = true;
824 a = accents[i];
825 }
826 if (modified)
827 {
828 q = addStemOptions(q, s, c, a);
829 }
830 addQueryElem(final_query, q, fields[i], combine);
831 }
832 }
833 return final_query.toString();
834 }
835
836 abstract protected void addQueryElem(StringBuffer final_query, String query, String field, String combine);
837
838 abstract protected String addStemOptions(String query, String stem, String casef, String accent);
839
840}
Note: See TracBrowser for help on using the repository browser.