Moves record parameter settings from pz2 bean to record cmd
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / pz2utils4jsf / pazpar2 / Pz2Session.java
index 48aa236..654f3c8 100644 (file)
@@ -6,8 +6,8 @@ import java.util.Map;
 import java.util.StringTokenizer;\r
 import java.util.concurrent.ConcurrentHashMap;\r
 \r
-import javax.enterprise.context.SessionScoped;\r
-import javax.inject.Named;\r
+import javax.annotation.PostConstruct;\r
+import javax.inject.Inject;\r
 \r
 import org.apache.log4j.Logger;\r
 \r
@@ -17,6 +17,10 @@ import com.indexdata.pz2utils4jsf.errors.ConfigurationError;
 import com.indexdata.pz2utils4jsf.errors.ConfigurationException;\r
 import com.indexdata.pz2utils4jsf.errors.ErrorHelper;\r
 import com.indexdata.pz2utils4jsf.errors.ErrorInterface;\r
+import com.indexdata.pz2utils4jsf.pazpar2.commands.CommandParameter;\r
+import com.indexdata.pz2utils4jsf.pazpar2.commands.CommandReadOnly;\r
+import com.indexdata.pz2utils4jsf.pazpar2.commands.Pazpar2Command;\r
+import com.indexdata.pz2utils4jsf.pazpar2.commands.Pazpar2Commands;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.ByTarget;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.CommandError;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.Pazpar2ResponseData;\r
@@ -27,17 +31,21 @@ import com.indexdata.pz2utils4jsf.pazpar2.data.ShowResponse;
 import com.indexdata.pz2utils4jsf.pazpar2.data.StatResponse;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.TermListsResponse;\r
 import com.indexdata.pz2utils4jsf.pazpar2.data.TermResponse;\r
+import com.indexdata.pz2utils4jsf.pazpar2.state.StateListener;\r
 import com.indexdata.pz2utils4jsf.pazpar2.state.StateManager;\r
 import com.indexdata.pz2utils4jsf.utils.Utils;\r
 \r
