1 package com.indexdata.mkjsf.pazpar2.commands;
\r
3 import javax.enterprise.context.SessionScoped;
\r
5 import org.apache.log4j.Logger;
\r
7 import com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommand;
\r
8 import com.indexdata.mkjsf.pazpar2.state.StateManager;
\r
11 public class SearchCommand extends Pazpar2Command implements ServiceProxyCommand {
\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
17 public SearchCommand(StateManager stateMgr) {
\r
18 super("search",stateMgr);
\r
21 public void setQuery(String query) {
\r
22 setParameter(new CommandParameter("query","=",query));
\r
25 public String getQuery () {
\r
26 return getParameter("query") == null ? null : getParameter("query").getValueWithExpressions();
\r
29 public void setFilter(String filterExpression) {
\r
30 setParameter(new CommandParameter("filter","=",filterExpression));
\r
33 public String getFilter() {
\r
34 return getParameter("filter") == null ? null : getParameter("filter").getValueWithExpressions();
\r
37 public void addFilter(String filterExpression) {
\r
39 if (hasParameterValue("filter")) {
\r
40 setFilter(filterExpression);
\r
42 getParameter("filter");
\r
44 throw new UnsupportedOperationException("removeFilter(filterExpression) yet to be implemented.");
\r
47 public void removeFilters () {
\r
48 removeParameter("filter");
\r
51 public void removeFilter(String filterExpression) {
\r
53 throw new UnsupportedOperationException("removeFilter(filterExpression) yet to be implemented.");
\r
56 public boolean hasFilter () {
\r
57 return getFilter().length()>0;
\r
60 public void setLimit (String limitExpression) {
\r
61 setParameter(new CommandParameter("limit","=",limitExpression));
\r
64 public String getLimit () {
\r
65 return getParameterValue("limit");
\r
68 public void setStartrecs (String startrecs) {
\r
69 setParameter(new CommandParameter("startrecs","=",startrecs));
\r
72 public String getStartrecs () {
\r
73 return getParameterValue("startrecs");
\r
76 public void setMaxrecs (String maxrecs) {
\r
77 setParameter(new CommandParameter("maxrecs","=",maxrecs));
\r
80 public String getMaxrecs () {
\r
81 return getParameterValue("maxrecs");
\r
84 public void setSort () {
\r
85 setParameter(new CommandParameter("sort","=","sort"));
\r
88 public String getSort () {
\r
89 return getParameterValue("sort");
\r
93 * Sets a facet, in CQL, to restrict the current results,
\r
94 * then executes the search
\r
96 * @param facetKey i.e. 'au' for author
\r
97 * @param term i.e. 'Dickens, Charles'
\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
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
112 * @param facetKey i.e. 'au' for author
\r
113 * @param term i.e. 'Dickens, Charles'
\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
124 * Removes a facet set by setFacet(...), then executes
\r
127 * Will not remove facets set by setFacetOnQuery(...)
\r
129 * @param facetKey i.e. 'au' for author
\r
130 * @param term i.e. 'Dickens, Charles'
\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
140 * Adds a single target filter to restrict the current query by,
\r
141 * then executes the current search.
\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
147 * @param targetId pazpar2's ID for the target to limit by
\r
148 * @param targetName a descriptive name for the target
\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
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
160 public SingleTargetFilter getSingleTargetFilter () {
\r
161 logger.debug("request to get the current single target filter " + singleTargetFilter);
\r
162 return singleTargetFilter;
\r
166 * Removes the current target filter from the search
\r
169 public String removeSingleTargetFilter () {
\r
170 logger.debug("Removing target filter " + singleTargetFilter.getFilterExpression());
\r
171 this.singleTargetFilter = null;
\r
172 removeParameter("filter");
\r
178 * @return The target filter set on the current search command
\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
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
189 * @return true if the current search command is limited by a target
\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
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
202 newCommand.singleTargetFilter = this.singleTargetFilter;
\r
207 public ServiceProxyCommand getSp() {
\r
212 public boolean spOnly() {
\r