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 QueryParameter("query","=",query));
\r
39 public void setBooleanOperatorForQuery(String operator) {
\r
40 Pazpar2Command copy = this.copy();
\r
41 ((QueryParameter) getParameter("query")).setBooleanOperator(operator);
\r
45 public String getQuery () {
\r
46 return getParameter("query") == null ? null : getParameter("query").getSimpleValue();
\r
49 public String getExtendedQuery () {
\r
50 return getParameter("query") == null ? null : getParameter("query").getValueWithExpressions();
\r
53 public void setFilter(String filterExpression) {
\r
54 if (filterExpression != null && filterExpression.length()>0) {
\r
55 if (filterExpression.split("[=~]").length==1) {
\r
56 removeFilters(filterExpression.split("[=~]")[0]);
\r
57 } else if (filterExpression.split("[=~]").length==2) {
\r
58 setParameter(new FilterParameter(new Expression(filterExpression)));
\r
60 logger.error("Could not parse filter expression [" + filterExpression + "]");
\r
65 public void setFilter(String field, String operator, String value, String label) {
\r
66 setParameter(new FilterParameter(new Expression(field,operator,value,label)));
\r
69 public boolean hasFilterExpression(String... expressionFields) {
\r
70 logger.trace("Checking for filter expression for " + Arrays.deepToString(expressionFields));
\r
71 for (String field : expressionFields) {
\r
72 if (getFilterExpressions(field) != null && getFilterExpressions(field).size()>0) {
\r
73 logger.trace("Filter expression found (" + field + ")");
\r
77 logger.trace("No filter expressions found");
\r
82 public String getFilter() {
\r
83 return getParameter("filter") == null ? null : ((FilterParameter)getParameter("filter")).getValueWithExpressions();
\r
86 public Expression getOneFilterExpression(String expressionField) {
\r
87 List<Expression> exprs = getFilterExpressions(expressionField);
\r
88 if (exprs != null && exprs.size()>0) {
\r
89 if (exprs.size()>1) {
\r
90 logger.warn("More that one filter expression found for [" + expressionField + "] but only asked to return the first one");
\r
92 return exprs.get(0);
\r
99 public List<Expression> getFilterExpressions() {
\r
100 return getParameter("filter").getExpressions();
\r
103 public List<Expression> getFilterExpressions(String... expressionFields) {
\r
104 logger.trace("Checking for filter parameter");
\r
105 if (parameters.get("filter")!=null) {
\r
106 logger.trace("Found");
\r
107 return getParameter("filter").getExpressions(expressionFields);
\r
109 logger.trace("Not found");
\r
114 public boolean hasFilter () {
\r
115 return getFilter().length()>0;
\r
118 public void addFilter(String field, String operator, String value, String label) {
\r
119 if (getParameter("filter") == null) {
\r
120 setFilter(field + operator + value);
\r
122 addExpression("filter",new Expression(field,operator,value,(label != null ? label : value)));
\r
126 public void removeFilters () {
\r
127 removeParameter("filter");
\r
130 public void removeFilter(String field, String operator, String value) {
\r
131 removeExpression("filter",new Expression(field, operator, value, null));
\r
134 public void removeFilters(String... fieldsToRemove) {
\r
135 removeExpressions("filter",fieldsToRemove);
\r
138 public void removeFiltersAfter(String field, String operator, String value, String... fieldsToRemove) {
\r
139 removeExpressionsAfter("filter",new Expression(field,operator,value,null),fieldsToRemove);
\r
142 public void setLimit (String limitExpression) {
\r
143 if (limitExpression != null && limitExpression.length()>0) {
\r
144 setParameter(new LimitParameter(new Expression(limitExpression)));
\r
148 public void setLimit(String field, String operator, String value, String label) {
\r
149 setParameter(new LimitParameter(new Expression(field,operator,value,label)));
\r
152 public String getLimit () {
\r
153 return getParameter("limit") == null ? null : ((FilterParameter)getParameter("limit")).getValueWithExpressions();
\r
156 public boolean hasLimitExpression(String... expressionFields) {
\r
157 logger.trace("Checking for limit expression for " + Arrays.deepToString(expressionFields));
\r
158 for (String field : expressionFields) {
\r
159 if (getLimitExpressions(field) != null && getLimitExpressions(field).size()>0) {
\r
160 logger.trace("Limit expression found (" + field + ")");
\r
164 logger.trace("No limit expressions found");
\r
168 public Expression getOneLimitExpression(String expressionField) {
\r
169 List<Expression> exprs = getLimitExpressions(expressionField);
\r
170 if (exprs != null && exprs.size()>0) {
\r
171 if (exprs.size()>1) {
\r
172 logger.warn("More that one limit expression found for [" + expressionField + "] but only asked to return the first one");
\r
174 return exprs.get(0);
\r
180 public List<Expression> getLimitExpressions() {
\r
181 return getParameter("limit").getExpressions();
\r
184 public List<Expression> getLimitExpressions(String... expressionFields) {
\r
185 logger.trace("Checking for limit parameter");
\r
186 if (parameters.get("limit")!=null) {
\r
187 logger.trace("Found");
\r
188 return getParameter("limit").getExpressions(expressionFields);
\r
190 logger.trace("Not found");
\r
195 public void addLimit(String field, String operator, String value, String label) {
\r
196 if (getParameter("limit") == null) {
\r
197 setLimit(field, operator, value, label);
\r
199 addExpression("limit",new Expression(field,operator,value,label));
\r
203 public void removeLimits() {
\r
204 removeParameter("limit");
\r
207 public void removeLimits(String... fieldsToRemove) {
\r
208 removeExpressions("limit",fieldsToRemove);
\r
211 public void removeLimit(String field, String operator, String value) {
\r
212 removeExpression("limit",new Expression(field, operator, value, null));
\r
215 public void removeLimitsAfter(String field, String operator, String value, String... fieldsToRemove) {
\r
216 removeExpressionsAfter("limit",new Expression(field,operator,value,null),fieldsToRemove);
\r
220 public void setStartrecs (String startrecs) {
\r
221 setParameter(new CommandParameter("startrecs","=",startrecs));
\r
224 public String getStartrecs () {
\r
225 return getParameterValue("startrecs");
\r
228 public void setMaxrecs (String maxrecs) {
\r
229 setParameter(new CommandParameter("maxrecs","=",maxrecs));
\r
232 public String getMaxrecs () {
\r
233 return getParameterValue("maxrecs");
\r
236 public void setSort (String sort) {
\r
237 setParameter(new CommandParameter("sort","=",sort));
\r
240 public String getSort () {
\r
241 return getParameterValue("sort");
\r
244 public void setRank (String rank) {
\r
245 setParameter(new CommandParameter("rank","=",rank));
\r
248 public String getRank () {
\r
249 return getParameterValue("rank");
\r
252 public void setMergekey (String mergekey) {
\r
253 setParameter(new CommandParameter("mergekey","=",mergekey));
\r
256 public String getMergekey () {
\r
257 return getParameterValue("mergekey");
\r
262 * Sets a facet, in CQL, to restrict the current results
\r
264 * @param facetKey i.e. 'au' for author
\r
265 * @param term i.e. 'Dickens, Charles'
\r
267 public void setFacet(String facetKey, String term) {
\r
268 if (term != null && term.length()>0) {
\r
269 addExpression("query", new Expression(facetKey,"=",term,null));
\r
274 * Sets a facet to limit the current query by. The
\r
275 * facet is appended to the query string itself (rather
\r
276 * as a separately managed entity. It will thus appear
\r
277 * in a query field as retrieved by getQuery(). It will
\r
278 * not be removed by removeFacet(...)
\r
280 * @param facetKey i.e. 'au' for author
\r
281 * @param term i.e. 'Dickens, Charles'
\r
283 public void setFacetOnQuery (String facetKey, String term) {
\r
284 String facetExpression = facetKey + "=" + term;
\r
285 if (term != null && term.length()>0) {
\r
286 String currentQuery= getParameterValue("query");
\r
287 setParameter(new CommandParameter("query","=", currentQuery + " and " + facetExpression));
\r
292 * Removes a facet set by setFacet(...)
\r
294 * Will not remove facets set by setFacetOnQuery(...)
\r
296 * @param facetKey i.e. 'au' for author
\r
297 * @param term i.e. 'Dickens, Charles'
\r
299 public void removeFacet(String facetKey, String term) {
\r
300 if (getParameter("query") != null) {
\r
301 removeExpression("query",new Expression(facetKey,"=",term,null));
\r
305 public SearchCommand copy () {
\r
306 SearchCommand newCommand = new SearchCommand();
\r
307 for (String parameterName : parameters.keySet()) {
\r
308 newCommand.setParameterInState(parameters.get(parameterName).copy());
\r
314 public ServiceProxyCommand getSp() {
\r
319 public boolean spOnly() {
\r