More work on commands, statemgmt, EL references
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / pz2utils4jsf / pazpar2 / Pz2Session.java
index a4b1b68..cdb1a6b 100644 (file)
@@ -6,8 +6,9 @@ import java.util.Map;
 import java.util.StringTokenizer;\r
 import java.util.concurrent.ConcurrentHashMap;\r
 \r
+import javax.annotation.PostConstruct;\r
 import javax.enterprise.context.SessionScoped;\r
-import javax.inject.Named;\r
+import javax.inject.Inject;\r
 \r
 import org.apache.log4j.Logger;\r
 \r
@@ -17,6 +18,9 @@ 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.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,26 +31,37 @@ 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.QueryStates;\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 QueryStates queryStates = new QueryStates();\r
+  \r
+  @Inject StateManager stateMgr;\r
+  @Inject Pazpar2Commands req;\r
+  \r
   protected ErrorHelper errorHelper = null;\r
   \r
   protected List<ErrorInterface> configurationErrors = null;\r
   protected SearchClient searchClient = null;   \r
-  protected TargetFilter targetFilter = null;  \r
+  protected SingleTargetFilter singleTargetFilter = null;  \r
   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,8 +91,9 @@ public class Pz2Session implements Pz2Interface {
   }\r
 \r
   public void doSearch() { \r
-    queryStates.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
     doCommand("search");    \r
@@ -106,7 +122,7 @@ public class Pz2Session implements Pz2Interface {
         logger.debug("Processing request for " + commands); \r
         List<CommandThread> threadList = new ArrayList<CommandThread>();\r
         StringTokenizer tokens = new StringTokenizer(commands,",");\r
-        while (tokens.hasMoreElements()) {\r
+        while (tokens.hasMoreElements()) {          \r
           threadList.add(new CommandThread(getCommand(tokens.nextToken()),searchClient));            \r
         }\r
         for (CommandThread thread : threadList) {\r
@@ -154,8 +170,10 @@ public class Pz2Session implements Pz2Interface {
   }\r
   \r
   public void setFacet (String facetKey, String term) {           \r
-    if (term != null && term.length()>0) {\r
-      queryStates.getCurrentState().setCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
+    if (term != null && term.length()>0) {   \r
+      Pazpar2Command command = getCommand("search");\r
+      command.getParameter("query").addExpression(new Expression(facetKey,"=",term));\r
+      stateMgr.checkIn(command);\r
       doSearch();\r
     }            \r
   }\r
@@ -169,33 +187,35 @@ public class Pz2Session implements Pz2Interface {
   }\r
       \r
   public void removeFacet(String facetKey, String term) {\r
-    queryStates.getCurrentState().removeCommandParameterExpression("search","query",new Expression(facetKey,"=",term),queryStates);\r
+    Pazpar2Command command = getCommand("search");\r
+    command.getParameter("query").removeExpression(new Expression(facetKey,"=",term));\r
+    stateMgr.checkIn(command);\r
     doSearch();\r
   }\r
   \r
-  public void setTargetFilter (String targetId, String targetName) {    \r
-    if (hasTargetFilter(new TargetFilter(targetId,targetName))) {\r
-      logger.debug("Already using target filter " + this.targetFilter.getFilterExpression());\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
     } else {      \r
-      this.targetFilter = new TargetFilter(targetId,targetName);\r
-      setCommandParameter("search",new CommandParameter("filter","=",this.targetFilter.getFilterExpression()));      \r
+      this.singleTargetFilter = new SingleTargetFilter(targetId,targetName);\r
+      setCommandParameter("search",new CommandParameter("filter","=",this.singleTargetFilter.getFilterExpression()));      \r
       doSearch();\r
     }    \r
   }\r
 \r
-  public TargetFilter getTargetFilter () {\r
-    return targetFilter;\r
+  public SingleTargetFilter getSingleTargetFilter () {\r
+    return singleTargetFilter;\r
   }\r
     \r
-  public void removeTargetFilter () {\r
-    logger.debug("Removing target filter " + targetFilter.getFilterExpression());\r
-    this.targetFilter = null;\r
+  public void removeSingleTargetFilter () {\r
+    logger.debug("Removing target filter " + singleTargetFilter.getFilterExpression());\r
+    this.singleTargetFilter = null;\r
     removeCommandParameter("search","filter");         \r
     doSearch();\r
   }\r
   \r
-  public boolean hasTargetFilter() {\r
-    return targetFilter != null;    \r
+  public boolean hasSingleTargetFilter() {\r
+    return singleTargetFilter != null;    \r
   }\r
         \r
   public void setSort (String sortOption) {\r
@@ -289,11 +309,11 @@ public class Pz2Session implements Pz2Interface {
   \r
   \r
   public String getCurrentStateKey () {    \r
-    return queryStates.getCurrentStateKey();\r
+    return stateMgr.getCurrentState().getKey();\r
   }\r
       \r
   public void setCurrentStateKey(String key) {       \r
-    queryStates.setCurrentStateKey(key);\r
+    stateMgr.setCurrentStateKey(key);\r
   }\r
   \r
   public boolean hasConfigurationErrors () {\r
@@ -347,12 +367,13 @@ public class Pz2Session implements Pz2Interface {
   }\r
 \r
     \r
-  protected boolean hasTargetFilter(TargetFilter targetFilter) {\r
-    return hasTargetFilter() && targetFilter.equals(this.targetFilter);\r
+  protected boolean hasSingleTargetFilter(SingleTargetFilter targetFilter) {\r
+    return hasSingleTargetFilter() && targetFilter.equals(this.singleTargetFilter);\r
   }\r
   \r
   protected boolean hasQuery() {\r
-    return !(getCommand("search").getParameter("query") == null);\r
+    logger.debug("req is " + req);\r
+    return req.getSearch().getParameter("query") != null && req.getSearch().getParameter("query").getValueWithExpressions().length()>0;\r
   }\r
     \r
   public boolean hasRecords () {\r
@@ -378,20 +399,20 @@ public class Pz2Session implements Pz2Interface {
   }\r
   \r
   protected void handleQueryStateChanges (String commands) {\r
-    if (queryStates.hasPendingStateChange("search")) { \r
-      logger.debug("Found pending search change. Doing search before updating " + commands);\r
+    if (stateMgr.hasPendingStateChange("search") && hasQuery()) { \r
+      logger.debug("Found pending search change. Doing search before updating " + commands);      \r
       doSearch();\r
     } \r
-    if (queryStates.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
-      queryStates.hasPendingStateChange("record",false);\r
+      stateMgr.hasPendingStateChange("record",false);\r
       if (getCommand("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
@@ -403,22 +424,42 @@ public class Pz2Session implements Pz2Interface {
     }\r
   }\r
 \r
+  /**\r
+   * Returns a Pazpar2 command 'detached' from the current Pazpar2 state.\r
+   * \r
+   * 'Detached' is meant to imply that this is a copy of a command in the \r
+   * current state, detached so as to NOT change the current state if \r
+   * modified. It can be viewed and executed, however. \r
+   * \r
+   * In order to modify the command with effect for subsequent searches,\r
+   * it must be checked back into the StateManager, which will\r
+   * then create a new current Pazpar2 state as needed.\r
+   *  \r
+   * @param name\r
+   * @return\r
+   */\r
   protected Pazpar2Command getCommand(String name) {\r
-    return queryStates.getCurrentState().getCommand(name);\r
+    return stateMgr.checkOut(name);\r
   }\r
   \r
   protected void setCommandParameter(String commandName, CommandParameter parameter) {\r
     logger.debug("Setting parameter for " + commandName + ": " + parameter);\r
-    queryStates.getCurrentState().setCommandParameter(commandName, parameter, queryStates);    \r
+    Pazpar2Command command = getCommand(commandName);\r
+    command.setParameter(parameter);\r
+    stateMgr.checkIn(command);    \r
   }\r
   \r
   \r
   protected void removeCommandParameter(String commandName, String parameterName) {\r
-    queryStates.getCurrentState().removeCommandParameter(commandName,parameterName,queryStates);    \r
+    Pazpar2Command command = getCommand(commandName);\r
+    command.removeParameter(parameterName);\r
+    stateMgr.checkIn(command);    \r
   }\r
   \r
   protected void removeCommand (String commandName) {\r
-    queryStates.getCurrentState().removeCommand(commandName, queryStates);\r
+    Pazpar2Command command = getCommand(commandName);\r
+    command.removeParameters();\r
+    stateMgr.checkIn(command);\r
   }\r
     \r
   protected String getCommandParameterValue (String commandName, String parameterName, String defaultValue) {    \r
@@ -456,7 +497,7 @@ public class Pz2Session implements Pz2Interface {
   }\r
 \r
   protected String doCommand(String commandName) {     \r
-    Pazpar2Command command = getCommand(commandName);    \r
+    Pazpar2Command command = req.getCommand(commandName);    \r
     logger.debug(command.getEncodedQueryString() + ": Results for "+ getCommand("search").getEncodedQueryString());\r
     return update(commandName);\r
   }\r
@@ -472,4 +513,27 @@ public class Pz2Session implements Pz2Interface {
     dataObjects.put("search", new SearchResponse());\r
   }\r
   \r
+  @Override\r
+  public void setFilter(String filterExpression) {\r
+    logger.debug("Setting filter to " + filterExpression);\r
+    setCommandParameter("search",new CommandParameter("filter","=",filterExpression));    \r
+  }\r
+  \r
+  public String getFilter() {\r
+    return getCommandParameterValueSimple("search", "filter", "");\r
+  }\r
+  \r
+  public boolean hasFilter () {\r
+    return getFilter().length()>0;\r
+  }\r
+\r
+  @Override\r
+  public void stateUpdate(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