-@Named @SessionScoped  \r
-public class Pz2Session implements Pz2Interface {\r
+@ForStraightPz2\r
+public class Pz2Session implements Pz2Interface, StateListener {\r
     \r
   private static final long serialVersionUID = 3947514708343320514L;\r
   private static Logger logger = Logger.getLogger(Pz2Session.class);\r
   \r
   protected Map<String,Pazpar2ResponseData> dataObjects = new ConcurrentHashMap<String,Pazpar2ResponseData>();\r
-  protected StateManager stateManager = new StateManager();\r
+  \r
+  @Inject StateManager stateMgr;\r
+  @Inject Pazpar2Commands req;\r
+  \r
   protected ErrorHelper errorHelper = null;\r
   \r
   protected List<ErrorInterface> configurationErrors = null;\r
@@ -46,7 +54,14 @@ public class Pz2Session implements Pz2Interface {
   protected ResultsPager pager = null; \r
     \r
   public Pz2Session () {\r
-    logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]");      \r
+    logger.info("Instantiating pz2 session object [" + Utils.objectId(this) + "]");        \r
+  }\r
+  \r
+  @PostConstruct\r
+  public void listenToStateManager() {\r
+    logger.debug("in post-construct of Pz2Session stateMgr is " + stateMgr);\r
+    logger.debug("in post-construct req is " + req);\r
+    stateMgr.addStateListener(this);\r
   }\r
     \r
   public void configureClient(SearchClient searchClient, ConfigurationReader configReader) {\r
@@ -76,11 +91,11 @@ public class Pz2Session implements Pz2Interface {
   }\r
 \r
   public void doSearch() { \r
-    stateManager.hasPendingStateChange("search",false);\r
+    stateMgr.hasPendingStateChange("search",false);\r
     resetDataObjects();\r
     removeCommand("record");\r
     setCommandParameter("show",new CommandParameter("start","=",0));    \r
-    logger.debug(Utils.objectId(this) + " is searching using "+getCommand("search").getParameter("query").getEncodedQueryString());\r
+    logger.debug(Utils.objectId(this) + " is searching using "+req.getCommandReadOnly("search").getUrlEncodedParameterValue("query"));\r
     doCommand("search");    \r
   }\r
       \r
@@ -108,7 +123,7 @@ public class Pz2Session implements Pz2Interface {
         List<CommandThread> threadList = new ArrayList<CommandThread>();\r
         StringTokenizer tokens = new StringTokenizer(commands,",");\r
         while (tokens.hasMoreElements()) {          \r
-          threadList.add(new CommandThread(getCommand(tokens.nextToken()),searchClient));            \r
+          threadList.add(new CommandThread(req.getCommandReadOnly(tokens.nextToken()),searchClient));            \r
         }\r
         for (CommandThread thread : threadList) {\r
           thread.start();\r
@@ -144,40 +159,7 @@ public class Pz2Session implements Pz2Interface {
     }\r
     \r
   }\r
-        \r
-  public void setQuery (String query) {\r
-    logger.debug("Creating new command parameter for " + query);\r
-    setCommandParameter("search",new CommandParameter("query","=",query));\r
-  }\r
-  \r
-  public String getQuery () {\r
-    return getCommandParameterValueSimple("search","query",null);\r
-  }\r
-  \r
-  public void setFacet (String facetKey, String term) {           \r
-    if (term != null && term.length()>0) {   \r
-      Pazpar2Command command = getCommand("search");\r
-      command.getParameter("query").addExpression(new Expression(facetKey,"=",term));\r
-      stateManager.checkIn(command);\r
-      doSearch();\r
-    }            \r
-  }\r
-  \r
-  public void setFacetOnQuery (String facetKey, String term) {\r
-    String facetExpression = facetKey + "=" + term;    \r
-    if (term != null && term.length()>0) {\r
-      setCommandParameter("search",new CommandParameter("query","=", getQuery() + " and " + facetExpression));\r
-      doSearch();        \r
-    }            \r
-  }\r
-      \r
-  public void removeFacet(String facetKey, String term) {\r
-    Pazpar2Command command = getCommand("search");\r
-    command.getParameter("query").removeExpression(new Expression(facetKey,"=",term));\r
-    stateManager.checkIn(command);\r
-    doSearch();\r
-  }\r
-  \r
+            \r
   public void setSingleTargetFilter (String targetId, String targetName) {    \r
     if (hasSingleTargetFilter(new SingleTargetFilter(targetId,targetName))) {\r
       logger.debug("Already using target filter " + this.singleTargetFilter.getFilterExpression());\r
@@ -202,66 +184,21 @@ public class Pz2Session implements Pz2Interface {
   public boolean hasSingleTargetFilter() {\r
     return singleTargetFilter != null;    \r
   }\r
-        \r
-  public void setSort (String sortOption) {\r
-    logger.debug("Setting sort option: " + sortOption);\r
-    setCommandParameter("show",new CommandParameter("sort","=",sortOption));\r
-    update("show");\r
-  }\r
-  \r
-  public String getSort () {\r
-    return getCommandParameterValue("show","sort","relevance");\r
-  }\r
-    \r
-  public void setPageSize (int perPageOption) {\r
-    if (getPageSize()!=perPageOption) {\r
-     logger.debug("Setting perpage option to " + perPageOption + " and resetting start page.");\r
-     setCommandParameter("show",new CommandParameter("num","=",perPageOption));\r
-     setCommandParameter("show",new CommandParameter("start","=",0));\r
-     update("show");\r
-    } else {\r
-      logger.debug("Not updating page size, already is " + perPageOption);\r
-    }\r
-  }\r
-  \r
-  public int getPageSize () {\r
-    return getCommandParameterValue("show","num",20);\r
-  }\r
-  \r
-  public void setStart (int start) {\r
-    logger.debug("Setting start num to " + start);\r
-    setCommandParameter("show", new CommandParameter("start","=",start));  \r
-    update("show");\r
-  }\r
-  \r
-  public int getStart() {\r
-    return getCommandParameterValue("show","start",0);\r
-  }\r
-          \r
+                    \r
   public String toggleRecord (String recId) {\r
     if (hasRecord(recId)) {\r
       removeCommand("record");  \r
       dataObjects.put("record", new RecordResponse());\r
       return "";\r
     } else {\r
-      setRecordId(recId);\r
+      req.getRecord().setRecordId(recId);\r
       return doCommand("record");\r
     }\r
   }\r
   \r
   @Override\r
-  public void setRecordId(String recId) {\r
-    setCommandParameter("record",new CommandParameter("id","=",recId));\r
-  }\r
-  \r
-  @Override\r
-  public String getRecordId () {\r
-    return getCommandParameterValue("record","recid","");\r
-  }\r
-  \r
-  @Override\r
   public boolean hasRecord (String recId) {\r
-    return getCommand("record").hasParameters() && getRecord().getRecId().equals(recId);\r
+    return req.getCommandReadOnly("record").hasParameters() && getRecord().getRecId().equals(recId);\r
   }\r
       \r
   public ShowResponse getShow () {\r
@@ -294,11 +231,11 @@ public class Pz2Session implements Pz2Interface {
   \r
   \r
   public String getCurrentStateKey () {    \r
-    return stateManager.getCurrentState().getKey();\r
+    return stateMgr.getCurrentState().getKey();\r
   }\r
       \r
   public void setCurrentStateKey(String key) {       \r
-    stateManager.setCurrentStateKey(key);\r
+    stateMgr.setCurrentStateKey(key);\r
   }\r
   \r
   public boolean hasConfigurationErrors () {\r
@@ -356,8 +293,8 @@ public class Pz2Session implements Pz2Interface {
     return hasSingleTargetFilter() && targetFilter.equals(this.singleTargetFilter);\r
   }\r
   \r
-  protected boolean hasQuery() {\r
-    return getCommand("search").getParameter("query") != null && getCommand("search").getParameter("query").getValueWithExpressions().length()>0;\r
+  protected boolean hasQuery() {    \r
+    return req.getSearch().getParameter("query") != null && req.getSearch().getParameter("query").getValueWithExpressions().length()>0;\r
   }\r
     \r
   public boolean hasRecords () {\r
@@ -374,7 +311,7 @@ public class Pz2Session implements Pz2Interface {
   }\r
   \r
   public ResultsPager setPager (int pageRange) {\r
-    pager =  new ResultsPager(this,pageRange);\r
+    pager =  new ResultsPager(this,pageRange,req);\r
     return pager;\r
   }\r
   \r
@@ -383,20 +320,20 @@ public class Pz2Session implements Pz2Interface {
   }\r
   \r
   protected void handleQueryStateChanges (String commands) {\r
-    if (stateManager.hasPendingStateChange("search") && hasQuery()) { \r
+    if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
       logger.debug("Found pending search change. Doing search before updating " + commands);      \r
       doSearch();\r
     } \r
-    if (stateManager.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
+    if (stateMgr.hasPendingStateChange("record") && ! commands.equals("record")) {        \r
       logger.debug("Found pending record ID change. Doing record before updating " + commands);\r
-      stateManager.hasPendingStateChange("record",false);\r
-      if (getCommand("record").hasParameters()) {\r
+      stateMgr.hasPendingStateChange("record",false);\r
+      if (req.getCommandReadOnly("record").hasParameters()) {\r
         update("record");\r
       } else {\r
         removeCommand("record");  \r
         dataObjects.put("record", new RecordResponse());\r
       }\r
-    }    \r
+    }\r
   }\r
 \r
   protected String getActiveClients() {    \r
@@ -423,66 +360,69 @@ public class Pz2Session implements Pz2Interface {
    * @return\r
    */\r
   protected Pazpar2Command getCommand(String name) {\r
-    return stateManager.checkOut(name);\r
+    return req.getCommand(name);\r
   }\r
   \r
+  /** \r
+   * Returns an interface to a Pazpar2Command with only String getters.\r
+   * \r
+   * Since the command cannot be modified (unless it is cast) we can avoid \r
+   * cloning it before returning it from the current state. \r
+   * It can be used for log statements, checks and for performing the \r
+   * actual pazpar2 request. \r
+   * \r
+   * @param name\r
+   * @return\r
+   */\r
+  protected CommandReadOnly getCommandReadOnly(String name) {\r
+    return req.getCommandReadOnly(name);\r
+  }\r
+\r
+  \r
   protected void setCommandParameter(String commandName, CommandParameter parameter) {\r
     logger.debug("Setting parameter for " + commandName + ": " + parameter);\r
-    Pazpar2Command command = getCommand(commandName);\r
+    Pazpar2Command command = req.getCommand(commandName);\r
     command.setParameter(parameter);\r
-    stateManager.checkIn(command);    \r
+    stateMgr.checkIn(command);    \r
   }\r
   \r
   \r
   protected void removeCommandParameter(String commandName, String parameterName) {\r
-    Pazpar2Command command = getCommand(commandName);\r
+    Pazpar2Command command = req.getCommand(commandName);\r
     command.removeParameter(parameterName);\r
-    stateManager.checkIn(command);    \r
+    stateMgr.checkIn(command);    \r
   }\r
   \r
   protected void removeCommand (String commandName) {\r
-    Pazpar2Command command = getCommand(commandName);\r
+    Pazpar2Command command = req.getCommand(commandName);\r
     command.removeParameters();\r
-    stateManager.checkIn(command);\r
+    stateMgr.checkIn(command);\r
   }\r
     \r
   protected String getCommandParameterValue (String commandName, String parameterName, String defaultValue) {    \r
-    Pazpar2Command command = getCommand(commandName);\r
+    CommandReadOnly command = req.getCommandReadOnly(commandName);\r
     if (command != null) {\r
-      CommandParameter parameter = command.getParameter(parameterName);\r
+      String parameter = command.getParameterValue(parameterName);\r
       if (parameter != null) {\r
-        return parameter.getValueWithExpressions();\r
+        return parameter;\r
       }\r
     }\r
     return defaultValue;    \r
   }\r
-  \r
-  protected String getCommandParameterValueSimple (String commandName, String parameterName, String defaultValue) {    \r
-    Pazpar2Command command = getCommand(commandName);\r
-    if (command != null) {\r
-      CommandParameter parameter = command.getParameter(parameterName);\r
-      if (parameter != null) {\r
-        return parameter.getSimpleValue();\r
-      }\r
-    }\r
-    return defaultValue;    \r
-  }\r
-\r
-  \r
+    \r
   protected int getCommandParameterValue (String commandName, String parameterName, int defaultValue) {\r
-    Pazpar2Command command = getCommand(commandName);\r
+    CommandReadOnly command = req.getCommandReadOnly(commandName);\r
     if (command != null) {\r
-      CommandParameter parameter = command.getParameter(parameterName);\r
+      String parameter = command.getParameterValue(parameterName);\r
       if (parameter != null) {\r
-        return Integer.parseInt(parameter.getSimpleValue());\r
+        return Integer.parseInt(parameter);\r
       }\r
     }\r
     return defaultValue;    \r
   }\r
 \r
-  protected String doCommand(String commandName) {     \r
-    Pazpar2Command command = getCommand(commandName);    \r
-    logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString());\r
+  protected String doCommand(String commandName) {             \r
+    logger.debug(req.getCommandReadOnly(commandName).getEncodedQueryString() + ": Results for "+ req.getCommandReadOnly("search").getEncodedQueryString());\r
     return update(commandName);\r
   }\r
   \r
@@ -504,11 +444,20 @@ public class Pz2Session implements Pz2Interface {
   }\r
   \r
   public String getFilter() {\r
-    return getCommandParameterValueSimple("search", "filter", "");\r
+    return getCommandParameterValue("search", "filter", "");\r
   }\r
   \r
   public boolean hasFilter () {\r
     return getFilter().length()>0;\r
   }\r
+\r
+  @Override\r
+  public void stateUpdated(String commandName) {\r
+    logger.debug("State change reported for [" + commandName + "]");\r
+    if (commandName.equals("show")) {\r
+      logger.debug("Updating show");\r
+      update(commandName);\r
+    } \r
+  }\r
   \r
 }\r