source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/SharedSoleneGS2FieldSearch.java@ 29318

Last change on this file since 29318 was 29318, checked in by kjdon, 10 years ago

adding in sort by and sort order params for lucene advanced field query
  • Property svn:executable set to *
File size: 7.6 KB
Line 
1/*
2 * SharedSoleneGS2FieldSearch.java -- shared base code for Solr and Lucene
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 */
18
19package org.greenstone.gsdl3.service;
20
21// Greenstone classes
22import java.util.ArrayList;
23
24import org.apache.log4j.Logger;
25import org.greenstone.LuceneWrapper4.SharedSoleneQuery;
26import org.greenstone.gsdl3.util.GSXML;
27import org.greenstone.gsdl3.util.XMLConverter;
28
29import org.w3c.dom.Document;
30import org.w3c.dom.Element;
31import org.w3c.dom.NodeList;
32
33// Shared code for Solr and Lucene GS2FieldSearch
34
35public abstract class SharedSoleneGS2FieldSearch extends AbstractGS2FieldSearch
36{
37
38 protected static String RANK_PARAM_RANK = "rank";
39 protected static String RANK_PARAM_NONE = "none";
40
41 protected static final String SORT_ELEM = "sort";
42 protected static final String SORT_ORDER_PARAM = "sortOrder";
43 protected static final String SORT_ORDER_DESCENDING = "1";
44 protected static final String SORT_ORDER_ASCENDING = "0";
45
46 static Logger logger = Logger.getLogger(org.greenstone.gsdl3.service.SharedSoleneGS2FieldSearch.class.getName());
47
48 protected SharedSoleneQuery solene_src = null;
49
50
51 public SharedSoleneGS2FieldSearch()
52 {
53 super();
54 // Lucene/Solr uses double operators, not single
55 //AND_OPERATOR = "&&";
56 //OR_OPERATOR = "||";
57 AND_OPERATOR = "AND";
58 OR_OPERATOR = "OR";
59 NOT_OPERATOR = "NOT";
60
61 does_paging = true;
62 does_chunking = true;
63 paramDefaults.put(SORT_ORDER_PARAM, SORT_ORDER_DESCENDING);
64 }
65
66 /** configure this service */
67 public boolean configure(Element info, Element extra_info)
68 {
69 if (!super.configure(info, extra_info))
70 {
71 return false;
72 }
73
74 // the search element
75 Element config_search = (Element) GSXML.getChildByTagName(extra_info, GSXML.SEARCH_ELEM);
76 Document owner = info.getOwnerDocument();
77 // find the sort fields in serviceRack xml, and add in the deisplayItems if any
78 NodeList sort_nodes = info.getElementsByTagName(SORT_ELEM);
79
80 for (int i = 0; i < sort_nodes.getLength(); i++)
81 {
82 Element sort = (Element) sort_nodes.item(i);
83 String name = sort.getAttribute(GSXML.NAME_ATT);
84 Element node_extra = GSXML.getNamedElement(config_search, SORT_ELEM, GSXML.NAME_ATT, name);
85 if (node_extra == null)
86 {
87 logger.error("haven't found extra info for sort field named " + name);
88 continue;
89 }
90
91 // get the display elements if any - displayName
92 NodeList display_names = node_extra.getElementsByTagName(GSXML.DISPLAY_TEXT_ELEM);
93 if (display_names != null)
94 {
95 for (int j = 0; j < display_names.getLength(); j++)
96 {
97 Element e = (Element) display_names.item(j);
98 sort.appendChild(owner.importNode(e, true));
99 }
100 }
101 } // for each sortfield
102 // Lucene/Solr doesn't do case folding or stemming or accent folding at the
103 // moment
104 does_case = false;
105 does_stem = false;
106 does_accent = false;
107
108 return true;
109 }
110
111 /** add in the Lucene/Solr specific params to TextQuery */
112 protected void addCustomQueryParams(Element param_list, String lang)
113 {
114 super.addCustomQueryParams(param_list, lang);
115 /** Lucene's/Solr's rank (sort) param is based on sort fields, not ranked/not */
116 createParameter(RANK_PARAM, param_list, lang);
117 createParameter(SORT_ORDER_PARAM, param_list, lang);
118 }
119 /** add in Lucene/SOLR specific params for AdvancedFieldQuery */
120 protected void addCustomQueryParamsAdvField(Element param_list, String lang)
121 {
122 super.addCustomQueryParamsAdvField(param_list, lang);
123 createParameter(RANK_PARAM, param_list, lang);
124 createParameter(SORT_ORDER_PARAM, param_list, lang);
125
126 }
127
128 /** create a param and add to the list */
129 /** we override this to do a special rank param */
130 protected void createParameter(String name, Element param_list, String lang)
131 {
132 Document doc = param_list.getOwnerDocument();
133 Element param = null;
134 String param_default = paramDefaults.get(name);
135 if (name.equals(RANK_PARAM))
136 {
137 // get the fields
138 ArrayList<String> fields = new ArrayList<String>();
139 ArrayList<String> field_names = new ArrayList<String>();
140 if (!getSortData(fields, field_names, lang)) {
141 fields.add(RANK_PARAM_RANK);
142 fields.add(RANK_PARAM_NONE);
143 field_names.add(getTextString("param." + RANK_PARAM + "." + RANK_PARAM_RANK, lang));
144 field_names.add(getTextString("param." + RANK_PARAM + "." + RANK_PARAM_NONE, lang));
145 }
146
147 param = GSXML.createParameterDescription2(doc, name, getTextString("param." + name, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, fields.get(0), fields, field_names);
148
149 } else if (name.equals(SORT_ORDER_PARAM)) {
150 String[] vals = { SORT_ORDER_ASCENDING, SORT_ORDER_DESCENDING };
151 String[] vals_texts = { getTextString("param." + SORT_ORDER_PARAM + "." + SORT_ORDER_ASCENDING, lang), getTextString("param." + SORT_ORDER_PARAM + "." + SORT_ORDER_DESCENDING, lang) };
152
153 param = GSXML.createParameterDescription(doc, SORT_ORDER_PARAM, getTextString("param." + SORT_ORDER_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, SORT_ORDER_DESCENDING, vals, vals_texts);
154 }
155
156 if (param != null)
157 {
158 param_list.appendChild(param);
159 }
160 else
161 {
162 super.createParameter(name, param_list, lang);
163 }
164
165 }
166
167 protected boolean getSortData(ArrayList<String> sort_ids, ArrayList<String> sort_names, String lang) {
168
169 Element sort_list = (Element) GSXML.getChildByTagName(this.config_info, SORT_ELEM + GSXML.LIST_MODIFIER);
170 if (sort_list == null) return false;
171 NodeList sorts = sort_list.getElementsByTagName(SORT_ELEM);
172 int len = sorts.getLength();
173 if (len == 0) return false;
174 for (int i = 0; i < len; i++)
175 {
176 Element sort = (Element) sorts.item(i);
177 String shortname = sort.getAttribute(GSXML.SHORTNAME_ATT);
178 sort_ids.add(shortname);
179 String display_name = GSXML.getDisplayText(sort, GSXML.DISPLAY_TEXT_NAME, lang, "en");
180 if (display_name.equals(""))
181 {
182 display_name = sort.getAttribute(GSXML.NAME_ATT);
183 if (display_name.equals(""))
184 {
185 display_name = shortname;
186 }
187 }
188 sort_names.add(display_name);
189
190 }
191 return true;
192 }
193
194 protected String addFieldInfo(String query, String field)
195 {
196 // currently, allfields (ZZ) is stored as a extra field for Lucene
197 if (field.equals(""))
198 { // || field.equals("ZZ")) {
199 return query;
200 }
201 return field + ":(" + query + ")";
202 }
203
204 protected void addQueryElem(StringBuffer s, String q, String f, String c)
205 {
206
207 String combine = "";
208 if (s.length() > 0)
209 {
210 combine = " " + c + " ";
211 }
212 s.append(combine + addFieldInfo(q, f));
213 }
214
215 /** Lucene/Solr doesn't use these options at the moment */
216 protected String addStemOptions(String query, String stem, String casef, String accent)
217 {
218 return query;
219 }
220
221 /**
222 * Lucene/Solr does not use internal ids. It just uses hash ids. So we need
223 * to override these methods so no conversion is done.
224 */
225 /** convert indexer internal id to Greenstone oid */
226 protected String internalNum2OID(long docnum)
227 {
228 return Long.toString(docnum);
229 }
230
231 protected String internalNum2OID(String docnum)
232 {
233 return docnum;
234
235 }
236}
Note: See TracBrowser for help on using the repository browser.