1 package com.indexdata.pz2utils4jsf.pazpar2.commands;
\r
3 import javax.enterprise.context.SessionScoped;
\r
5 import org.apache.log4j.Logger;
\r
7 import com.indexdata.pz2utils4jsf.pazpar2.state.StateManager;
\r
10 public class SearchCommand extends Pazpar2Command {
\r
12 private static final long serialVersionUID = -1888520867838597236L;
\r
13 private static Logger logger = Logger.getLogger(SearchCommand.class);
\r
14 private SingleTargetFilter singleTargetFilter = null;
\r
16 public SearchCommand(StateManager stateMgr) {
\r
17 super("search",stateMgr);
\r
20 public void setSession (String sessionId) {
\r
21 setParameter(new CommandParameter("session","=",sessionId));
\r
24 public void setQuery(String query) {
\r
25 setParameter(new CommandParameter("query","=",query));
\r
28 public String getQuery () {
\r
29 return getParameter("query") == null ? null : getParameter("query").getValueWithExpressions();
\r
33 * Sets a facet, in CQL, to restrict the current results,
\r
34 * then executes the search
\r
36 * @param facetKey i.e. 'au' for author
\r
37 * @param term i.e. 'Dickens, Charles'
\r
39 public void setFacet(String facetKey, String term) {
\r
40 if (term != null && term.length()>0) {
\r
41 getParameter("query").addExpression(new Expression(facetKey,"=",term));
\r
46 * Sets a facet to limit the current query by. The
\r
47 * facet is appended to the query string itself (rather
\r
48 * as a separately managed entity. It will thus appear
\r
49 * in a query field as retrieved by getQuery(). It will
\r
50 * not be removed by removeFacet(...)
\r
52 * @param facetKey i.e. 'au' for author
\r
53 * @param term i.e. 'Dickens, Charles'
\r
55 public void setFacetOnQuery (String facetKey, String term) {
\r
56 String facetExpression = facetKey + "=" + term;
\r
57 if (term != null && term.length()>0) {
\r
58 String currentQuery= getParameterValue("query");
\r
59 setParameter(new CommandParameter("query","=", currentQuery + " and " + facetExpression));
\r
64 * Removes a facet set by setFacet(...), then executes
\r
67 * Will not remove facets set by setFacetOnQuery(...)
\r
69 * @param facetKey i.e. 'au' for author
\r
70 * @param term i.e. 'Dickens, Charles'
\r
72 public void removeFacet(String facetKey, String term) {
\r
73 if (getParameter("query") != null) {
\r
74 getParameter("query").removeExpression(new Expression(facetKey,"=",term));
\r
78 public void setFilter(String filterExpression) {
\r
79 setParameter(new CommandParameter("filter","=",filterExpression));
\r
82 public String getFilter() {
\r
83 return getParameter("filter") == null ? null : getParameter("filter").getValueWithExpressions();
\r
86 public boolean hasFilter () {
\r
87 return getFilter().length()>0;
\r
91 * Adds a single target filter to restrict the current query by,
\r
92 * then executes the current search.
\r
94 * This is a special case of the general setFilter function,
\r
95 * allowing to associate a descriptive target name with the
\r
96 * filter expression for display in UI.
\r
98 * @param targetId pazpar2's ID for the target to limit by
\r
99 * @param targetName a descriptive name for the target
\r
101 public void setSingleTargetFilter (String targetId, String targetName) {
\r
102 if (hasSingleTargetFilter(new SingleTargetFilter(targetId,targetName))) {
\r
103 logger.debug("Already using target filter " + this.singleTargetFilter.getFilterExpression());
\r
105 this.singleTargetFilter = new SingleTargetFilter(targetId,targetName);
\r
106 setParameter(new CommandParameter("filter","=",this.singleTargetFilter.getFilterExpression()));
\r
110 public SingleTargetFilter getSingleTargetFilter () {
\r
111 logger.debug("request to get the current single target filter");
\r
112 return singleTargetFilter;
\r
116 * Removes the current target filter from the search
\r
119 public void removeSingleTargetFilter () {
\r
120 logger.debug("Removing target filter " + singleTargetFilter.getFilterExpression());
\r
121 this.singleTargetFilter = null;
\r
122 removeParameter("filter");
\r
127 * @return The target filter set on the current search command
\r
129 public boolean hasSingleTargetFilter() {
\r
130 logger.debug("Checking if a single target filter is set: " + (singleTargetFilter != null));
\r
131 return singleTargetFilter != null;
\r
135 * Resolves if the current search command has a target filter - to
\r
136 * be used by the UI for conditional rendering of target filter info.
\r
138 * @return true if the current search command is limited by a target
\r
141 protected boolean hasSingleTargetFilter(SingleTargetFilter targetFilter) {
\r
142 return hasSingleTargetFilter() && targetFilter.equals(this.singleTargetFilter);
\r
146 public void setLimit (String limit) {
\r
150 public void addFilter(String filterExpression) {
\r
151 if (hasParameterSet("filter")) {
\r
152 setFilter(filterExpression);
\r
155 getParameter("filter");
\r
159 public void removeFilters () {
\r
163 public void removeFilter(String filterExpression) {
\r
167 public SearchCommand copy () {
\r
168 SearchCommand newCommand = new SearchCommand(stateMgr);
\r
169 for (String parameterName : parameters.keySet()) {
\r
170 newCommand.setParameterSilently(parameters.get(parameterName).copy());
\r
172 newCommand.singleTargetFilter = this.singleTargetFilter;
\r