1 package com.indexdata.mkjsf.pazpar2.commands;
\r
3 import java.util.Arrays;
\r
4 import java.util.List;
\r
6 import javax.enterprise.context.SessionScoped;
\r
7 import javax.inject.Named;
\r
9 import org.apache.log4j.Logger;
\r
11 import com.indexdata.mkjsf.pazpar2.Pz2Service;
\r
12 import com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommand;
\r
13 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;
\r
15 @SessionScoped @Named
\r
16 public class SearchCommand extends Pazpar2Command implements ServiceProxyCommand {
\r
18 private static final long serialVersionUID = -1888520867838597236L;
\r
19 private static Logger logger = Logger.getLogger(SearchCommand.class);
\r
21 public SearchCommand() {
\r
25 public ResponseDataObject run() {
\r
26 logger.info("Running " + getCommandName());
\r
27 Pz2Service.get().getStateMgr().hasPendingStateChange("search",false);
\r
28 Pz2Service.get().getPzresp().resetSearchAndBeyond();
\r
29 Pz2Service.get().getPzreq().getRecord().removeParametersInState();
\r
30 Pz2Service.get().getPzreq().getShow().setParameterInState(new CommandParameter("start","=",0));
\r
31 Pz2Service.get().getSearchClient().setSearchCommand(this);
\r
35 public void setQuery(String query) {
\r
36 setParameter(new CommandParameter("query","=",query));
\r
39 public String getQuery () {
\r
40 return getParameter("query") == null ? null : getParameter("query").getValueWithExpressions();
\r
43 public void setFilter(String filterExpression) {
\r
44 if (filterExpression != null && filterExpression.length()>0) {
\r
45 setParameter(new FilterParameter(new Expression(filterExpression)));
\r
49 public void setFilter(String field, String operator, String value, String label) {
\r
50 setParameter(new FilterParameter(new Expression(field,operator,value,label)));
\r
53 public boolean hasFilterExpression(String... expressionFields) {
\r
54 logger.trace("Checking for filter expression for " + Arrays.deepToString(expressionFields));
\r
55 for (String field : expressionFields) {
\r
56 if (getFilterExpressions(field) != null && getFilterExpressions(field).size()>0) {
\r
57 logger.trace("Filter expression found (" + field + ")");
\r
61 logger.trace("No filter expressions found");
\r
66 public String getFilter() {
\r
67 return getParameter("filter") == null ? null : ((FilterParameter)getParameter("filter")).getValueWithExpressions();
\r
70 public Expression getOneFilterExpression(String expressionField) {
\r
71 List<Expression> exprs = getFilterExpressions(expressionField);
\r
72 if (exprs != null && exprs.size()>0) {
\r
73 if (exprs.size()>1) {
\r
74 logger.warn("More that one filter expression found for [" + expressionField + "] but only asked to return the first one");
\r
76 return exprs.get(0);
\r
83 public List<Expression> getFilterExpressions() {
\r
84 return getParameter("filter").getExpressions();
\r
87 public List<Expression> getFilterExpressions(String... expressionFields) {
\r
88 logger.trace("Checking for filter parameter");
\r
89 if (parameters.get("filter")!=null) {
\r
90 logger.trace("Found");
\r
91 return getParameter("filter").getExpressions(expressionFields);
\r
93 logger.trace("Not found");
\r
98 public boolean hasFilter () {
\r
99 return getFilter().length()>0;
\r
102 public void addFilter(String field, String operator, String value, String label) {
\r
103 if (getParameter("filter") == null) {
\r
104 setFilter(field + operator + value);
\r
106 getParameter("filter").addExpression(new Expression(field,operator,value,(label != null ? label : value)));
\r
110 public void removeFilters () {
\r
111 removeParameter("filter");
\r
114 public void removeFilter(String field, String operator, String value) {
\r
115 removeExpression("filter",new Expression(field, operator, value, null));
\r
118 public void removeFilters(String... fieldsToRemove) {
\r
119 removeExpressions("filter",fieldsToRemove);
\r
122 public void removeFiltersAfter(String field, String operator, String value, String... fieldsToRemove) {
\r
123 removeExpressionsAfter("filter",new Expression(field,operator,value,null),fieldsToRemove);
\r
126 public void setLimit (String limitExpression) {
\r
127 if (limitExpression != null && limitExpression.length()>0) {
\r
128 setParameter(new LimitParameter(new Expression(limitExpression)));
\r
132 public void setLimit(String field, String operator, String value, String label) {
\r
133 setParameter(new LimitParameter(new Expression(field,operator,value,label)));
\r
136 public String getLimit () {
\r
137 return getParameter("limit") == null ? null : ((FilterParameter)getParameter("limit")).getValueWithExpressions();
\r
140 public boolean hasLimitExpression(String... expressionFields) {
\r
141 logger.trace("Checking for limit expression for " + Arrays.deepToString(expressionFields));
\r
142 for (String field : expressionFields) {
\r
143 if (getLimitExpressions(field) != null && getLimitExpressions(field).size()>0) {
\r
144 logger.trace("Limit expression found (" + field + ")");
\r
148 logger.trace("No limit expressions found");
\r
152 public Expression getOneLimitExpression(String expressionField) {
\r
153 List<Expression> exprs = getLimitExpressions(expressionField);
\r
154 if (exprs != null && exprs.size()>0) {
\r
155 if (exprs.size()>1) {
\r
156 logger.warn("More that one limit expression found for [" + expressionField + "] but only asked to return the first one");
\r
158 return exprs.get(0);
\r
164 public List<Expression> getLimitExpressions() {
\r
165 return getParameter("limit").getExpressions();
\r
168 public List<Expression> getLimitExpressions(String... expressionFields) {
\r
169 logger.trace("Checking for limit parameter");
\r
170 if (parameters.get("limit")!=null) {
\r
171 logger.trace("Found");
\r
172 return getParameter("limit").getExpressions(expressionFields);
\r
174 logger.trace("Not found");
\r
179 public void addLimit(String field, String operator, String value, String label) {
\r
180 if (getParameter("limit") == null) {
\r
181 setLimit(field, operator, value, label);
\r
183 addExpression("limit",new Expression(field,operator,value,label));
\r
187 public void removeLimits() {
\r
188 removeParameter("limit");
\r
191 public void removeLimits(String... fieldsToRemove) {
\r
192 removeExpressions("limit",fieldsToRemove);
\r
195 public void removeLimit(String field, String operator, String value) {
\r
196 removeExpression("limit",new Expression(field, operator, value, null));
\r
199 public void removeLimitsAfter(String field, String operator, String value, String... fieldsToRemove) {
\r
200 removeExpressionsAfter("limit",new Expression(field,operator,value,null),fieldsToRemove);
\r
204 public void setStartrecs (String startrecs) {
\r
205 setParameter(new CommandParameter("startrecs","=",startrecs));
\r
208 public String getStartrecs () {
\r
209 return getParameterValue("startrecs");
\r
212 public void setMaxrecs (String maxrecs) {
\r
213 setParameter(new CommandParameter("maxrecs","=",maxrecs));
\r
216 public String getMaxrecs () {
\r
217 return getParameterValue("maxrecs");
\r
220 public void setSort (String sort) {
\r
221 setParameter(new CommandParameter("sort","=",sort));
\r
224 public String getSort () {
\r
225 return getParameterValue("sort");
\r
228 public void setRank (String rank) {
\r
229 setParameter(new CommandParameter("rank","=",rank));
\r
232 public String getRank () {
\r
233 return getParameterValue("rank");
\r
236 public void setMergekey (String mergekey) {
\r
237 setParameter(new CommandParameter("mergekey","=",mergekey));
\r
240 public String getMergekey () {
\r
241 return getParameterValue("mergekey");
\r
246 * Sets a facet, in CQL, to restrict the current results
\r
248 * @param facetKey i.e. 'au' for author
\r
249 * @param term i.e. 'Dickens, Charles'
\r
251 public void setFacet(String facetKey, String term) {
\r
252 if (term != null && term.length()>0) {
\r
253 getParameter("query").addExpression(new Expression(facetKey,"=",term,null));
\r
258 * Sets a facet to limit the current query by. The
\r
259 * facet is appended to the query string itself (rather
\r
260 * as a separately managed entity. It will thus appear
\r
261 * in a query field as retrieved by getQuery(). It will
\r
262 * not be removed by removeFacet(...)
\r
264 * @param facetKey i.e. 'au' for author
\r
265 * @param term i.e. 'Dickens, Charles'
\r
267 public void setFacetOnQuery (String facetKey, String term) {
\r
268 String facetExpression = facetKey + "=" + term;
\r
269 if (term != null && term.length()>0) {
\r
270 String currentQuery= getParameterValue("query");
\r
271 setParameter(new CommandParameter("query","=", currentQuery + " and " + facetExpression));
\r
276 * Removes a facet set by setFacet(...)
\r
278 * Will not remove facets set by setFacetOnQuery(...)
\r
280 * @param facetKey i.e. 'au' for author
\r
281 * @param term i.e. 'Dickens, Charles'
\r
283 public void removeFacet(String facetKey, String term) {
\r
284 if (getParameter("query") != null) {
\r
285 getParameter("query").removeExpression(new Expression(facetKey,"=",term,null));
\r
289 public SearchCommand copy () {
\r
290 SearchCommand newCommand = new SearchCommand();
\r
291 for (String parameterName : parameters.keySet()) {
\r
292 newCommand.setParameterInState(parameters.get(parameterName).copy());
\r
298 public ServiceProxyCommand getSp() {
\r
303 public boolean spOnly() {
\r