1 package com.indexdata.pz2utils4jsf.pazpar2;
\r
3 import java.util.ArrayList;
\r
4 import java.util.List;
\r
5 import java.util.Map;
\r
6 import java.util.StringTokenizer;
\r
7 import java.util.concurrent.ConcurrentHashMap;
\r
9 import javax.enterprise.context.SessionScoped;
\r
10 import javax.inject.Named;
\r
12 import org.apache.log4j.Logger;
\r
14 import com.indexdata.pz2utils4jsf.config.ConfigurationReader;
\r
15 import com.indexdata.pz2utils4jsf.controls.ResultsPager;
\r
16 import com.indexdata.pz2utils4jsf.errors.ConfigurationError;
\r
17 import com.indexdata.pz2utils4jsf.errors.ConfigurationException;
\r
18 import com.indexdata.pz2utils4jsf.errors.ErrorHelper;
\r
19 import com.indexdata.pz2utils4jsf.errors.ErrorInterface;
\r
20 import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget;
\r
21 import com.indexdata.pz2utils4jsf.pazpar2.data.CommandError;
\r
22 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseData;
\r
23 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseParser;
\r
24 import com.indexdata.pz2utils4jsf.pazpar2.data.RecordResponse;
\r
25 import com.indexdata.pz2utils4jsf.pazpar2.data.SearchResponse;
\r
26 import com.indexdata.pz2utils4jsf.pazpar2.data.ShowResponse;
\r
27 import com.indexdata.pz2utils4jsf.pazpar2.data.StatResponse;
\r
28 import com.indexdata.pz2utils4jsf.pazpar2.data.TermListsResponse;
\r
29 import com.indexdata.pz2utils4jsf.pazpar2.data.TermResponse;
\r
30 import com.indexdata.pz2utils4jsf.pazpar2.state.QueryStates;
\r
31 import com.indexdata.pz2utils4jsf.utils.Utils;
\r
33 @Named @SessionScoped
\r
34 public class Pz2Session implements Pz2Interface {
\r
36 private static final long serialVersionUID = 3947514708343320514L;
\r
37 private static Logger logger = Logger.getLogger(Pz2Session.class);
\r
39 protected Map<String,Pazpar2ResponseData> dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();
\r
40 protected QueryStates queryStates = new QueryStates();
\r
41 protected ErrorHelper errorHelper = null;
\r
43 protected List<ErrorInterface> configurationErrors = null;
\r
44 protected SearchClient searchClient = null;
\r
45 protected TargetFilter targetFilter = null;
\r
46 protected ResultsPager pager = null;
\r
48 public Pz2Session () {
\r
49 logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]");
\r
52 public void init(SearchClient searchClient, ConfigurationReader configReader) {
\r
53 configurationErrors = new ArrayList<ErrorInterface>();
\r
54 errorHelper = new ErrorHelper(configReader);
\r
55 logger.debug(Utils.objectId(this) + " will configure search client for the session");
\r
57 searchClient.configure(configReader);
\r
58 // At the time of writing this search client is injected using Weld.
\r
59 // However, the client is used for asynchronously sending off requests
\r
60 // to the server AND propagation of context to threads is currently
\r
61 // not supported. Trying to do so throws a WELD-001303 error.
\r
62 // To avoid that, a context free client is cloned from the context
\r
64 // If propagation to threads gets supported, the cloning can go.
\r
65 this.searchClient = searchClient.cloneMe();
\r
67 } catch (ConfigurationException e) {
\r
68 configurationErrors.add(new ConfigurationError("Search Client","Configuration",e.getMessage(),new ErrorHelper(configReader)));
\r
70 logger.info(configReader.document());
\r
74 public void doSearch(String query) {
\r
75 setCommandParameter("search",new CommandParameter("query","=",query));
\r
79 public void doSearch() {
\r
80 queryStates.hasPendingStateChange("search",false);
\r
82 setCommandParameter("show",new CommandParameter("start","=",0));
\r
83 logger.debug(Utils.objectId(this) + " is searching using "+getCommand("search").getParameter("query").getEncodedQueryString());
\r
84 doCommand("search");
\r
88 * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2
\r
90 * @return Number of activeclients at the time of the 'show' command.
\r
92 public String update () {
\r
93 logger.debug("Updating show,stat,termlist,bytarget from pazpar2");
\r
94 return update("show,stat,termlist,bytarget");
\r
98 * Refreshes the data objects listed in 'commands' from pazpar2
\r
101 * @return Number of activeclients at the time of the 'show' command
\r
103 public String update (String commands) {
\r
104 if (! hasConfigurationErrors()) {
\r
106 handleQueryStateChanges(commands);
\r
107 logger.debug("Processing request for " + commands);
\r
108 List<CommandThread> threadList = new ArrayList<CommandThread>();
\r
109 StringTokenizer tokens = new StringTokenizer(commands,",");
\r
110 while (tokens.hasMoreElements()) {
\r
111 threadList.add(new CommandThread(getCommand(tokens.nextToken()),searchClient));
\r
113 for (CommandThread thread : threadList) {
\r
116 for (CommandThread thread : threadList) {
\r
119 } catch (InterruptedException e) {
\r
120 e.printStackTrace();
\r
123 for (CommandThread thread : threadList) {
\r
124 String commandName = thread.getCommand().getName();
\r
125 String response = thread.getResponse();
\r
126 logger.debug("Response was: " + response);
\r
127 Pazpar2ResponseData responseObject = Pazpar2ResponseParser.getParser().getDataObject(response);
\r
128 dataObjects.put(commandName, responseObject);
\r
130 return getActiveClients();
\r
132 logger.debug("Skipped requests for " + commands + " as there's not yet a query.");
\r
133 resetDataObjects();
\r
137 logger.error("Did not attempt to execute query since there are configuration errors.");
\r
143 public void setQuery (String query) {
\r
144 logger.debug("Creating new command parameter for " + query);
\r
145 setCommandParameter("search",new CommandParameter("query","=",query));
\r
148 public String getQuery () {
\r
149 return getCommandParameterValueSimple("search","query",null);
\r
152 public void setFacet (String facetKey, String term) {
\r
153 if (term != null && term.length()>0) {
\r
154 queryStates.getCurrentState().setCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);
\r
159 public void setFacetOnQuery (String facetKey, String term) {
\r
160 String facetExpression = facetKey + "=" + term;
\r
161 if (term != null && term.length()>0) {
\r
162 setCommandParameter("search",new CommandParameter("query","=", getQuery() + " and " + facetExpression));
\r
167 public void removeFacet(String facetKey, String term) {
\r
168 queryStates.getCurrentState().removeCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);
\r
172 public void setTargetFilter (String targetId, String targetName) {
\r
173 if (hasTargetFilter(new TargetFilter(targetId,targetName))) {
\r
174 logger.debug("Already using target filter " + this.targetFilter.getFilterExpression());
\r
176 this.targetFilter = new TargetFilter(targetId,targetName);
\r
177 setCommandParameter("search",new CommandParameter("filter","=",this.targetFilter.getFilterExpression()));
\r
182 public TargetFilter getTargetFilter () {
\r
183 return targetFilter;
\r
186 public void removeTargetFilter () {
\r
187 logger.debug("Removing target filter " + targetFilter.getFilterExpression());
\r
188 this.targetFilter = null;
\r
189 removeCommandParameter("search","filter");
\r
193 public boolean hasTargetFilter() {
\r
194 return targetFilter != null;
\r
197 public void setSort (String sortOption) {
\r
198 logger.debug("Setting sort option: " + sortOption);
\r
199 setCommandParameter("show",new CommandParameter("sort","=",sortOption));
\r
203 public String getSort () {
\r
204 return getCommandParameterValue("show","sort","relevance");
\r
207 public void setPageSize (int perPageOption) {
\r
208 if (getPageSize()!=perPageOption) {
\r
209 logger.debug("Setting perpage option to " + perPageOption + " and resetting start page.");
\r
210 setCommandParameter("show",new CommandParameter("num","=",perPageOption));
\r
211 setCommandParameter("show",new CommandParameter("start","=",0));
\r
214 logger.debug("Not updating page size, already is " + perPageOption);
\r
218 public int getPageSize () {
\r
219 return getCommandParameterValue("show","num",20);
\r
222 public void setStart (int start) {
\r
223 logger.debug("Setting start num to " + start);
\r
224 setCommandParameter("show", new CommandParameter("start","=",start));
\r
228 public int getStart() {
\r
229 return getCommandParameterValue("show","start",0);
\r
232 public String toggleRecord (String recId) {
\r
233 if (hasRecord(recId)) {
\r
234 removeCommand("record");
\r
235 dataObjects.put("record", new RecordResponse());
\r
238 return updateRecord(recId);
\r
242 private String updateRecord(String recId) {
\r
243 setCommandParameter("record",new CommandParameter("id","=",recId));
\r
244 return doCommand("record");
\r
247 public boolean hasRecord (String recId) {
\r
248 return getCommand("record").hasParameters() && getRecord().getRecId().equals(recId);
\r
251 public ShowResponse getShow () {
\r
252 return ((ShowResponse) dataObjects.get("show"));
\r
255 public StatResponse getStat () {
\r
256 return ((StatResponse) dataObjects.get("stat"));
\r
259 public RecordResponse getRecord() {
\r
260 return ((RecordResponse) dataObjects.get("record"));
\r
263 public TermListsResponse getTermLists () {
\r
264 return ((TermListsResponse) dataObjects.get("termlist"));
\r
267 public List<TermResponse> getFacetTerms (String facet, int count) {
\r
268 return (getTermLists().getTermList(facet).getTerms(count));
\r
271 public List<TermResponse> getFacetTerms (String facet) {
\r
272 return (getTermLists().getTermList(facet).getTerms());
\r
275 public ByTarget getByTarget() {
\r
276 return ((ByTarget) dataObjects.get("bytarget"));
\r
280 public String getCurrentStateKey () {
\r
281 return queryStates.getCurrentStateKey();
\r
284 public void setCurrentStateKey(String key) {
\r
285 queryStates.setCurrentStateKey(key);
\r
288 public boolean hasConfigurationErrors () {
\r
289 return (configurationErrors.size()>0);
\r
292 public boolean hasCommandErrors () {
\r
293 if (dataObjects.get("search").hasApplicationError()) {
\r
294 logger.info("Error detected in search");
\r
297 for (String name : dataObjects.keySet()) {
\r
298 if (dataObjects.get(name).hasApplicationError()) {
\r
299 logger.info("Error detected in " + name);
\r
307 * Returns true if application error found in any response data objects
\r
309 public boolean hasErrors () {
\r
310 return hasConfigurationErrors() || hasCommandErrors();
\r
313 public List<ErrorInterface> getConfigurationErrors() {
\r
314 return configurationErrors;
\r
318 * Returns a search command error, if any, otherwise the first
\r
319 * error found for an arbitrary command, if any, otherwise
\r
320 * an empty dummy error.
\r
322 public ErrorInterface getCommandError() {
\r
323 CommandError error = new CommandError();
\r
324 if (dataObjects.get("search").hasApplicationError()) {
\r
325 error = dataObjects.get("search").getApplicationError();
\r
327 for (String name : dataObjects.keySet()) {
\r
328 if (dataObjects.get(name).hasApplicationError()) {
\r
329 error = dataObjects.get(name).getApplicationError();
\r
334 error.setErrorHelper(errorHelper);
\r
339 protected boolean hasTargetFilter(TargetFilter targetFilter) {
\r
340 return hasTargetFilter() && targetFilter.equals(this.targetFilter);
\r
343 protected boolean hasQuery() {
\r
344 return !(getCommand("search").getParameter("query") == null);
\r
347 public boolean hasRecords () {
\r
348 return getStat().getRecords() > 0
\r
349 && getShow().getHits() != null
\r
350 && getShow().getHits().size()>0;
\r
353 public ResultsPager getPager () {
\r
354 if (pager == null) {
\r
355 pager = new ResultsPager(this);
\r
360 public ResultsPager setPager (int pageRange) {
\r
361 pager = new ResultsPager(this,pageRange);
\r
365 protected ErrorHelper getTroubleshooter() {
\r
366 return errorHelper;
\r
369 protected void handleQueryStateChanges (String commands) {
\r
370 if (queryStates.hasPendingStateChange("search")) {
\r
371 logger.debug("Found pending search change. Doing search before updating " + commands);
\r
374 if (queryStates.hasPendingStateChange("record") && ! commands.equals("record")) {
\r
375 logger.debug("Found pending record ID change. Doing record before updating " + commands);
\r
376 queryStates.hasPendingStateChange("record",false);
\r
377 if (getCommand("record").hasParameters()) {
\r
378 updateRecord(getCommand("record").getParameter("id").getSimpleValue());
\r
380 removeCommand("record");
\r
381 dataObjects.put("record", new RecordResponse());
\r
386 protected String getActiveClients() {
\r
387 if (getShow()!=null) {
\r
388 logger.debug("Active clients: "+getShow().getActiveClients());
\r
389 return getShow().getActiveClients();
\r
395 protected Pazpar2Command getCommand(String name) {
\r
396 return queryStates.getCurrentState().getCommand(name);
\r
399 protected void setCommandParameter(String commandName, CommandParameter parameter) {
\r
400 logger.debug("Setting parameter for " + commandName + ": " + parameter);
\r
401 queryStates.getCurrentState().setCommandParameter(commandName, parameter, queryStates);
\r
405 protected void removeCommandParameter(String commandName, String parameterName) {
\r
406 queryStates.getCurrentState().removeCommandParameter(commandName,parameterName,queryStates);
\r
409 protected void removeCommand (String commandName) {
\r
410 queryStates.getCurrentState().removeCommand(commandName, queryStates);
\r
413 protected String getCommandParameterValue (String commandName, String parameterName, String defaultValue) {
\r
414 Pazpar2Command command = getCommand(commandName);
\r
415 if (command != null) {
\r
416 CommandParameter parameter = command.getParameter(parameterName);
\r
417 if (parameter != null) {
\r
418 return parameter.getValueWithExpressions();
\r
421 return defaultValue;
\r
424 protected String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) {
\r
425 Pazpar2Command command = getCommand(commandName);
\r
426 if (command != null) {
\r
427 CommandParameter parameter = command.getParameter(parameterName);
\r
428 if (parameter != null) {
\r
429 return parameter.getSimpleValue();
\r
432 return defaultValue;
\r
436 protected int getCommandParameterValue (String commandName, String parameterName, int defaultValue) {
\r
437 Pazpar2Command command = getCommand(commandName);
\r
438 if (command != null) {
\r
439 CommandParameter parameter = command.getParameter(parameterName);
\r
440 if (parameter != null) {
\r
441 return Integer.parseInt(parameter.getSimpleValue());
\r
444 return defaultValue;
\r
447 protected String doCommand(String commandName) {
\r
448 Pazpar2Command command = getCommand(commandName);
\r
449 logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString());
\r
450 return update(commandName);
\r
453 protected void resetDataObjects() {
\r
454 logger.debug("Resetting show,stat,termlist,bytarget,search response objects.");
\r
455 dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();
\r
456 dataObjects.put("show", new ShowResponse());
\r
457 dataObjects.put("stat", new StatResponse());
\r
458 dataObjects.put("termlist", new TermListsResponse());
\r
459 dataObjects.put("bytarget", new ByTarget());
\r
460 dataObjects.put("record", new RecordResponse());
\r
461 dataObjects.put("search", new SearchResponse());
\r