Package org.gbif.api.model.common.search

Class BaseSearchRequest<P extends SearchParameter>

java.lang.Object

org.gbif.api.model.common.paging.PageableBase

org.gbif.api.model.common.search.BaseSearchRequest<P>

All Implemented Interfaces:

Pageable, SearchRequest<P>

Direct Known Subclasses:

DatasetSuggestRequest, FacetedSearchRequest, NameUsageSuggestRequest

public abstract class BaseSearchRequest<P extends SearchParameter>
extends PageableBase
implements SearchRequest<P>

Generic request class for search operations. This class contains a list of parameters, a list of desired facets and paging options (page size and offset).

Nested Class Summary

Nested classes/interfaces inherited from interface org.gbif.api.model.common.paging.Pageable

Pageable.OffsetLimitParameters

Nested classes/interfaces inherited from interface org.gbif.api.model.common.search.SearchRequest

SearchRequest.QueryField

Constructor Summary

Constructors

Constructor	Description
BaseSearchRequest()	Constructor with default paging offset & limit.
BaseSearchRequest(long offset, int limit)	Minimal paging constructor.
BaseSearchRequest(String query)	Simple query constructor with default paging offset & limit.
BaseSearchRequest(Pageable page)	Minimal paging constructor.

Method Summary

Modifier and Type	Method	Description
void	addParameter(P parameter, boolean value)	Adds the specified boolean parameter.
void	addParameter(P parameter, double value)	Adds the specified double parameter.
void	addParameter(P parameter, int value)	Adds the specified int parameter.
void	addParameter(P parameter, long value)	Adds the specified long parameter.
void	addParameter(P parameter, Enum<?> value)	Adds the specified parameter.
void	addParameter(P parameter, Iterable<String> values)	Adds the specified parameter.
void	addParameter(P parameter, String value)	Adds the specified parameter.
void	addParameter(P parameter, String... values)	Adds the specified parameter.
void	addParameter(P parameter, Date value)	Adds the specified date parameter as an ISO date.
void	addParameter(P parameter, IsoDateInterval value)	Adds the specified date parameter as an ISO date interval.
void	copyPagingValues(Pageable pageable)	Utility method to copy paging values.
Set<SearchRequest.QueryField>	getHighlightFields()	Defines the fields to be highlighted if highlighting is activated.
Map<P,Set<String>>	getParameters()	List of input parameters of the search operation.
String	getQ()	Query parameter.
Set<SearchRequest.QueryField>	getQFields()	Defines whether to match against fields with scientific or vernacular names or both.
int	getSpellCheckCount()
boolean	isHighlight()
@Experimental Boolean	isMatchCase()	This flag enables the use of case-sensitive matches and aggregations on certain search parameters.
boolean	isSpellCheck()
void	setHighlight(boolean highlight)
void	setHighlightFields(Set<SearchRequest.QueryField> highlightFields)
void	setParameters(Map<P,Set<String>> parameters)	Sets the list of parameters.
void	setQ(String q)
void	setQFields(Set<SearchRequest.QueryField> qFields)
void	setSpellCheck(boolean spellCheck)
void	setSpellCheckCount(int spellCheckCount)
String	toString()

Methods inherited from class org.gbif.api.model.common.paging.PageableBase

addOffset, equals, getLimit, getOffset, hashCode, setLimit, setOffset

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gbif.api.model.common.paging.Pageable

getLimit, getOffset

Constructor Details

BaseSearchRequest

public BaseSearchRequest()

Constructor with default paging offset & limit.

BaseSearchRequest

public BaseSearchRequest(String query)

Simple query constructor with default paging offset & limit.

Parameters:

query - string for request

BaseSearchRequest

public BaseSearchRequest(Pageable page)

Minimal paging constructor.

BaseSearchRequest

public BaseSearchRequest(long offset,
 int limit)

Minimal paging constructor.

Method Details

isMatchCase

@Experimental
public @Experimental Boolean isMatchCase()

This flag enables the use of case-sensitive matches and aggregations on certain search parameters.

Fields that support this feature are: occurrenceId, recordedBy, samplingProtocol, catalogNumber, collectionCode, institutionCode, eventId, parentEventId, waterBody, stateProvince, recordNumber, identifiedBy, organismId and locality.

This is an experimental feature, and its implementation may change or be removed at any time.

Be aware that this is not a per-field flag, all possible fields will match case sensitively.

Specified by:

isMatchCase in interface SearchRequest<P extends SearchParameter>

