src/main/java/com/indexdata/mkjsf/pazpar2/commands/SearchCommand.java

   1 package com.indexdata.mkjsf.pazpar2.commands;\r
   2 \r
   3 import javax.enterprise.context.SessionScoped;\r
   4 \r
   5 import org.apache.log4j.Logger;\r
   6 \r
   7 import com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommand;\r
   8 import com.indexdata.mkjsf.pazpar2.state.StateManager;\r
   9 \r
  10 @SessionScoped\r
  11 public class SearchCommand extends Pazpar2Command implements ServiceProxyCommand {\r
  12   \r
  13   private static final long serialVersionUID = -1888520867838597236L;\r
  14   private static Logger logger = Logger.getLogger(SearchCommand.class);\r
  15   private SingleTargetFilter singleTargetFilter = null;\r
  16   \r
  17   public SearchCommand(StateManager stateMgr) {\r
  18     super("search",stateMgr);\r
  19   }\r
  20     \r
  21   public void setQuery(String query) {    \r
  22     setParameter(new CommandParameter("query","=",query));\r
  23   }\r
  24   \r
  25   public String getQuery () {    \r
  26     return getParameter("query") == null ? null  : getParameter("query").getValueWithExpressions();\r
  27   }\r
  28   \r
  29   public void setFilter(String filterExpression) {\r
  30     setParameter(new CommandParameter("filter","=",filterExpression));\r
  31   }\r
  32   \r
  33   public String getFilter() {\r
  34     return getParameter("filter") == null ? null : getParameter("filter").getValueWithExpressions();\r
  35   }\r
  36   \r
  37   public void addFilter(String filterExpression) {\r
  38     // TODO: implement\r
  39     if (hasParameterValue("filter")) {\r
  40       setFilter(filterExpression);\r
  41     } else {\r
  42       getParameter("filter");\r
  43     }\r
  44     throw new UnsupportedOperationException("removeFilter(filterExpression) yet to be implemented.");\r
  45   }\r
  46   \r
  47   public void removeFilters () {\r
  48     removeParameter("filter");\r
  49   }\r
  50   \r
  51   public void removeFilter(String filterExpression) {\r
  52     // TODO: implement\r
  53     throw new UnsupportedOperationException("removeFilter(filterExpression) yet to be implemented.");\r
  54   }\r
  55 \r
  56   public boolean hasFilter () {\r
  57     return getFilter().length()>0;\r
  58   }\r
  59   \r
  60   public void setLimit (String limitExpression) {\r
  61     setParameter(new CommandParameter("limit","=",limitExpression));\r
  62   }\r
  63   \r
  64   public String getLimit () {\r
  65     return getParameterValue("limit");\r
  66   }\r
  67       \r
  68   public void setStartrecs (String startrecs) {\r
  69     setParameter(new CommandParameter("startrecs","=",startrecs));\r
  70   }\r
  71   \r
  72   public String getStartrecs () {\r
  73     return getParameterValue("startrecs");\r
  74   }\r
  75   \r
  76   public void setMaxrecs (String maxrecs) {\r
  77     setParameter(new CommandParameter("maxrecs","=",maxrecs));\r
  78   }\r
  79   \r
  80   public String getMaxrecs () {\r
  81     return getParameterValue("maxrecs");\r
  82   }\r
  83   \r
  84   public void setSort () {\r
  85     setParameter(new CommandParameter("sort","=","sort"));\r
  86   }\r
  87   \r
  88   public String getSort () {\r
  89     return getParameterValue("sort");\r
  90   }\r
  91   \r
  92   /**\r
  93    * Sets a facet, in CQL, to restrict the current results,\r
  94    * then executes the search \r
  95    * \r
  96    * @param facetKey  i.e.  'au' for author\r
  97    * @param term  i.e. 'Dickens, Charles'\r
  98    */\r
  99   public void setFacet(String facetKey, String term) {\r
 100     if (term != null && term.length()>0) {         \r
 101       getParameter("query").addExpression(new Expression(facetKey,"=",term));            \r
 102     }            \r
 103   }\r
 104   \r
 105   /**\r
 106    * Sets a facet to limit the current query by. The \r
 107    * facet is appended to the query string itself (rather\r
 108    * as a separately managed entity. It will thus appear\r
 109    * in a query field as retrieved by getQuery(). It will\r
 110    * not be removed by removeFacet(...)\r
 111    * \r
 112    * @param facetKey  i.e. 'au' for author\r
 113    * @param term i.e. 'Dickens, Charles'\r
 114    */\r
 115   public void setFacetOnQuery (String facetKey, String term) {\r
 116     String facetExpression = facetKey + "=" + term;    \r
 117     if (term != null && term.length()>0) {\r
 118       String currentQuery= getParameterValue("query");\r
 119       setParameter(new CommandParameter("query","=", currentQuery + " and " + facetExpression));      \r
 120     }            \r
 121   }\r
 122       \r
 123   /**\r
 124    * Removes a facet set by setFacet(...), then executes\r
 125    * the search.\r
 126    * \r
 127    * Will not remove facets set by setFacetOnQuery(...)\r
 128    *  \r
 129    * @param facetKey i.e. 'au' for author\r
 130    * @param term i.e. 'Dickens, Charles'\r
 131    */\r
 132   public void removeFacet(String facetKey, String term) {\r
 133     if (getParameter("query") != null) {\r
 134       getParameter("query").removeExpression(new Expression(facetKey,"=",term));\r
 135     }\r
 136   }\r
 137   \r
 138   \r
 139   /**\r
 140    * Adds a single target filter to restrict the current query by, \r
 141    * then executes the current search.\r
 142    * \r
 143    * This is a special case of the general setFilter function, \r
 144    * allowing to associate a descriptive target name with the \r
 145    * filter expression for display in UI. \r
 146    * \r
 147    * @param targetId pazpar2's ID for the target to limit by\r
 148    * @param targetName a descriptive name for the target\r
 149    */\r
 150   public void setSingleTargetFilter (String targetId, String targetName) {    \r
 151     if (hasSingleTargetFilter(new SingleTargetFilter(targetId,targetName))) {\r
 152       logger.debug("Already using target filter " + this.singleTargetFilter.getFilterExpression());\r
 153     } else {      \r
 154       logger.debug("Setting new single target filter for [" + targetName + "]");\r
 155       this.singleTargetFilter = new SingleTargetFilter(targetId,targetName);\r
 156       setParameter(new CommandParameter("filter","=",this.singleTargetFilter.getFilterExpression()));            \r
 157     }    \r
 158   }\r
 159 \r
 160   public SingleTargetFilter getSingleTargetFilter () {\r
 161     logger.debug("request to get the current single target filter " + singleTargetFilter);\r
 162     return singleTargetFilter;\r
 163   }\r
 164    \r
 165   /**\r
 166    * Removes the current target filter from the search\r
 167    * \r
 168    */\r
 169   public String removeSingleTargetFilter () {\r
 170     logger.debug("Removing target filter " + singleTargetFilter.getFilterExpression());\r
 171     this.singleTargetFilter = null;\r
 172     removeParameter("filter");\r
 173     return null;\r
 174   }\r
 175   \r
 176   /**\r
 177    * \r
 178    * @return The target filter set on the current search command\r
 179    */\r
 180   public boolean hasSingleTargetFilter() {\r
 181     logger.debug("Checking if a single target filter is set: " + (singleTargetFilter != null));\r
 182     return singleTargetFilter != null;    \r
 183   }\r
 184   \r
 185   /**\r
 186    * Resolves if the current search command has a target filter - to\r
 187    * be used by the UI for conditional rendering of target filter info.\r
 188    * \r
 189    * @return true if the current search command is limited by a target \r
 190    * filter\r
 191    */\r
 192   protected boolean hasSingleTargetFilter(SingleTargetFilter targetFilter) {\r
 193     logger.debug("Checking if target filter for [" + targetFilter.getTargetName() + "] is set.");\r
 194     return hasSingleTargetFilter() && targetFilter.equals(this.singleTargetFilter);\r
 195   }\r
 196     \r
 197   public SearchCommand copy () {\r
 198     SearchCommand newCommand = new SearchCommand(stateMgr);\r
 199     for (String parameterName : parameters.keySet()) {\r
 200       newCommand.setParameterInState(parameters.get(parameterName).copy());      \r
 201     }\r
 202     newCommand.singleTargetFilter = this.singleTargetFilter;\r
 203     return newCommand;\r
 204   }\r
 205 \r
 206   @Override\r
 207   public ServiceProxyCommand getSp() {\r
 208     return this;\r
 209   }\r
 210 \r
 211   @Override\r
 212   public boolean spOnly() {\r
 213     return false;\r
 214   }\r
 215 \r
 216 }\r