Class NameUsageSearchRequest
java.lang.Object
org.gbif.api.model.common.paging.PageableBase
org.gbif.api.model.common.search.SearchRequest<P>
org.gbif.api.model.common.search.FacetedSearchRequest<NameUsageSearchParameter>
org.gbif.api.model.checklistbank.search.NameUsageSearchRequest
- All Implemented Interfaces:
Pageable
A name usage specific search request with convenience methods to add enum based search filters.
By default the query q is send to all available query fields.
Highlighting by default works for descriptions and vernacular names - if turned on.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.gbif.api.model.common.search.FacetedSearchRequest
FacetedSearchRequest.FacetParameters
Nested classes/interfaces inherited from class org.gbif.api.model.common.search.SearchRequest
SearchRequest.QueryField
Nested classes/interfaces inherited from interface org.gbif.api.model.common.paging.Pageable
Pageable.OffsetLimitParameters
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addChecklistFilter
(UUID datasetKey) void
addExtinctFilter
(boolean isExtinct) void
addHabitatFilter
(Habitat habitat) void
addHigherTaxonFilter
(int taxonKey) void
addIssueFilter
(NameUsageIssue issue) void
addOriginFilter
(Origin origin) void
addRankFilter
(Rank rank) void
addTaxonomicStatusFilter
(NomenclaturalStatus nomenclaturalStatus) void
void
addThreatStatusFilter
(ThreatStatus threat) boolean
Allows to request an extended search object with the larger list properties: habitats nomenclaturalStatus threatStatuses descriptions vernacularNames If extended=false and highlighting is activated, the highlighted matches will still be added to the extended properties.void
setExtended
(boolean extended) void
setHighlightContext
(Integer highlightContext) Methods inherited from class org.gbif.api.model.common.search.FacetedSearchRequest
addFacetPage, addFacets, getFacetLimit, getFacetMinCount, getFacetOffset, getFacetPage, getFacetPages, getFacets, isFacetMultiSelect, setFacetLimit, setFacetMinCount, setFacetMultiSelect, setFacetOffset, setFacetPages, setFacets
Methods inherited from class org.gbif.api.model.common.search.SearchRequest
addParameter, addParameter, addParameter, addParameter, addParameter, addParameter, addParameter, addParameter, addParameter, addParameter, getHighlightFields, getParameters, getQ, getQFields, getSpellCheckCount, isHighlight, isSpellCheck, setHighlight, setHighlightFields, setParameters, setQ, setQFields, setSpellCheck, setSpellCheckCount, toString
Methods inherited from class org.gbif.api.model.common.paging.PageableBase
addOffset, copyPagingValues, equals, getLimit, getOffset, hashCode, setLimit, setOffset
-
Constructor Details
-
NameUsageSearchRequest
public NameUsageSearchRequest() -
NameUsageSearchRequest
-
NameUsageSearchRequest
-
-
Method Details
-
getHighlightContext
- Returns:
- the number of characters of the context to show for the highlighted match, including the match itself.
-
setHighlightContext
-
isExtended
Allows to request an extended search object with the larger list properties:- habitats
- nomenclaturalStatus
- threatStatuses
- descriptions
- vernacularNames
- Returns:
- if true request the extended search model
-
setExtended
-
addChecklistFilter
-
addExtinctFilter
-
addHigherTaxonFilter
-
addHabitatFilter
-
addRankFilter
-
addTaxonomicStatusFilter
-
addTaxonomicStatusFilter
-
addThreatStatusFilter
-
addIssueFilter
-
addOriginFilter
-