isHighlight

public boolean isHighlight()

Specified by:

isHighlight in interface SearchRequest<P extends SearchParameter>

Returns:

true if highlighted search matches are requested

setHighlight

public void setHighlight(boolean highlight)

Specified by:

setHighlight in interface SearchRequest<P extends SearchParameter>

Parameters:

highlight - the highlight to set

isSpellCheck

public boolean isSpellCheck()

Specified by:

isSpellCheck in interface SearchRequest<P extends SearchParameter>

Returns:

true if spellCheck search is requested

setSpellCheck

public void setSpellCheck(boolean spellCheck)

Specified by:

setSpellCheck in interface SearchRequest<P extends SearchParameter>

Parameters:

spellCheck - the highlight to set

getSpellCheckCount

public int getSpellCheckCount()

Specified by:

getSpellCheckCount in interface SearchRequest<P extends SearchParameter>

Returns:

max number of spell check suggestions requested

setSpellCheckCount

public void setSpellCheckCount(int spellCheckCount)

Specified by:

setSpellCheckCount in interface SearchRequest<P extends SearchParameter>

Parameters:

spellCheckCount - number of spell check suggestions

getQFields

public Set<SearchRequest.QueryField> getQFields()

Defines whether to match against fields with scientific or vernacular names or both.

Specified by:

getQFields in interface SearchRequest<P extends SearchParameter>

setQFields

public void setQFields(Set<SearchRequest.QueryField> qFields)

Specified by:

setQFields in interface SearchRequest<P extends SearchParameter>

getHighlightFields

public Set<SearchRequest.QueryField> getHighlightFields()

Defines the fields to be highlighted if highlighting is activated.

Specified by:

getHighlightFields in interface SearchRequest<P extends SearchParameter>

setHighlightFields

public void setHighlightFields(Set<SearchRequest.QueryField> highlightFields)

Specified by:

setHighlightFields in interface SearchRequest<P extends SearchParameter>

getParameters

public Map<P,Set<String>> getParameters()

List of input parameters of the search operation. The parameters are handled as the parameter name and the string representation of its value.

Specified by:

getParameters in interface SearchRequest<P extends SearchParameter>

Returns:

the list of parameters

setParameters

public void setParameters(Map<P,Set<String>> parameters)

Sets the list of parameters.

Specified by:

setParameters in interface SearchRequest<P extends SearchParameter>

getQ

public String getQ()

Query parameter.

Specified by:

getQ in interface SearchRequest<P extends SearchParameter>

Returns:

the q

setQ

public void setQ(String q)

Specified by:

setQ in interface SearchRequest<P extends SearchParameter>

Parameters:

q - the q to set

addParameter

public void addParameter(P parameter,
 Iterable<String> values)

Adds the specified parameter.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add values for

values - list of values of the parameter to add

addParameter

public void addParameter(P parameter,
 String... values)

Adds the specified parameter.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add values for

values - list of values of the parameter to add

addParameter

public void addParameter(P parameter,
 String value)

Adds the specified parameter.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add values for

value - value of the parameter to add

addParameter

public void addParameter(P parameter,
 long value)

Adds the specified long parameter.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add values for

value - value of the parameter to add

addParameter

public void addParameter(P parameter,
 int value)

Adds the specified int parameter.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add values for

value - value of the parameter to add

addParameter

public void addParameter(P parameter,
 double value)

Adds the specified double parameter.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add values for

value - value of the parameter to add

addParameter

public void addParameter(P parameter,
 boolean value)

Adds the specified boolean parameter.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add values for

value - value of the parameter to add

addParameter

public void addParameter(P parameter,
 Enum<?> value)

Adds the specified parameter.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add values for

value - enum value of the parameter to add

addParameter

public void addParameter(P parameter,
 Date value)

Adds the specified date parameter as an ISO date.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add date for

value - date value of the parameter to add

addParameter

public void addParameter(P parameter,
 IsoDateInterval value)

Adds the specified date parameter as an ISO date interval.

Specified by:

addParameter in interface SearchRequest<P extends SearchParameter>

Parameters:

parameter - parameter to add date interval for

value - date value of the parameter to add

copyPagingValues

public void copyPagingValues(Pageable pageable)

Description copied from class: PageableBase

Utility method to copy paging values.

Specified by:

copyPagingValues in interface SearchRequest<P extends SearchParameter>

Overrides:

copyPagingValues in class PageableBase

toString

public String toString()

Overrides:

toString in class PageableBase