src/main/java/com/indexdata/pz2utils4jsf/pazpar2/Pz2Session.java

   1 package com.indexdata.pz2utils4jsf.pazpar2;\r
   2 \r
   3 import java.io.IOException;\r
   4 import java.util.ArrayList;\r
   5 import java.util.List;\r
   6 import java.util.Map;\r
   7 import java.util.StringTokenizer;\r
   8 import java.util.concurrent.ConcurrentHashMap;\r
   9 \r
  10 import javax.enterprise.context.SessionScoped;\r
  11 import javax.inject.Named;\r
  12 \r
  13 import org.apache.log4j.Logger;\r
  14 \r
  15 import com.indexdata.masterkey.pazpar2.client.exceptions.ProxyErrorException;\r
  16 import com.indexdata.pz2utils4jsf.config.Pz2Configurator;\r
  17 import com.indexdata.pz2utils4jsf.controls.ResultsPager;\r
  18 import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget;\r
  19 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseData;\r
  20 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseParser;\r
  21 import com.indexdata.pz2utils4jsf.pazpar2.data.RecordResponse;\r
  22 import com.indexdata.pz2utils4jsf.pazpar2.data.SearchResponse;\r
  23 import com.indexdata.pz2utils4jsf.pazpar2.data.ShowResponse;\r
  24 import com.indexdata.pz2utils4jsf.pazpar2.data.StatResponse;\r
  25 import com.indexdata.pz2utils4jsf.pazpar2.data.TermListsResponse;\r
  26 import com.indexdata.pz2utils4jsf.pazpar2.data.TermResponse;\r
  27 import com.indexdata.pz2utils4jsf.pazpar2.state.QueryStates;\r
  28 import com.indexdata.pz2utils4jsf.utils.Utils;\r
  29 \r
  30 @Named @SessionScoped  \r
  31 public class Pz2Session implements Pz2Interface {\r
  32   \r
  33   private static Logger logger = Logger.getLogger(Pz2Session.class);\r
  34   \r
  35   private Map<String,Pazpar2ResponseData> dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
  36   private QueryStates queryStates = new QueryStates();\r
  37   \r
  38   private static final long serialVersionUID = 3947514708343320514L;  \r
  39   private com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration cfg = null;\r
  40   private com.indexdata.masterkey.pazpar2.client.Pazpar2Client client = null;   \r
  41   private TargetFilter targetFilter = null;  \r
  42   private ResultsPager pager = null; \r
  43       \r
  44   public Pz2Session () {\r
  45     logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]");      \r
  46   }\r
  47     \r
  48   public void init(Pz2Configurator pz2conf) {\r
  49     if (client==null) {\r
  50       logger.info(Utils.objectId(this) + " is configuring itself using the provided " + Utils.objectId(pz2conf));\r
  51     try {\r
  52       cfg = new com.indexdata.masterkey.pazpar2.client.Pazpar2ClientConfiguration(pz2conf.getConfig());\r
  53       client = new com.indexdata.masterkey.pazpar2.client.Pazpar2ClientGeneric(cfg);\r
  54       resetDataObjects();\r
  55     } catch (ProxyErrorException e) {\r
  56       e.printStackTrace();\r
  57     } catch (IOException ioe) {\r
  58       ioe.printStackTrace();\r
  59     }\r
  60     } else {\r
  61       logger.warn("Attempt to configure session but it already has a configured client");\r
  62     }\r
  63   }\r
  64     \r
  65   public void doSearch(String query) {\r
  66     setCommandParameter("search",new CommandParameter("query","=",query));     \r
  67     doSearch();\r
  68   }\r
  69 \r
  70   public void doSearch() { \r
  71     queryStates.hasPendingStateChange("search",false);\r
  72     resetDataObjects();\r
  73     setCommandParameter("show",new CommandParameter("start","=",0));    \r
  74     logger.debug(Utils.objectId(this) + " is searching using "+getCommand("search").getParameter("query").getEncodedQueryString());\r
  75     doCommand("search");    \r
  76   }\r
  77       \r
  78   /**\r
  79    * Refreshes 'show', 'stat', 'termlist', and 'bytarget' data object from pazpar2\r
  80    * \r
  81    * @return Number of activeclients at the time of the 'show' command.\r
  82    */\r
  83   public String update () {\r
  84     logger.debug("Updating show,stat,termlist,bytarget from pazpar2");\r
  85     return update("show,stat,termlist,bytarget");\r
  86   }\r
  87    \r
  88   /**\r
  89    * Refreshes the data objects listed in 'commands' from pazpar2\r
  90    * \r
  91    * @param commands\r
  92    * @return Number of activeclients at the time of the 'show' command\r
  93    */\r
  94   public String update (String commands) {\r
  95     if (hasQuery()) {\r
  96       handleQueryStateChanges(commands);\r
  97       logger.debug("Processing request for " + commands); \r
  98       List<CommandThread> threadList = new ArrayList<CommandThread>();\r
  99       StringTokenizer tokens = new StringTokenizer(commands,",");\r
 100       while (tokens.hasMoreElements()) {\r
 101         threadList.add(new CommandThread(getCommand(tokens.nextToken()),client));            \r
 102       }\r
 103       for (CommandThread thread : threadList) {\r
 104         thread.start();\r
 105       }\r
 106       for (CommandThread thread : threadList) {\r
 107         try {\r
 108           thread.join();\r
 109         } catch (InterruptedException e) {\r
 110           e.printStackTrace();\r
 111         }\r
 112       }\r
 113       for (CommandThread thread : threadList) {\r
 114          dataObjects.put(thread.getCommand().getName(), new Pazpar2ResponseParser().getObject(thread.getResponse()));        \r
 115       }\r
 116       return getActiveClients();\r
 117     } else {\r
 118       logger.debug("Skipped requests for " + commands + " as there's not yet a query."); \r
 119       resetDataObjects();\r
 120       return "0";\r
 121     }\r
 122     \r
 123   }\r
 124         \r
 125   public void setQuery (String query) {\r
 126     logger.debug("Creating new command parameter for " + query);\r
 127     setCommandParameter("search",new CommandParameter("query","=",query));\r
 128   }\r
 129   \r
 130   public String getQuery () {\r
 131     return getCommandParameterValueSimple("search","query",null);\r
 132   }\r
 133   \r
 134   public void setFacet (String facetKey, String term) {           \r
 135     if (term != null && term.length()>0) {\r
 136       queryStates.getCurrentState().setCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
 137       doSearch();\r
 138     }            \r
 139   }\r
 140   \r
 141   public void setFacetOnQuery (String facetKey, String term) {\r
 142     String facetExpression = facetKey + "=" + term;    \r
 143     if (term != null && term.length()>0) {\r
 144       setCommandParameter("search",new CommandParameter("query","=", getQuery() + " and " + facetExpression));\r
 145       doSearch();        \r
 146     }            \r
 147   }\r
 148       \r
 149   public void removeFacet(String facetKey, String term) {\r
 150     queryStates.getCurrentState().removeCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
 151     doSearch();\r
 152   }\r
 153   \r
 154   public void setTargetFilter (String targetId, String targetName) {    \r
 155     if (hasTargetFilter(new TargetFilter(targetId,targetName))) {\r
 156       logger.debug("Already using target filter " + this.targetFilter.getFilterExpression());\r
 157     } else {      \r
 158       this.targetFilter = new TargetFilter(targetId,targetName);\r
 159       setCommandParameter("search",new CommandParameter("filter","=",this.targetFilter.getFilterExpression()));      \r
 160       doSearch();\r
 161     }    \r
 162   }\r
 163 \r
 164   public TargetFilter getTargetFilter () {\r
 165     return targetFilter;\r
 166   }\r
 167     \r
 168   public void removeTargetFilter () {\r
 169     logger.debug("Removing target filter " + targetFilter.getFilterExpression());\r
 170     this.targetFilter = null;\r
 171     removeCommandParameter("search","filter");         \r
 172     doSearch();\r
 173   }\r
 174   \r
 175   public boolean hasTargetFilter() {\r
 176     return targetFilter != null;    \r
 177   }\r
 178         \r
 179   public void setSort (String sortOption) {\r
 180     logger.debug("Setting sort option: " + sortOption);\r
 181     setCommandParameter("show",new CommandParameter("sort","=",sortOption));\r
 182     update("show");\r
 183   }\r
 184   \r
 185   public String getSort () {\r
 186     return getCommandParameterValue("show","sort","relevance");\r
 187   }\r
 188     \r
 189   public void setPageSize (int perPageOption) {\r
 190     if (getPageSize()!=perPageOption) {\r
 191      logger.debug("Setting perpage option to " + perPageOption + " and resetting start page.");\r
 192      setCommandParameter("show",new CommandParameter("num","=",perPageOption));\r
 193      setCommandParameter("show",new CommandParameter("start","=",0));\r
 194      update("show");\r
 195     } else {\r
 196       logger.debug("Not updating page size, already is " + perPageOption);\r
 197     }\r
 198   }\r
 199   \r
 200   public int getPageSize () {\r
 201     return getCommandParameterValue("show","num",20);\r
 202   }\r
 203   \r
 204   public void setStart (int start) {\r
 205     logger.debug("Setting start num to " + start);\r
 206     setCommandParameter("show", new CommandParameter("start","=",start));  \r
 207     update("show");\r
 208   }\r
 209   \r
 210   public int getStart() {\r
 211     return getCommandParameterValue("show","start",0);\r
 212   }\r
 213         \r
 214   public String toggleRecord (String recId) {\r
 215     if (hasRecord(recId)) {\r
 216       removeCommand("record");  \r
 217       dataObjects.put("record", new RecordResponse());\r
 218       return "";\r
 219     } else {\r
 220       return updateRecord(recId);\r
 221     }\r
 222   }\r
 223   \r
 224   private String updateRecord(String recId) {    \r
 225     setCommandParameter("record",new CommandParameter("id","=",recId));    \r
 226     return doCommand("record");    \r
 227   }\r
 228   \r
 229   public boolean hasRecord (String recId) {\r
 230     return getCommand("record").hasParameters() && getRecord().getRecId().equals(recId);\r
 231   }\r
 232       \r
 233   public ShowResponse getShow () {\r
 234     return ((ShowResponse) dataObjects.get("show"));\r
 235   }\r
 236   \r
 237   public StatResponse getStat () {\r
 238     return ((StatResponse) dataObjects.get("stat"));\r
 239   }\r
 240   \r
 241   public RecordResponse getRecord() {\r
 242     return ((RecordResponse) dataObjects.get("record"));\r
 243   }\r
 244   \r
 245   public TermListsResponse getTermLists () {\r
 246     return ((TermListsResponse) dataObjects.get("termlist"));\r
 247   }\r
 248   \r
 249   public List<TermResponse> getFacetTerms (String facet, int count) {\r
 250     return (getTermLists().getTermList(facet).getTerms(count));\r
 251   }\r
 252     \r
 253   public List<TermResponse> getFacetTerms (String facet) {\r
 254     return (getTermLists().getTermList(facet).getTerms());\r
 255   }\r
 256   \r
 257   public ByTarget getByTarget() {\r
 258     return ((ByTarget) dataObjects.get("bytarget"));\r
 259   }\r
 260   \r
 261   \r
 262   public String getCurrentStateKey () {    \r
 263     return queryStates.getCurrentStateKey();\r
 264   }\r
 265       \r
 266   public void setCurrentStateKey(String key) {\r
 267     logger.debug("************** request to set state key to: [" + key + "]");    \r
 268     queryStates.setCurrentStateKey(key);\r
 269   }\r
 270   \r
 271   public boolean hasErrors () {\r
 272     if (dataObjects.get("search").isError()) {\r
 273       logger.info("Error detected in search");\r
 274       return true;\r
 275     }\r
 276     for (String name : dataObjects.keySet()) {\r
 277       if (dataObjects.get(name).isError()) {\r
 278         logger.info("Error detected in " + name);\r
 279         return true;\r
 280       }\r
 281     }    \r
 282     return false;\r
 283   }\r
 284     \r
 285   public String getErrorMessages() {\r
 286     StringBuilder msgs = new StringBuilder("");\r
 287     for (String name : dataObjects.keySet()) {     \r
 288       if (dataObjects.get(name).isError()) {     \r
 289         msgs.append(name + ": " + dataObjects.get(name).getErrorMessage());\r
 290       } \r
 291     }\r
 292     return msgs.toString();\r
 293   }\r
 294   \r
 295   public String getFirstErrorMessage() {\r
 296     if (dataObjects.get("search").isError()) {\r
 297       return "Error doing search: " + dataObjects.get("search").getErrorMessage();\r
 298     }\r
 299     for (String name : dataObjects.keySet()) {     \r
 300       if (dataObjects.get(name).isError()) {     \r
 301         return name + ": " + dataObjects.get(name).getErrorMessage();        \r
 302       } \r
 303     }\r
 304     return "";\r
 305     \r
 306   }\r
 307 \r
 308     \r
 309   private boolean hasTargetFilter(TargetFilter targetFilter) {\r
 310     return hasTargetFilter() && targetFilter.equals(this.targetFilter);\r
 311   }\r
 312   \r
 313   private boolean hasQuery() {\r
 314     return !(getCommand("search").getParameter("query") == null);\r
 315   }\r
 316     \r
 317   public boolean hasRecords () {\r
 318     return getStat().getRecords() > 0            \r
 319            && getShow().getHits() != null \r
 320            && getShow().getHits().size()>0;\r
 321   }\r
 322     \r
 323   public ResultsPager getPager () {\r
 324     if (pager == null) {\r
 325       pager = new ResultsPager(this);      \r
 326     } \r
 327     return pager;      \r
 328   }\r
 329   \r
 330   public ResultsPager setPager (int pageRange) {\r
 331     pager =  new ResultsPager(this,pageRange);\r
 332     return pager;\r
 333   }\r
 334   \r
 335   private void handleQueryStateChanges (String commands) {\r
 336     if (queryStates.hasPendingStateChange("search")) { \r
 337       logger.debug("Found pending search change. Doing search before updating " + commands);\r
 338       doSearch();\r
 339     } \r
 340     if (queryStates.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
 341       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
 342       queryStates.hasPendingStateChange("record",false);\r
 343       if (getCommand("record").hasParameters()) {\r
 344         updateRecord(getCommand("record").getParameter("id").getSimpleValue());\r
 345       } else {\r
 346         removeCommand("record");  \r
 347         dataObjects.put("record", new RecordResponse());\r
 348       }\r
 349     }    \r
 350   }\r
 351 \r
 352   private String getActiveClients() {    \r
 353     if (getShow()!=null) {\r
 354       logger.debug("Active clients: "+getShow().getActiveClients());\r
 355       return getShow().getActiveClients();\r
 356     } else {\r
 357       return "";\r
 358     }\r
 359   }\r
 360 \r
 361   private Pazpar2Command getCommand(String name) {\r
 362     return queryStates.getCurrentState().getCommand(name);\r
 363   }\r
 364   \r
 365   private void setCommandParameter(String commandName, CommandParameter parameter) {\r
 366     logger.debug("Setting parameter for " + commandName + ": " + parameter);\r
 367     queryStates.getCurrentState().setCommandParameter(commandName, parameter, queryStates);    \r
 368   }\r
 369   \r
 370   \r
 371   private void removeCommandParameter(String commandName, String parameterName) {\r
 372     queryStates.getCurrentState().removeCommandParameter(commandName,parameterName,queryStates);    \r
 373   }\r
 374   \r
 375   private void removeCommand (String commandName) {\r
 376     queryStates.getCurrentState().removeCommand(commandName, queryStates);\r
 377   }\r
 378     \r
 379   private String getCommandParameterValue (String commandName, String parameterName, String defaultValue) {    \r
 380     Pazpar2Command command = getCommand(commandName);\r
 381     if (command != null) {\r
 382       CommandParameter parameter = command.getParameter(parameterName);\r
 383       if (parameter != null) {\r
 384         return parameter.getValueWithExpressions();\r
 385       }\r
 386     }\r
 387     return defaultValue;    \r
 388   }\r
 389   \r
 390   private String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) {    \r
 391     Pazpar2Command command = getCommand(commandName);\r
 392     if (command != null) {\r
 393       CommandParameter parameter = command.getParameter(parameterName);\r
 394       if (parameter != null) {\r
 395         return parameter.getSimpleValue();\r
 396       }\r
 397     }\r
 398     return defaultValue;    \r
 399   }\r
 400 \r
 401   \r
 402   private int getCommandParameterValue (String commandName, String parameterName, int defaultValue) {\r
 403     Pazpar2Command command = getCommand(commandName);\r
 404     if (command != null) {\r
 405       CommandParameter parameter = command.getParameter(parameterName);\r
 406       if (parameter != null) {\r
 407         return Integer.parseInt(parameter.getSimpleValue());\r
 408       }\r
 409     }\r
 410     return defaultValue;    \r
 411   }\r
 412 \r
 413   private String doCommand(String commandName) {\r
 414     Pazpar2Command command = getCommand(commandName);    \r
 415     logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString());\r
 416     return update(commandName);\r
 417   }\r
 418   \r
 419   private void resetDataObjects() {\r
 420     logger.debug("Resetting show,stat,termlist,bytarget,search response objects.");\r
 421     dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
 422     dataObjects.put("show", new ShowResponse());\r
 423     dataObjects.put("stat", new StatResponse());\r
 424     dataObjects.put("termlist", new TermListsResponse());\r
 425     dataObjects.put("bytarget", new ByTarget());\r
 426     dataObjects.put("record", new RecordResponse());\r
 427     dataObjects.put("search", new SearchResponse());\r
 428   }\r
 429   \r
 430 \r
 431 }\r