source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/service/CrossCollectionSearch.java@ 32656

Last change on this file since 32656 was 32656, checked in by kjdon, 5 years ago

oh dearsvn diff service/CrossCollectionSearch.java I mistakenly deleted half this file and then committed. I have got back the missing parts. hope I hadn't had any changes in this part of the file...
  • Property svn:keywords set to Author Date Id Revision
File size: 25.8 KB
Line 
1/*
2 * CrossCollectionSearch.java
3 * Copyright (C) 2002 New Zealand Digital Library, http://www.nzdl.org
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 */
19package org.greenstone.gsdl3.service;
20
21import java.util.ArrayList;
22import java.util.HashMap;
23import java.util.Iterator;
24import java.util.Map;
25import java.util.Set;
26
27import org.apache.log4j.Logger;
28import org.greenstone.gsdl3.util.GSPath;
29import org.greenstone.gsdl3.util.GSXML;
30import org.greenstone.gsdl3.util.UserContext;
31import org.greenstone.gsdl3.util.XMLConverter;
32import org.w3c.dom.Document;
33import org.w3c.dom.Element;
34import org.w3c.dom.Node;
35import org.w3c.dom.NodeList;
36
37/**
38 * This ServiceRack gets specified in siteConfig.xml. So it is loaded by the MessaegRouter, and two services get activated: TextQuery, DocumentMetadataRetrieve.
39These are located at MR level, not inside a collection. QueryAction will send messages to "TextQuery", rather than eg "mgppdemo/TextQuery".
40These two services will requery the MR for search results/document metadata based on collections or documents listed.
41 */
42
43public class CrossCollectionSearch extends ServiceRack
44{
45
46 static Logger logger = Logger.getLogger(org.greenstone.gsdl3.service.CrossCollectionSearch.class.getName());
47 protected static final String QUERY_PARAM = "query";
48 protected static final String COLLECTION_PARAM = "collection";
49 protected static final String GROUP_PARAM = "group";
50 protected static final String MAXDOCS_PARAM = "maxDocs"; // matches standard maxDocs, but in this case, means max docs per collection
51 protected static final String HITS_PER_PAGE_PARAM = "hitsPerPage";
52 protected static final String MAXDOCS_DEFAULT = "20";
53 // the services on offer - these proxy the actual collection ones
54 protected static final String TEXT_QUERY_SERVICE = "TextQuery";
55 protected static final String DOCUMENT_METADATA_RETRIEVE_SERVICE = "DocumentMetadataRetrieve";
56
57 protected String[] coll_ids_list = null;
58 protected String[] coll_ids_list_no_all = null;
59 // maps lang to coll names list
60 protected HashMap<String, String[]> coll_names_map = null;
61
62 //protected String[] coll_names_list = null;
63
64 /** constructor */
65 public CrossCollectionSearch()
66 {
67 }
68
69 public boolean configure(Element info, Element extra_info)
70 {
71 // any parameters? colls to include??
72 logger.info("Configuring CrossCollectionSearch...");
73 // query service
74 Element ccs_service = this.desc_doc.createElement(GSXML.SERVICE_ELEM);
75 ccs_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
76 ccs_service.setAttribute(GSXML.NAME_ATT, TEXT_QUERY_SERVICE);
77 this.short_service_info.appendChild(ccs_service);
78
79 // metadata service
80 Element dmr_service = this.desc_doc.createElement(GSXML.SERVICE_ELEM);
81 dmr_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
82 dmr_service.setAttribute(GSXML.NAME_ATT, DOCUMENT_METADATA_RETRIEVE_SERVICE);
83 this.short_service_info.appendChild(dmr_service);
84
85
86 // what params do we want saved in the session?
87 this.save_params.add(QUERY_PARAM);
88 this.save_params.add(COLLECTION_PARAM);
89 this.save_params.add(GROUP_PARAM);
90 this.save_params.add(MAXDOCS_PARAM);
91 this.save_params.add(HITS_PER_PAGE_PARAM);
92
93 // get any format info
94 Element format_info = (Element) GSXML.getChildByTagName(info, GSXML.FORMAT_ELEM);
95 if (format_info != null)
96 {
97 this.format_info_map.put(TEXT_QUERY_SERVICE, this.desc_doc.importNode(format_info, true));
98 }
99 else
100 {
101 // add in a default format statement
102 //"xmlns:gsf='" + GSXML.GSF_NAMESPACE + "' xmlns:xsl='" + GSXML.XSL_NAMESPACE + "
103 String format_string = "<format "+GSXML.STD_NAMESPACES_ATTS + "><gsf:template match='documentNode'><td><a><xsl:attribute name='href'>?a=d&amp;c=<xsl:value-of select='@collection'/>&amp;d=<xsl:value-of select='@nodeID'/><xsl:if test=\"@nodeType='leaf'\">&amp;sib=1</xsl:if>&amp;dt=<xsl:value-of select='@docType'/>&amp;p.a=q&amp;p.s=" + TEXT_QUERY_SERVICE + "&amp;p.c=";
104 if (this.cluster_name != null)
105 {
106 format_string += this.cluster_name;
107 }
108 format_string += "</xsl:attribute><gsf:icon/></a></td><td><gsf:metadata name='Title'/> (<xsl:value-of select='@collection'/>) </td></gsf:template></format>";
109 this.format_info_map.put(TEXT_QUERY_SERVICE, this.desc_doc.importNode(this.converter.getDOM(format_string).getDocumentElement(), true));
110 }
111 return true;
112 }
113
114 protected Element getServiceDescription(Document doc, String service, String lang, String subset)
115 {
116 if (service.equals(TEXT_QUERY_SERVICE))
117 {
118
119 Element ccs_service = doc.createElement(GSXML.SERVICE_ELEM);
120 ccs_service.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_QUERY);
121 ccs_service.setAttribute(GSXML.NAME_ATT, TEXT_QUERY_SERVICE);
122
123 // display info
124 if (subset == null || subset.equals(GSXML.DISPLAY_TEXT_ELEM + GSXML.LIST_MODIFIER))
125 {
126 ccs_service.appendChild(GSXML.createDisplayTextElement(doc, GSXML.DISPLAY_TEXT_NAME, getTextString(TEXT_QUERY_SERVICE + ".name", lang)));
127 ccs_service.appendChild(GSXML.createDisplayTextElement(doc, GSXML.DISPLAY_TEXT_SUBMIT, getTextString(TEXT_QUERY_SERVICE + ".submit", lang)));
128 ccs_service.appendChild(GSXML.createDisplayTextElement(doc, GSXML.DISPLAY_TEXT_DESCRIPTION, getTextString(TEXT_QUERY_SERVICE + ".description", lang)));
129 }
130 // param info
131 if (subset == null || subset.equals(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER))
132 {
133 Element param_list = doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
134 // collection list
135 if (coll_ids_list == null)
136 {
137 initCollectionList(lang);
138 }
139 if (!coll_names_map.containsKey(lang))
140 {
141 addCollectionNames(lang);
142 }
143 Element param = GSXML.createParameterDescription(doc, COLLECTION_PARAM, getTextString("param." + COLLECTION_PARAM, lang), GSXML.PARAM_TYPE_ENUM_MULTI, "all", coll_ids_list, coll_names_map.get(lang));
144 param_list.appendChild(param);
145 // max docs param
146 param = GSXML.createParameterDescription(doc, MAXDOCS_PARAM, getTextString("param." + MAXDOCS_PARAM, lang), GSXML.PARAM_TYPE_INTEGER, MAXDOCS_DEFAULT, null, null);
147 param_list.appendChild(param);
148 // query param
149 param = GSXML.createParameterDescription(doc, QUERY_PARAM, getTextString("param." + QUERY_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
150 param_list.appendChild(param);
151 ccs_service.appendChild(param_list);
152 }
153
154 logger.debug("service description=" + this.converter.getPrettyString(ccs_service));
155 return ccs_service;
156 }
157 // these ones are probably never called, but put them here just in case
158 Element service_elem = doc.createElement(GSXML.SERVICE_ELEM);
159 service_elem.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_RETRIEVE);
160 service_elem.setAttribute(GSXML.NAME_ATT, service);
161 return service_elem;
162
163 }
164
165 protected Element processTextQuery(Element request)
166 {
167 // Create a new (empty) result message
168 Document result_doc = XMLConverter.newDOM();
169 Element result = result_doc.createElement(GSXML.RESPONSE_ELEM);
170 result.setAttribute(GSXML.FROM_ATT, TEXT_QUERY_SERVICE);
171 result.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
172
173 UserContext userContext = new UserContext(request);
174
175 // Get the parameters of the request
176 Element param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
177 if (param_list == null)
178 {
179 logger.error("TextQuery request had no paramList.");
180 return result; // Return the empty result
181 }
182 // get the collection list
183 String[] colls_list = coll_ids_list_no_all;
184 Element coll_param = GSXML.getNamedElement(param_list, GSXML.PARAM_ELEM, GSXML.NAME_ATT, COLLECTION_PARAM);
185 if (coll_param != null)
186 {
187 String coll_list = GSXML.getValue(coll_param);
188 if (!coll_list.equals("all") && !coll_list.equals(""))
189 {
190 colls_list = coll_list.split(",");
191 }
192 }
193
194 colls_list = mergeGroups(userContext, param_list, colls_list);
195
196 String maxdocs = MAXDOCS_DEFAULT;
197 Element maxdocs_param = GSXML.getNamedElement(param_list, GSXML.PARAM_ELEM, GSXML.NAME_ATT, MAXDOCS_PARAM);
198 if (maxdocs_param != null) {
199 maxdocs = GSXML.getValue(maxdocs_param);
200 }
201
202 Document msg_doc = XMLConverter.newDOM();
203 Element query_message = msg_doc.createElement(GSXML.MESSAGE_ELEM);
204 // we are sending the same request to each collection - build up the to
205 // attribute for the request
206 StringBuffer to_att = new StringBuffer();
207 for (int i = 0; i < colls_list.length; i++)
208 {
209 if (i > 0)
210 {
211 to_att.append(",");
212 }
213 to_att.append(GSPath.appendLink(colls_list[i], "TextQuery"));
214
215 }
216 // send the query to all colls
217 Element query_request = GSXML.createBasicRequest(msg_doc, GSXML.REQUEST_TYPE_PROCESS, to_att.toString(), userContext);
218 query_message.appendChild(query_request);
219 // should we add params individually?
220 Element new_param_list = msg_doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
221 query_request.appendChild(new_param_list);
222 new_param_list.appendChild(msg_doc.importNode(GSXML.getNamedElement(param_list, GSXML.PARAM_ELEM, GSXML.NAME_ATT, QUERY_PARAM), true));
223
224 // for cross coll search, we only want maxdocs from each collection
225 // some colls use maxdocs, some use hits per page so lets send both
226 new_param_list.appendChild(GSXML.createParameter(msg_doc, MAXDOCS_PARAM, maxdocs));
227 new_param_list.appendChild(GSXML.createParameter(msg_doc, HITS_PER_PAGE_PARAM, maxdocs));
228 Element query_result = (Element) this.router.process(query_message);
229 // create the doc list for the response
230 Element doc_node_list = result_doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
231 result.appendChild(doc_node_list);
232 Element result_snippet_list = result_doc.createElement(GSXML.HL_SNIPPET_ELEM + GSXML.LIST_MODIFIER);
233 result.appendChild(result_snippet_list);
234
235 NodeList responses = query_result.getElementsByTagName(GSXML.RESPONSE_ELEM);
236 int num_docs = 0;
237 for (int k = 0; k < responses.getLength(); k++)
238 {
239 String coll_name = GSPath.removeLastLink(((Element) responses.item(k)).getAttribute(GSXML.FROM_ATT));
240 NodeList nodes = ((Element) responses.item(k)).getElementsByTagName(GSXML.DOC_NODE_ELEM);
241 if (nodes == null || nodes.getLength() == 0)
242 continue;
243 num_docs += nodes.getLength();
244 Element last_node = null;
245 Element this_node = null;
246 for (int n = 0; n < nodes.getLength(); n++)
247 {
248 this_node = (Element) nodes.item(n);
249 this_node.setAttribute("collection", coll_name);
250
251 if (k == 0)
252 {
253
254 doc_node_list.appendChild(result_doc.importNode(this_node, true));
255 }
256 else
257 {
258 if (last_node == null)
259 {
260 last_node = (Element) GSXML.getChildByTagName(doc_node_list, GSXML.DOC_NODE_ELEM);
261 }
262 last_node = GSXML.insertIntoOrderedList(doc_node_list, GSXML.DOC_NODE_ELEM, last_node, this_node, "rank", true);
263 }
264
265 }
266 NodeList hl_snippet_list = ((Element) responses.item(k)).getElementsByTagName(GSXML.HL_SNIPPET_ELEM);
267 if (hl_snippet_list != null){
268 for (int hls = 0; hls < hl_snippet_list.getLength(); hls++){
269 Element this_hls = (Element) hl_snippet_list.item(hls);
270 this_hls.setAttribute("collection", coll_name);
271 result_snippet_list.appendChild(result_doc.importNode(this_hls, true));
272 }
273 }
274
275 }
276 // just send back num docs returned. Too hard to work out number of matches etc as each index type
277 // does it differently
278 Element metadata_list = result_doc.createElement(GSXML.METADATA_ELEM + GSXML.LIST_MODIFIER);
279 result.appendChild(metadata_list);
280 GSXML.addMetadata(metadata_list, "numDocsReturned", "" + num_docs);
281 return result;
282 }
283
284 // protected Element processAdvTextQuery(Element request)
285 // {
286
287 // }
288
289
290
291 protected boolean initCollectionList(String lang)
292 {
293 UserContext userContext = new UserContext();
294 userContext.setLanguage(lang);
295 userContext.setUserID("");
296
297 // first, get the message router info
298 Document msg_doc = XMLConverter.newDOM();
299 Element coll_list_message = msg_doc.createElement(GSXML.MESSAGE_ELEM);
300 Element coll_list_request = GSXML.createBasicRequest(msg_doc, GSXML.REQUEST_TYPE_DESCRIBE, "", userContext); // uid
301 coll_list_message.appendChild(coll_list_request);
302 //logger.debug("coll list request = " + this.converter.getPrettyString(coll_list_request));
303 Element coll_list_response = (Element) this.router.process(coll_list_message);
304 if (coll_list_response == null)
305 {
306 logger.error("couldn't query the message router!");
307 return false;
308 }
309 //logger.debug("coll list response = " + this.converter.getPrettyString(coll_list_response));
310 // second, get some info from each collection. we want the coll name
311 // and whether its got a text query service
312
313 NodeList colls = coll_list_response.getElementsByTagName(GSXML.COLLECTION_ELEM);
314 // we can send the same request to multiple collections at once by using a comma separated list
315 Element metadata_message = msg_doc.createElement(GSXML.MESSAGE_ELEM);
316 StringBuffer colls_sb = new StringBuffer();
317 for (int i = 0; i < colls.getLength(); i++)
318 {
319 Element c = (Element) colls.item(i);
320 String name = c.getAttribute(GSXML.NAME_ATT);
321 if (i != 0)
322 {
323 colls_sb.append(",");
324 }
325 colls_sb.append(name);
326 //Element metadata_request = GSXML.createBasicRequest(this.doc, GSXML.REQUEST_TYPE_DESCRIBE, name, userContext);
327 //metadata_message.appendChild(metadata_request);
328 }
329
330 Element metadata_request = GSXML.createBasicRequest(msg_doc, GSXML.REQUEST_TYPE_DESCRIBE, colls_sb.toString(), userContext);
331 metadata_message.appendChild(metadata_request);
332 //logger.debug("metadata request = " + this.converter.getPrettyString(metadata_message));
333 Element metadata_response = (Element) this.router.process(metadata_message);
334 //logger.debug("metadata response = " + this.converter.getPrettyString(metadata_response));
335 NodeList coll_responses = metadata_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
336 ArrayList<String> valid_colls = new ArrayList<String>();
337 ArrayList<String> valid_coll_names = new ArrayList<String>();
338 for (int i = 0; i < coll_responses.getLength(); i++)
339 {
340 Element response = (Element) coll_responses.item(i);
341 Element coll = (Element) GSXML.getChildByTagName(response, GSXML.COLLECTION_ELEM);
342 Element service_list = (Element) GSXML.getChildByTagName(coll, GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
343 if (service_list == null)
344 continue;
345 Element query_service = GSXML.getNamedElement(service_list, GSXML.SERVICE_ELEM, GSXML.NAME_ATT, TEXT_QUERY_SERVICE); // should be AbstractTextSearch.TEXT_QUERY_SERVICE
346 if (query_service == null)
347 continue;
348 // use the name of the response in case we are talking to a remote collection, not the name of the collection.
349 String coll_id = response.getAttribute(GSXML.FROM_ATT);
350 String coll_name = getDisplayText(coll, GSXML.DISPLAY_TEXT_NAME, lang, "en");
351 valid_colls.add(coll_id);
352 valid_coll_names.add(coll_name);
353 }
354
355 this.coll_names_map = new HashMap<String, String[]>();
356
357 // ids no all has the list without 'all' option.
358 this.coll_ids_list_no_all = new String[1];
359 this.coll_ids_list_no_all = valid_colls.toArray(coll_ids_list_no_all);
360
361 valid_colls.add(0, "all");
362 valid_coll_names.add(0, getTextString("param." + COLLECTION_PARAM + ".all", lang));
363
364 this.coll_ids_list = new String[1];
365 this.coll_ids_list = valid_colls.toArray(coll_ids_list);
366
367 String[] coll_names_list = new String[1];
368 coll_names_list = valid_coll_names.toArray(coll_names_list);
369 this.coll_names_map.put(lang, coll_names_list);
370 return true;
371 }
372
373 protected void addCollectionNames(String lang)
374 {
375
376 UserContext userContext = new UserContext();
377 userContext.setLanguage(lang);
378 userContext.setUserID("");
379
380 ArrayList<String> coll_names = new ArrayList<String>();
381 coll_names.add(getTextString("param." + COLLECTION_PARAM + ".all", lang));
382
383 // need to request MR for collection descriptions
384 Document msg_doc = XMLConverter.newDOM();
385 Element metadata_message = msg_doc.createElement(GSXML.MESSAGE_ELEM);
386
387 // get a comma separated list of coll ids to send to MR
388 // the first item is the place holder for 'all'
389 StringBuffer colls_sb = new StringBuffer();
390 for (int i = 1; i < coll_ids_list.length; i++)
391 {
392 if (i != 1)
393 {
394 colls_sb.append(",");
395 }
396 colls_sb.append(coll_ids_list[i]);
397 }
398 Element metadata_request = GSXML.createBasicRequest(msg_doc, GSXML.REQUEST_TYPE_DESCRIBE, colls_sb.toString(), userContext);
399 // param_list to request just displayTextList
400 Element param_list = msg_doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
401 Element param = GSXML.createParameter(msg_doc, GSXML.SUBSET_PARAM, GSXML.DISPLAY_TEXT_ELEM + GSXML.LIST_MODIFIER);
402 param_list.appendChild(param);
403 metadata_request.appendChild(param_list);
404 metadata_message.appendChild(metadata_request);
405 //logger.debug("coll names metadata request = " + this.converter.getPrettyString(metadata_message));
406 Element metadata_response = (Element) this.router.process(metadata_message);
407 //logger.debug("coll names metadata response = " + this.converter.getPrettyString(metadata_response));
408 NodeList coll_responses = metadata_response.getElementsByTagName(GSXML.RESPONSE_ELEM);
409 for (int i = 0; i < coll_responses.getLength(); i++)
410 {
411 Element response = (Element) coll_responses.item(i);
412 Element coll = (Element) GSXML.getChildByTagName(response, GSXML.COLLECTION_ELEM);
413 String coll_name = getDisplayText(coll, GSXML.DISPLAY_TEXT_NAME, lang, "en");
414 coll_names.add(coll_name);
415 }
416
417 String[] coll_names_list = new String[1];
418 coll_names_list = coll_names.toArray(coll_names_list);
419 this.coll_names_map.put(lang, coll_names_list);
420
421 }
422
423 protected Element processDocumentMetadataRetrieve(Element request)
424 {
425 // Create a new (empty) result message
426 Document result_doc = XMLConverter.newDOM();
427 Element result = result_doc.createElement(GSXML.RESPONSE_ELEM);
428 result.setAttribute(GSXML.FROM_ATT, DOCUMENT_METADATA_RETRIEVE_SERVICE);
429 result.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_PROCESS);
430
431 UserContext userContext = new UserContext(request);
432 // Get the parameters of the request
433 Element param_list = (Element) GSXML.getChildByTagName(request, GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
434 if (param_list == null)
435 {
436 logger.error("DocumentMetadataRetrieve request had no paramList.");
437 return result; // Return the empty result
438 }
439
440 NodeList query_doc_list = request.getElementsByTagName(GSXML.DOC_NODE_ELEM);
441 if (query_doc_list.getLength() == 0)
442 {
443 logger.error("DocumentMetadataRetrieve request had no documentNodes.");
444 return result; // Return the empty result
445 }
446
447 // the resulting doc node list
448 Element result_node_list = result_doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
449 result.appendChild(result_node_list);
450
451
452 // organise the nodes into collection lists
453 HashMap<String, Node> coll_map = new HashMap<String, Node>();
454
455 for (int i = 0; i < query_doc_list.getLength(); i++)
456 {
457 Element doc_node = (Element) query_doc_list.item(i);
458 String coll_name = doc_node.getAttribute("collection");
459 Element coll_items = (Element) coll_map.get(coll_name);
460 if (coll_items == null)
461 {
462 coll_items = result_doc.createElement(GSXML.DOC_NODE_ELEM + GSXML.LIST_MODIFIER);
463 coll_map.put(coll_name, coll_items);
464 }
465 coll_items.appendChild(result_doc.importNode(doc_node, true));
466 }
467
468 // create teh individual requests
469 Document msg_doc = XMLConverter.newDOM();
470 Element meta_request_message = msg_doc.createElement(GSXML.MESSAGE_ELEM);
471
472 Set mapping_set = coll_map.entrySet();
473 Iterator iter = mapping_set.iterator();
474
475 while (iter.hasNext())
476 {
477 Map.Entry e = (Map.Entry) iter.next();
478 String cname = (String) e.getKey();
479 Element doc_nodes = (Element) e.getValue();
480 Element meta_request = GSXML.createBasicRequest(msg_doc, GSXML.REQUEST_TYPE_PROCESS, GSPath.appendLink(cname, DOCUMENT_METADATA_RETRIEVE_SERVICE), userContext);
481 meta_request.appendChild(msg_doc.importNode(doc_nodes, true));
482 meta_request.appendChild(msg_doc.importNode(param_list, true));
483 meta_request_message.appendChild(meta_request);
484
485 }
486
487 Node meta_result_node = this.router.process(meta_request_message);
488 Element meta_result = GSXML.nodeToElement(meta_result_node);
489
490 // now need to put the doc nodes back in the right order
491 // go through the original list again. keep an element pointer to
492 // the next element in each collections list
493 NodeList meta_responses = meta_result.getElementsByTagName(GSXML.RESPONSE_ELEM);
494 for (int i = 0; i < meta_responses.getLength(); i++)
495 {
496 String collname = GSPath.removeLastLink(((Element) meta_responses.item(i)).getAttribute(GSXML.FROM_ATT));
497 Element first_elem = (Element) GSXML.getNodeByPath(meta_responses.item(i), "documentNodeList/documentNode");
498 coll_map.put(collname, first_elem);
499 }
500
501 for (int i = 0; i < query_doc_list.getLength(); i++)
502 {
503 Element doc_node = (Element) query_doc_list.item(i);
504 Element new_node = (Element) result_doc.importNode(doc_node, false);
505 result_node_list.appendChild(new_node);
506 String coll_name = doc_node.getAttribute("collection");
507
508 Element meta_elem = (Element) coll_map.get(coll_name);
509 GSXML.mergeMetadataLists(new_node, meta_elem);
510 coll_map.put(coll_name, meta_elem.getNextSibling());
511 }
512 return result;
513 }
514
515 private String[] mergeGroups(UserContext userContext, Element paramList, String[] collArray){
516 Document doc = XMLConverter.newDOM();
517 boolean allSelected = false;
518 Element groupParamList = extractGroupParams(paramList, collArray, doc);
519 Element collParam = GSXML.getNamedElement(paramList, GSXML.PARAM_ELEM, GSXML.NAME_ATT, COLLECTION_PARAM);
520 if (collParam != null) {
521 String collValue = GSXML.getValue(collParam);
522 if (collValue != null) {
523 allSelected = collValue.matches(".*\\ball\\b.*");
524 }
525 }
526 //Group param not empty and coll param null or not 'all'
527 if ( allSelected || !groupParamList.hasChildNodes())
528 {
529 return collArray;
530 }
531 //GroupInfo service to get uniq collections
532 String uniqCollServiceName = "UniqueCollections";
533 Element infoResponse = getMRInfo(userContext);
534 Element serviceList = (Element) GSXML.getChildByTagName(infoResponse, GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
535 if (serviceList == null) {
536 logger.error("Service list is null!");
537 return collArray;
538 }
539 Element groupInfoService = GSXML.getNamedElement(serviceList, GSXML.SERVICE_ELEM, GSXML.NAME_ATT, uniqCollServiceName);
540 if (groupInfoService == null){
541 logger.error("UniqueCollections service unavailable; Check your groupConfig.xml");
542 return collArray;
543 }
544 Element groupQueryMessage = doc.createElement(GSXML.MESSAGE_ELEM);
545 Element groupQueryRequest = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_PROCESS, uniqCollServiceName, userContext);
546 groupQueryMessage.appendChild(groupQueryRequest);
547 groupQueryRequest.appendChild(groupParamList);
548 if (collParam != null){
549 groupParamList.appendChild(doc.importNode(GSXML.getNamedElement(paramList, GSXML.PARAM_ELEM, GSXML.NAME_ATT, GSXML.COLLECTION_ELEM), true));
550 }
551 Element groupQueryResult = (Element) this.router.process(groupQueryMessage);
552 Element groupQueryResponse = (Element) GSXML.getChildByTagName(groupQueryResult, GSXML.RESPONSE_ELEM);
553 Element collList = (Element) GSXML.getChildByTagName(groupQueryResponse, GSXML.COLLECTION_ELEM + GSXML.LIST_MODIFIER);
554 NodeList collections = GSXML.getChildrenByTagName(collList, GSXML.COLLECTION_ELEM);
555 collArray = new String[collections.getLength()];
556 for (int i = 0; i < collections.getLength(); i++){
557 String collName = ((Element) collections.item(i)).getAttribute(GSXML.NAME_ATT);
558 collArray[i] = collName;
559 }
560 return collArray;
561
562 }
563
564 private Element extractGroupParams(Element paramList, String[] collArray, Document doc) {
565 Element groupParamList = doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
566 Element groupParam = null;
567 Element groupNode = GSXML.getNamedElement(paramList, GSXML.PARAM_ELEM, GSXML.NAME_ATT, GROUP_PARAM);
568 if (groupNode != null){
569 groupParam = (Element) doc.importNode(groupNode, true);
570 groupParamList.appendChild(groupParam);
571 } else {
572 groupParam = doc.createElement(GSXML.PARAM_ELEM);
573 groupParam.setAttribute(GSXML.NAME_ATT, GSXML.GROUP_ELEM);
574 groupParamList.appendChild(groupParam);
575 }
576 String prefix = GSXML.GROUP_ELEM + ".";
577 for (int i = 0; i < collArray.length; i++) {
578 String collectionParam = collArray[i];
579 if (collectionParam.startsWith(prefix)){
580 String value = groupParam.getAttribute(GSXML.VALUE_ATT);
581 String group = collectionParam.substring(prefix.length() - 1 );
582 group=group.replace('.', '/'); // we use . instead of / in args
583 value += "," + group;
584 groupParam.setAttribute(GSXML.VALUE_ATT, value);
585 }
586 }
587 return groupParamList;
588 }
589
590 private Element getMRInfo(UserContext userContext){
591 Document doc = XMLConverter.newDOM();
592 Element infoMessage = doc.createElement(GSXML.MESSAGE_ELEM);
593 Element infoRequest = GSXML.createBasicRequest(doc, GSXML.REQUEST_TYPE_DESCRIBE, "", userContext);
594 Element paramList = doc.createElement(GSXML.PARAM_ELEM + GSXML.LIST_MODIFIER);
595 infoRequest.appendChild(paramList);
596 GSXML.addParameterToList(paramList, GSXML.SUBSET_PARAM, GSXML.SERVICE_ELEM + GSXML.LIST_MODIFIER);
597 infoMessage.appendChild(infoRequest);
598 Element responseMessage = (Element) this.router.process(infoMessage);
599 if (responseMessage == null)
600 {
601 logger.error("couldn't query the message router!");
602 return null;
603 }
604 Element infoResponse = (Element) GSXML.getChildByTagName(responseMessage, GSXML.RESPONSE_ELEM);
605 if (infoResponse == null)
606 {
607 logger.error("response from message router is null!");
608 return null;
609 }
610
611 return infoResponse;
612
613 }
614
615}
Note: See TracBrowser for help on using the repository browser.