1 package com.indexdata.mkjsf.pazpar2.commands;
\r
3 import javax.enterprise.context.SessionScoped;
\r
4 import javax.inject.Named;
\r
6 import org.apache.log4j.Logger;
\r
8 import com.indexdata.mkjsf.pazpar2.Pz2Bean;
\r
9 import com.indexdata.mkjsf.pazpar2.commands.sp.ServiceProxyCommand;
\r
10 import com.indexdata.mkjsf.pazpar2.data.ResponseDataObject;
\r
12 @SessionScoped @Named
\r
13 public class SearchCommand extends Pazpar2Command implements ServiceProxyCommand {
\r
15 private static final long serialVersionUID = -1888520867838597236L;
\r
16 private static Logger logger = Logger.getLogger(SearchCommand.class);
\r
17 private SingleTargetFilter singleTargetFilter = null;
\r
19 public SearchCommand() {
\r
23 public ResponseDataObject run() {
\r
24 logger.info("Running " + getCommandName());
\r
25 Pz2Bean.get().getStateMgr().hasPendingStateChange("search",false);
\r
26 Pz2Bean.get().getPzresp().resetSearchAndBeyond();
\r
27 Pz2Bean.get().getPzreq().getRecord().removeParametersInState();
\r
28 Pz2Bean.get().getPzreq().getShow().setParameterInState(new CommandParameter("start","=",0));
\r
29 Pz2Bean.get().getSearchClient().setSearchCommand(this);
\r
34 public void setQuery(String query) {
\r
35 setParameter(new CommandParameter("query","=",query));
\r
38 public String getQuery () {
\r
39 return getParameter("query") == null ? null : getParameter("query").getValueWithExpressions();
\r
42 public void setFilter(String filterExpression) {
\r
43 setParameter(new CommandParameter("filter","=",filterExpression));
\r
46 public String getFilter() {
\r
47 return getParameter("filter") == null ? null : getParameter("filter").getValueWithExpressions();
\r
50 public void addFilter(String filterExpression) {
\r
52 if (hasParameterValue("filter")) {
\r
53 setFilter(filterExpression);
\r
55 getParameter("filter");
\r
57 throw new UnsupportedOperationException("removeFilter(filterExpression) yet to be implemented.");
\r
60 public void removeFilters () {
\r
61 removeParameter("filter");
\r
64 public void removeFilter(String filterExpression) {
\r
66 throw new UnsupportedOperationException("removeFilter(filterExpression) yet to be implemented.");
\r
69 public boolean hasFilter () {
\r
70 return getFilter().length()>0;
\r
73 public void setLimit (String limitExpression) {
\r
74 setParameter(new CommandParameter("limit","=",limitExpression));
\r
77 public String getLimit () {
\r
78 return getParameterValue("limit");
\r
81 public void setStartrecs (String startrecs) {
\r
82 setParameter(new CommandParameter("startrecs","=",startrecs));
\r
85 public String getStartrecs () {
\r
86 return getParameterValue("startrecs");
\r
89 public void setMaxrecs (String maxrecs) {
\r
90 setParameter(new CommandParameter("maxrecs","=",maxrecs));
\r
93 public String getMaxrecs () {
\r
94 return getParameterValue("maxrecs");
\r
97 public void setSort (String sort) {
\r
98 setParameter(new CommandParameter("sort","=",sort));
\r
101 public String getSort () {
\r
102 return getParameterValue("sort");
\r
105 public void setRank (String rank) {
\r
106 setParameter(new CommandParameter("rank","=",rank));
\r
109 public String getRank () {
\r
110 return getParameterValue("rank");
\r
113 public void setMergekey (String mergekey) {
\r
114 setParameter(new CommandParameter("mergekey","=",mergekey));
\r
117 public String getMergekey () {
\r
118 return getParameterValue("mergekey");
\r
123 * Sets a facet, in CQL, to restrict the current results,
\r
124 * then executes the search
\r
126 * @param facetKey i.e. 'au' for author
\r
127 * @param term i.e. 'Dickens, Charles'
\r
129 public void setFacet(String facetKey, String term) {
\r
130 if (term != null && term.length()>0) {
\r
131 getParameter("query").addExpression(new Expression(facetKey,"=",term));
\r
136 * Sets a facet to limit the current query by. The
\r
137 * facet is appended to the query string itself (rather
\r
138 * as a separately managed entity. It will thus appear
\r
139 * in a query field as retrieved by getQuery(). It will
\r
140 * not be removed by removeFacet(...)
\r
142 * @param facetKey i.e. 'au' for author
\r
143 * @param term i.e. 'Dickens, Charles'
\r
145 public void setFacetOnQuery (String facetKey, String term) {
\r
146 String facetExpression = facetKey + "=" + term;
\r
147 if (term != null && term.length()>0) {
\r
148 String currentQuery= getParameterValue("query");
\r
149 setParameter(new CommandParameter("query","=", currentQuery + " and " + facetExpression));
\r
154 * Removes a facet set by setFacet(...), then executes
\r
157 * Will not remove facets set by setFacetOnQuery(...)
\r
159 * @param facetKey i.e. 'au' for author
\r
160 * @param term i.e. 'Dickens, Charles'
\r
162 public void removeFacet(String facetKey, String term) {
\r
163 if (getParameter("query") != null) {
\r
164 getParameter("query").removeExpression(new Expression(facetKey,"=",term));
\r
170 * Adds a single target filter to restrict the current query by,
\r
171 * then executes the current search.
\r
173 * This is a special case of the general setFilter function,
\r
174 * allowing to associate a descriptive target name with the
\r
175 * filter expression for display in UI.
\r
177 * @param targetId pazpar2's ID for the target to limit by
\r
178 * @param targetName a descriptive name for the target
\r
180 public void setSingleTargetFilter (String targetId, String targetName) {
\r
181 if (hasSingleTargetFilter(new SingleTargetFilter(targetId,targetName))) {
\r
182 logger.debug("Already using target filter " + this.singleTargetFilter.getFilterExpression());
\r
184 logger.debug("Setting new single target filter for [" + targetName + "]");
\r
185 this.singleTargetFilter = new SingleTargetFilter(targetId,targetName);
\r
186 setParameter(new CommandParameter("filter","=",this.singleTargetFilter.getFilterExpression()));
\r
190 public SingleTargetFilter getSingleTargetFilter () {
\r
191 logger.debug("request to get the current single target filter " + singleTargetFilter);
\r
192 return singleTargetFilter;
\r
196 * Removes the current target filter from the search
\r
199 public String removeSingleTargetFilter () {
\r
200 logger.debug("Removing target filter " + singleTargetFilter.getFilterExpression());
\r
201 this.singleTargetFilter = null;
\r
202 removeParameter("filter");
\r
208 * @return The target filter set on the current search command
\r
210 public boolean hasSingleTargetFilter() {
\r
211 logger.debug("Checking if a single target filter is set: " + (singleTargetFilter != null));
\r
212 return singleTargetFilter != null;
\r
216 * Resolves if the current search command has a target filter - to
\r
217 * be used by the UI for conditional rendering of target filter info.
\r
219 * @return true if the current search command is limited by a target
\r
222 protected boolean hasSingleTargetFilter(SingleTargetFilter targetFilter) {
\r
223 logger.debug("Checking if target filter for [" + targetFilter.getTargetName() + "] is set.");
\r
224 return hasSingleTargetFilter() && targetFilter.equals(this.singleTargetFilter);
\r
227 public SearchCommand copy () {
\r
228 SearchCommand newCommand = new SearchCommand();
\r
229 for (String parameterName : parameters.keySet()) {
\r
230 newCommand.setParameterInState(parameters.get(parameterName).copy());
\r
232 newCommand.singleTargetFilter = this.singleTargetFilter;
\r
237 public ServiceProxyCommand getSp() {
\r
242 public boolean spOnly() {
\r