com.indexdata.mkjsf.pazpar2.commands

Class SearchCommand

java.lang.Object

com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command

com.indexdata.mkjsf.pazpar2.commands.SearchCommand

All Implemented Interfaces:

ServiceProxyCommand, java.io.Serializable

@SessionScoped
@Named
public class SearchCommand
extends Pazpar2Command
implements ServiceProxyCommand

Represents a Pazpar2 search command, can be accessed by pzreq.search

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchCommand()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFilter(java.lang.String field, java.lang.String operator, java.lang.String value, java.lang.String label) Adds a filter expression with a label for display.
void	addLimit(java.lang.String field, java.lang.String operator, java.lang.String value, java.lang.String label) Adds a limit expression with a label for display.
void	addQueryExpression(java.lang.String field, java.lang.String operator, java.lang.String term, java.lang.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.
java.lang.String	getExtendedQuery() Returns the complete query parameter value, including expressions.
java.lang.String	getFilter() Returns the filter parameter value.
java.util.List<Expression>	getFilterExpressions() Returns list of all filter expressions
java.util.List<Expression>	getFilterExpressions(java.lang.String... expressionFields)
java.lang.String	getLimit() Returns the limit parameter value.
java.util.List<Expression>	getLimitExpressions() Return a list of all current limit expressions
java.util.List<Expression>	getLimitExpressions(java.lang.String... expressionFields) Returns a list of limit expressions with fields that matches on of expressionFields
java.lang.String	getMaxrecs() Returns the maxrecs parameter value.
java.lang.String	getMergekey() Returns the mergekey parameter value.
Expression	getOneFilterExpression(java.lang.String expressionField) Returns the first filter expression of the given type
Expression	getOneLimitExpression(java.lang.String expressionField) Returns the first limit expression of the given type
java.lang.String	getQuery() Returns the simple part of the query parameter value, excluding parts that were added as expressions (that is, not set with setQuery()).
java.lang.String	getRank() Returns the rank parameter value.
java.lang.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.
java.lang.String	getStartrecs() Returns the startrecs parameter value.
boolean	hasFilter()
boolean	hasFilterExpression(java.lang.String... expressionFields) Checks if there are any filter expressions matching any of the given expressionFields
boolean	hasLimitExpression(java.lang.String... expressionFields) Checks if there are any limit expressions matching any of the given expressionFields
void	removeFacet(java.lang.String facetKey, java.lang.String term) Removes a facet set by setFacet(...) Will not remove facets set by setFacetOnQuery(...)
void	removeFilter(java.lang.String field, java.lang.String operator, java.lang.String value) Removes a filter expression by exact attributes
void	removeFilters() Clears the filter parameter
void	removeFilters(java.lang.String... fieldsToRemove) Removes all filter expressions matching a field listed in fieldsToRemove
void	removeFiltersAfter(java.lang.String field, java.lang.String operator, java.lang.String value, java.lang.String... fieldsToRemove) Removes filter expressions coming after the expression matching the provided filter expression, if they have a field listed in fieldsToRemove.
void	removeLimit(java.lang.String field, java.lang.String operator, java.lang.String value) Removes a limit expression by exact attributes
void	removeLimits() Clears the limit parameter
void	removeLimits(java.lang.String... fieldsToRemove) Removes all limit expressions that have fields as listed in fieldsToRemove
void	removeLimitsAfter(java.lang.String field, java.lang.String operator, java.lang.String value, java.lang.String... fieldsToRemove) Removes limit expressions coming after the provided limit expression, if they have a field listed in fieldsToRemove.
void	removeQueryExpression(java.lang.String field, java.lang.String operator, java.lang.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(java.lang.String operator)
void	setFacetOnQuery(java.lang.String facetKey, java.lang.String term) Sets a facet to limit the current query by.
void	setFilter(java.lang.String filterExpression) Sets the filter parameter.
void	setFilter(java.lang.String field, java.lang.String operator, java.lang.String value, java.lang.String label) Sets the filter parameter.
void	setLimit(java.lang.String limitExpression) Sets the limit parameter.
void	setLimit(java.lang.String field, java.lang.String operator, java.lang.String value, java.lang.String label) Sets the limit parameter including a label.
void	setMaxrecs(java.lang.String maxrecs) Sets the maxrecs parameter.
void	setMergekey(java.lang.String mergekey) Sets the mergekey parameter.
void	setQuery(java.lang.String query) Sets the query parameter.
void	setRank(java.lang.String rank) Sets the rank parameter.
void	setSort(java.lang.String sort) Sets the sort parameter.
void	setStartrecs(java.lang.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, equals, getCommandName, getEncodedQueryString, getParameter, getParameterValue, getSession, getValueWithExpressions, hashCode, hasParameters, hasParameterValue, removeExpression, removeExpressions, removeExpressionsAfter, removeParameter, removeParameters, removeParametersInState, run, runWith, runWith2, setCommandName, setParameter, setParameterInState, setParameters, setParametersInState, setSession, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchCommand

public SearchCommand()

Method Detail

run

public ResponseDataObject run()

Description copied from class: Pazpar2Command

Executes the command with the currently selected parameters against the currently selected Pazpar2 service

Overrides:

run in class Pazpar2Command

Returns:

Response data object based on the Pazpar2 service response.

setQuery

public void setQuery(java.lang.String query)

Sets the query parameter. See Pazpar2 documentation for details.

setBooleanOperatorForQuery

public void setBooleanOperatorForQuery(java.lang.String operator)

getQuery

public java.lang.String getQuery()

Returns the simple part of the query parameter value, excluding parts that were added as expressions (that is, not set with setQuery()).

getExtendedQuery

public java.lang.String getExtendedQuery()

Returns the complete query parameter value, including expressions.

setFilter

public void setFilter(java.lang.String filterExpression)

Sets the filter parameter. See Pazpar2 documentation for details.

setFilter

public void setFilter(java.lang.String field,
             java.lang.String operator,
             java.lang.String value,
             java.lang.String label)

Sets the filter parameter. See Pazpar2 documentation for details.

hasFilterExpression

public boolean hasFilterExpression(java.lang.String... expressionFields)

Checks if there are any filter expressions matching any of the given expressionFields

Parameters:

expressionFields - expression fields (left-of-operator entities) to look for

Returns:

true if expression(s) found with any of expressionFields

getFilter

public java.lang.String getFilter()

Returns the filter parameter value.

getOneFilterExpression

public Expression getOneFilterExpression(java.lang.String expressionField)

Returns the first filter expression of the given type

Parameters:

expressionField - expression field (left-of-operator entity) to look for

Returns:

the first filter expression found with the field expressionField or null if none found

getFilterExpressions

public java.util.List<Expression> getFilterExpressions()

Returns list of all filter expressions

getFilterExpressions

public java.util.List<Expression> getFilterExpressions(java.lang.String... expressionFields)

hasFilter

public boolean hasFilter()

addFilter

public void addFilter(java.lang.String field,
             java.lang.String operator,
             java.lang.String value,
             java.lang.String label)

Adds a filter expression with a label for display. The filter is added to the end of an ordered list.

Parameters:

field -

operator -

value -

label -

removeFilters

public void removeFilters()

Clears the filter parameter

removeFilter

public void removeFilter(java.lang.String field,
                java.lang.String operator,
                java.lang.String value)

Removes a filter expression by exact attributes

Parameters:

field -

operator -

value -

removeFilters

public void removeFilters(java.lang.String... fieldsToRemove)

Removes all filter expressions matching a field listed in fieldsToRemove

Parameters:

fieldsToRemove -

removeFiltersAfter

public void removeFiltersAfter(java.lang.String field,
                      java.lang.String operator,
                      java.lang.String value,
                      java.lang.String... fieldsToRemove)

Removes filter expressions coming after the expression matching the provided filter expression, if they have a field listed in fieldsToRemove. To be used for bread crumb like UI controls.

Parameters:

field -

operator -

value -

fieldsToRemove -

setLimit

public void setLimit(java.lang.String limitExpression)

Sets the limit parameter. See Pazpar2 documentation for details.

setLimit

public void setLimit(java.lang.String field,
            java.lang.String operator,
            java.lang.String value,
            java.lang.String label)

Sets the limit parameter including a label. See Pazpar2 documentation for details.

getLimit

public java.lang.String getLimit()

Returns the limit parameter value.

hasLimitExpression

public boolean hasLimitExpression(java.lang.String... expressionFields)

Checks if there are any limit expressions matching any of the given expressionFields

Parameters:

expressionFields - expression fields (left-of-operator entities) to look for

Returns:

true if expression(s) found with any of expressionFields

getOneLimitExpression

public Expression getOneLimitExpression(java.lang.String expressionField)

Returns the first limit expression of the given type

Parameters:

expressionField - expression field (left-of-operator entity) to look for

Returns:

the first limit expression found with the field expressionField or null if none found

getLimitExpressions

public java.util.List<Expression> getLimitExpressions()

Return a list of all current limit expressions

getLimitExpressions

public java.util.List<Expression> getLimitExpressions(java.lang.String... expressionFields)

Returns a list of limit expressions with fields that matches on of expressionFields

Parameters:

expressionFields - limit expressions to look for

addLimit

public void addLimit(java.lang.String field,
            java.lang.String operator,
            java.lang.String value,
            java.lang.String label)

Adds a limit expression with a label for display. The limit is added to the end of an ordered list.

Parameters:

field -

operator -

value -

label -

removeLimits

public void removeLimits()

Clears the limit parameter

removeLimits

public void removeLimits(java.lang.String... fieldsToRemove)

Removes all limit expressions that have fields as listed in fieldsToRemove

Parameters:

fieldsToRemove -

removeLimit

public void removeLimit(java.lang.String field,
               java.lang.String operator,
               java.lang.String value)

Removes a limit expression by exact attributes

Parameters:

field -

operator -

value -

removeLimitsAfter

public void removeLimitsAfter(java.lang.String field,
                     java.lang.String operator,
                     java.lang.String value,
                     java.lang.String... fieldsToRemove)

Removes limit expressions coming after the provided limit expression, if they have a field listed in fieldsToRemove. To be used for bread crumb like UI controls.

Parameters:

field -

operator -

value -

fieldsToRemove -

setStartrecs

public void setStartrecs(java.lang.String startrecs)

Sets the startrecs parameter. See Pazpar2 documentation for details.

getStartrecs

public java.lang.String getStartrecs()

Returns the startrecs parameter value.

setMaxrecs

public void setMaxrecs(java.lang.String maxrecs)

Sets the maxrecs parameter. See Pazpar2 documentation for details.

getMaxrecs

public java.lang.String getMaxrecs()

Returns the maxrecs parameter value.

setSort

public void setSort(java.lang.String sort)

Sets the sort parameter. See Pazpar2 documentation for details.

getSort

public java.lang.String getSort()

Returns the sort parameter value.

setRank

public void setRank(java.lang.String rank)

Sets the rank parameter. See Pazpar2 documentation for details.

getRank

public java.lang.String getRank()

Returns the rank parameter value.

setMergekey

public void setMergekey(java.lang.String mergekey)

Sets the mergekey parameter. See Pazpar2 documentation for details.

getMergekey

public java.lang.String getMergekey()

Returns the mergekey parameter value.

addQueryExpression

public void addQueryExpression(java.lang.String field,
                      java.lang.String operator,
                      java.lang.String term,
                      java.lang.String label)

Adds an expression - for instance a facet criterion, with an optional label - to the query parameter

Example:

• {au}{=}{"Steinbeck, John"}{Steinbeck, John}

removeQueryExpression

public void removeQueryExpression(java.lang.String field,
                         java.lang.String operator,
                         java.lang.String value)

Removes a query expression - for instance a facet criterion - by its exact attributes

Parameters:

field -

operator -

value -

setFacetOnQuery

public void setFacetOnQuery(java.lang.String facetKey,
                   java.lang.String term)

Sets a facet to limit the current query by. The facet is appended to the query string itself (rather as a separately managed entity. It will thus appear in a query field as retrieved by getQuery(). It will not be removed by removeFacet(...)

Parameters:

facetKey - i.e. 'au' for author

term - i.e. 'Dickens, Charles'

removeFacet

public void removeFacet(java.lang.String facetKey,
               java.lang.String term)

Removes a facet set by setFacet(...) Will not remove facets set by setFacetOnQuery(...)

Parameters:

facetKey - i.e. 'au' for author

term - i.e. 'Dickens, Charles'

copy

public SearchCommand copy()

Description copied from class: Pazpar2Command

Commands must implement this method to provide an completely detached, deep clone of themselves. The clone is needed by the state manager to transfer commands with current setting from one state to the next. Whenever a non-standard attribute is added to a command class, the copy method must be updated to ensure that the new attribute is brought over as well.

Specified by:

copy in class Pazpar2Command

Returns:

a Pazpar2 command of the given type

getSp

public ServiceProxyCommand getSp()

Description copied from class: Pazpar2Command

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.

Specified by:

getSp in class Pazpar2Command

Returns:

spOnly

public boolean spOnly()

Description copied from class: Pazpar2Command

Here implementing commands publish whether they only apply to the Service Proxy or can be executed against straight Pazpar2 as well. This is convenient for a UI that switches between service types either deployment time or run time.

Specified by:

spOnly in interface ServiceProxyCommand

Specified by:

spOnly in class Pazpar2Command

Returns:

false if the command applies to straight Pazpar2