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

Last change on this file was 38106, checked in by kjdon, 8 months ago

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