|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.indexdata.mkjsf.pazpar2.commands.Pazpar2Command
com.indexdata.mkjsf.pazpar2.commands.SearchCommand
@SessionScoped @Named public class SearchCommand
Represents a Pazpar2 search
command, can be accessed by pzreq.search
Field Summary |
---|
Fields inherited from class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command |
---|
name, parameters |
Constructor Summary | |
---|---|
SearchCommand()
|
Method Summary | |
---|---|
void |
addFilter(String field,
String operator,
String value,
String label)
Adds a filter expression with a label for display. |
void |
addLimit(String field,
String operator,
String value,
String label)
Adds a limit expression with a label for display. |
void |
addQueryExpression(String field,
String operator,
String term,
String label)
Adds an expression - for instance a facet criterion, with an optional label - to the query parameter |
SearchCommand |
copy()
Commands must implement this method to provide an completely detached, deep clone of themselves. |
String |
getExtendedQuery()
Returns the complete query parameter value, including expressions. |
String |
getFilter()
Returns the filter parameter value. |
List<Expression> |
getFilterExpressions()
Returns list of all filter expressions |
List<Expression> |
getFilterExpressions(String... expressionFields)
|
String |
getLimit()
Returns the limit parameter value. |
List<Expression> |
getLimitExpressions()
Return a list of all current limit expressions |
List<Expression> |
getLimitExpressions(String... expressionFields)
Returns a list of limit expressions with fields that matches on of expressionFields |
String |
getMaxrecs()
Returns the maxrecs parameter value. |
String |
getMergekey()
Returns the mergekey parameter value. |
Expression |
getOneFilterExpression(String expressionField)
Returns the first filter expression of the given type |
Expression |
getOneLimitExpression(String expressionField)
Returns the first limit expression of the given type |
String |
getQuery()
Returns the simple part of the query parameter value, excluding parts that
were added as expressions (that is, not set with setQuery() ). |
String |
getRank()
Returns the rank parameter value. |
String |
getSort()
Returns the sort parameter value. |
ServiceProxyCommand |
getSp()
Implementing classes must provide their Service Proxy extension command if any extension parameters exists, or -- just to be polite -- 'this' if there is no Service Proxy extension to the given command. |
String |
getStartrecs()
Returns the startrecs parameter value. |
boolean |
hasFilter()
|
boolean |
hasFilterExpression(String... expressionFields)
Checks if there are any filter expressions matching any of the given expressionFields |
boolean |
hasLimitExpression(String... expressionFields)
Checks if there are any limit expressions matching any of the given expressionFields |
void |
removeFacet(String facetKey,
String term)
Removes a facet set by setFacet(...) Will not remove facets set by setFacetOnQuery(...) |
void |
removeFilter(String field,
String operator,
String value)
Removes a filter expression by exact attributes |
void |
removeFilters()
Clears the filter parameter |
void |
removeFilters(String... fieldsToRemove)
Removes all filter expressions matching a field listed in fieldsToRemove |
void |
removeFiltersAfter(String field,
String operator,
String value,
String... fieldsToRemove)
Removes filter expressions coming after the expression matching the provided filter expression, if they have a field listed in fieldsToRemove . |
void |
removeLimit(String field,
String operator,
String value)
Removes a limit expression by exact attributes |
void |
removeLimits()
Clears the limit parameter |
void |
removeLimits(String... fieldsToRemove)
Removes all limit expressions that have fields as listed in fieldsToRemove |
void |
removeLimitsAfter(String field,
String operator,
String value,
String... fieldsToRemove)
Removes limit expressions coming after the provided limit expression, if they have a field listed in fieldsToRemove . |
void |
removeQueryExpression(String field,
String operator,
String value)
Removes a query expression - for instance a facet criterion - by its exact attributes |
ResponseDataObject |
run()
Executes the command with the currently selected parameters against the currently selected Pazpar2 service |
void |
setBooleanOperatorForQuery(String operator)
|
void |
setFacetOnQuery(String facetKey,
String term)
Sets a facet to limit the current query by. |
void |
setFilter(String filterExpression)
Sets the filter parameter. |
void |
setFilter(String field,
String operator,
String value,
String label)
Sets the filter parameter. |
void |
setLimit(String limitExpression)
Sets the limit parameter. |
void |
setLimit(String field,
String operator,
String value,
String label)
Sets the limit parameter including a label. |
void |
setMaxrecs(String maxrecs)
Sets the maxrecs parameter. |
void |
setMergekey(String mergekey)
Sets the mergekey parameter. |
void |
setQuery(String query)
Sets the query parameter. |
void |
setRank(String rank)
Sets the rank parameter. |
void |
setSort(String sort)
Sets the sort parameter. |
void |
setStartrecs(String startrecs)
Sets the startrecs parameter. |
boolean |
spOnly()
Here implementing commands publish whether they only apply to the Service Proxy or can be executed against straight Pazpar2 as well. |
Methods inherited from class com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command |
---|
addExpression, checkInState, equals, getCommandName, getEncodedQueryString, getParameter, getParameterValue, getSession, getValueWithExpressions, hashCode, hasParameters, hasParameterValue, removeExpression, removeExpressions, removeExpressionsAfter, removeParameter, removeParameters, removeParametersInState, run, runWith, setCommandName, setParameter, setParameterInState, setParameters, setParametersInState, setSession, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SearchCommand()
Method Detail |
---|
public ResponseDataObject run()
Pazpar2Command
run
in class Pazpar2Command
public void setQuery(String query)
query
parameter. See Pazpar2 documentation for details.
public void setBooleanOperatorForQuery(String operator)
public String getQuery()
query
parameter value, excluding parts that
were added as expressions (that is, not set with setQuery()
).
public String getExtendedQuery()
query
parameter value, including expressions.
public void setFilter(String filterExpression)
filter
parameter. See Pazpar2 documentation for details.
public void setFilter(String field, String operator, String value, String label)
filter
parameter. See Pazpar2 documentation for details.
public boolean hasFilterExpression(String... expressionFields)
expressionFields
- expression fields (left-of-operator entities) to look for
expressionFields
public String getFilter()
filter
parameter value.
public Expression getOneFilterExpression(String expressionField)
expressionField
- expression field (left-of-operator entity) to look for
expressionField
or null if none foundpublic List<Expression> getFilterExpressions()
public List<Expression> getFilterExpressions(String... expressionFields)
public boolean hasFilter()
public void addFilter(String field, String operator, String value, String label)
field
- operator
- value
- label
- public void removeFilters()
public void removeFilter(String field, String operator, String value)
field
- operator
- value
- public void removeFilters(String... fieldsToRemove)
fieldsToRemove
fieldsToRemove
- public void removeFiltersAfter(String field, String operator, String value, String... fieldsToRemove)
fieldsToRemove
. To be used for bread crumb like UI
controls.
field
- operator
- value
- fieldsToRemove
- public void setLimit(String limitExpression)
limit
parameter. See Pazpar2 documentation for details.
public void setLimit(String field, String operator, String value, String label)
limit
parameter including a label. See Pazpar2 documentation for details.
public String getLimit()
limit
parameter value.
public boolean hasLimitExpression(String... expressionFields)
expressionFields
- expression fields (left-of-operator entities) to look for
expressionFields
public Expression getOneLimitExpression(String expressionField)
expressionField
- expression field (left-of-operator entity) to look for
expressionField
or null if none foundpublic List<Expression> getLimitExpressions()
public List<Expression> getLimitExpressions(String... expressionFields)
expressionFields
expressionFields
- limit expressions to look forpublic void addLimit(String field, String operator, String value, String label)
field
- operator
- value
- label
- public void removeLimits()
public void removeLimits(String... fieldsToRemove)
fieldsToRemove
fieldsToRemove
- public void removeLimit(String field, String operator, String value)
field
- operator
- value
- public void removeLimitsAfter(String field, String operator, String value, String... fieldsToRemove)
fieldsToRemove
. To be used for bread crumb like UI controls.
field
- operator
- value
- fieldsToRemove
- public void setStartrecs(String startrecs)
startrecs
parameter. See Pazpar2 documentation for details.
public String getStartrecs()
startrecs
parameter value.
public void setMaxrecs(String maxrecs)
maxrecs
parameter. See Pazpar2 documentation for details.
public String getMaxrecs()
maxrecs
parameter value.
public void setSort(String sort)
sort
parameter. See Pazpar2 documentation for details.
public String getSort()
sort
parameter value.
public void setRank(String rank)
rank
parameter. See Pazpar2 documentation for details.
public String getRank()
rank
parameter value.
public void setMergekey(String mergekey)
mergekey
parameter. See Pazpar2 documentation for details.
public String getMergekey()
mergekey
parameter value.
public void addQueryExpression(String field, String operator, String term, String label)
Example:
{au}{=}{"Steinbeck, John"}{Steinbeck, John}
public void removeQueryExpression(String field, String operator, String value)
field
- operator
- value
- public void setFacetOnQuery(String facetKey, String term)
facetKey
- i.e. 'au' for authorterm
- i.e. 'Dickens, Charles'public void removeFacet(String facetKey, String term)
facetKey
- i.e. 'au' for authorterm
- i.e. 'Dickens, Charles'public SearchCommand copy()
Pazpar2Command
copy
in class Pazpar2Command
public ServiceProxyCommand getSp()
Pazpar2Command
getSp
in class Pazpar2Command
public boolean spOnly()
Pazpar2Command
spOnly
in interface ServiceProxyCommand
spOnly
in class Pazpar2Command
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |