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

Last change on this file since 28181 was 28181, checked in by kjdon, 11 years ago

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