Package org.gbif.api.model.registry.search

Class DatasetSearchRequest

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<DatasetSearchParameter>

org.gbif.api.model.registry.search.DatasetSearchRequest

All Implemented Interfaces:

Pageable

public class DatasetSearchRequest
extends FacetedSearchRequest<DatasetSearchParameter>

A dataset specific search request with convenience methods to add facet filters.

Nested Class Summary

Nested 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

Constructor	Description
DatasetSearchRequest()
DatasetSearchRequest(long offset, int limit)
DatasetSearchRequest(Pageable page)

Method Summary

Modifier and Type	Method	Description
void	addCategory(String category)
void	addContinentFilter(Continent continent)	Filters dataset by a continent of the geospatial coverage.
void	addCountryFilter(Country country)	Filters dataset by a country of the geospatial coverage.
void	addDecadeFilter(int decade)	Filters datasets by their temporal coverage broken down to decades.
void	addHostingOrgFilter(UUID orgKey)
void	addKeywordFilter(String keyword)	Filters datasets by a keyword given in EML or as simple, public tags.
void	addKeywordFilter(Tag keyword)	Filters dataset by a tag.
void	addProjectIdentifier(String identifier)
void	addPublishingCountryFilter(Country country)	Filters dataset by the owning organizations country.
void	addPublishingOrgFilter(UUID orgKey)
void	addSubTypeFilter(DatasetSubtype subtype)
void	addTaxonKey(int taxonKey)
void	addTypeFilter(DatasetType type)
void	addYear(int year)
Integer	getHighlightContext()
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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DatasetSearchRequest

public DatasetSearchRequest()

DatasetSearchRequest

public DatasetSearchRequest(Pageable page)

DatasetSearchRequest

public DatasetSearchRequest(long offset,
                            int limit)

Method Detail

getHighlightContext

public Integer getHighlightContext()

Returns:

the number of characters of the context to show for the highlighted match, including the match itself.

setHighlightContext

public void setHighlightContext(Integer highlightContext)

addPublishingCountryFilter

public void addPublishingCountryFilter(Country country)

Filters dataset by the owning organizations country.

addCountryFilter

public void addCountryFilter(Country country)

Filters dataset by a country of the geospatial coverage.

Parameters:

country - appearing in geospatial coverage

addContinentFilter

public void addContinentFilter(Continent continent)

Filters dataset by a continent of the geospatial coverage.

Parameters:

continent - appearing in geospatial coverage

addDecadeFilter

public void addDecadeFilter(int decade)

Filters datasets by their temporal coverage broken down to decades.

Parameters:

decade - the decade given as a 4 digit integer

addHostingOrgFilter

public void addHostingOrgFilter(UUID orgKey)

addKeywordFilter

public void addKeywordFilter(String keyword)

Filters datasets by a keyword given in EML or as simple, public tags.

Parameters:

keyword - a plain keyword e.g. created by Tag.toString()

addKeywordFilter

public void addKeywordFilter(Tag keyword)

Filters dataset by a tag.

Parameters:

keyword - given as a tag

addPublishingOrgFilter

public void addPublishingOrgFilter(UUID orgKey)

addSubTypeFilter

public void addSubTypeFilter(DatasetSubtype subtype)

addTypeFilter

public void addTypeFilter(DatasetType type)

addProjectIdentifier

public void addProjectIdentifier(String identifier)

addTaxonKey

public void addTaxonKey(int taxonKey)

addYear

public void addYear(int year)

addCategory

public void addCategory(String category)