org.gbif.api.model.occurrence.search

Class OccurrenceSearchRequest

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

org.gbif.api.model.occurrence.search.OccurrenceSearchRequest

All Implemented Interfaces:

Pageable

Direct Known Subclasses:

OccurrencePredicateSearchRequest

public class OccurrenceSearchRequest
extends FacetedSearchRequest<OccurrenceSearchParameter>

Request class for issuing search request to the occurrence search service.

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 and Description
OccurrenceSearchRequest()
OccurrenceSearchRequest(long offset, int limit)
OccurrenceSearchRequest(Pageable page)

Method Summary

Modifier and Type	Method and Description
void	addBasisOfRecordFilter(BasisOfRecord basisOfRecord)
void	addCatalogNumberFilter(String catalogNumber)
void	addClassKeyFilter(int classKey)
void	addCollectionKeyFilter(String collectionKey)
void	addContinentFilter(Continent continent)
void	addCoordinateUncertaintyInMetersFilter(double uncertainty)
void	addCountryFilter(Country country)
void	addDatasetKeyFilter(UUID datasetKey)
void	addDecimalLatitudeFilter(double latitude)
void	addDecimalLongitudeFilter(double longitude)
void	addElevationFilter(double elevation)
void	addEstablishmentMeansFilter(EstablishmentMeans establishmentMeans)
void	addEventDateFilter(IsoDateInterval date)
void	addFamilyKeyFilter(int familyKey)
void	addGadmGidFilter(String gadmGid)
void	addGadmLevel0GidFilter(String gadm0)
void	addGadmLevel1GidFilter(String gadm1)
void	addGadmLevel2GidFilter(String gadm2)
void	addGadmLevel3GidFilter(String gadm3)
void	addGenusKeyFilter(int genusKey)
void	addGeometryFilter(String geometryAsWkt)
void	addHasCoordinateFilter(boolean hasCoordinate)
void	addIdentifiedByFilter(String collectorName)
void	addIdentifiedByIdsFilter(String identifiedByIds)
void	addInstitutionCodeFilter(String code)
void	addInstitutionKeyFilter(String institutionKey)
void	addIssueFilter(OccurrenceIssue issue)
void	addKingdomKeyFilter(int kingdomKey)
void	addLastInterpretedFilter(Date modified)
void	addMediaTypeFilter(MediaType mediaType)
void	addMonthFilter(int month)
void	addOccurrenceIDFilter(String occurrenceID)
void	addOccurrenceStatusFilter(OccurrenceStatus occurrenceStatus)
void	addOrderKeyFilter(int orderKey)
void	addPhylumKeyFilter(int phylumKey)
void	addPublishingCountryFilter(Country country)
void	addRecordedByFilter(String collectorName)
void	addRecordedByIdsFilter(String recordedByIds)
void	addRecordNumberFilter(String recordNumber)
void	addSpatialIssueFilter(boolean hasSpatialIssue)
void	addSpeciesKeyFilter(int speciesKey)
void	addSubGenusKeyFilter(int subGenusKey)
void	addTaxonKeyFilter(int taxonKey)
void	addTypeStatusFilter(TypeStatus typeStatus)
void	addYearFilter(int year)
@Experimental String	getShuffle() This flag allows to sort the results in a random order by specifying a seed.
@Experimental Boolean	isMatchCase() This flag enables the use of case-sensitive matches and aggregations on certain search parameters.
void	setMatchCase(Boolean matchCase)
void	setShuffle(String shuffle)

Methods inherited from class org.gbif.api.model.common.search.FacetedSearchRequest

addFacetPage, addFacets, getFacetLimit, getFacetMinCount, getFacetOffset, getFacetPage, getFacetPages, getFacets, isMultiSelectFacets, setFacetLimit, setFacetMinCount, setFacetOffset, setFacetPages, setFacets, setMultiSelectFacets

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

OccurrenceSearchRequest

public OccurrenceSearchRequest()

OccurrenceSearchRequest

public OccurrenceSearchRequest(long offset,
                               int limit)

OccurrenceSearchRequest

public OccurrenceSearchRequest(Pageable page)

Method Detail

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 map change or be removed at any time.

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

setMatchCase

@Experimental
public void setMatchCase(Boolean matchCase)

getShuffle

@Experimental
public @Experimental String getShuffle()

This flag allows to sort the results in a random order by specifying a seed. The seed makes the random results reproducible so we can use paging. The same seed has to be sent for each page.

setShuffle

@Experimental
public void setShuffle(String shuffle)

addOccurrenceIDFilter

public void addOccurrenceIDFilter(String occurrenceID)

addEstablishmentMeansFilter

public void addEstablishmentMeansFilter(EstablishmentMeans establishmentMeans)

addBasisOfRecordFilter

public void addBasisOfRecordFilter(BasisOfRecord basisOfRecord)

addTypeStatusFilter

public void addTypeStatusFilter(TypeStatus typeStatus)

addCatalogNumberFilter

public void addCatalogNumberFilter(String catalogNumber)

addRecordedByFilter

public void addRecordedByFilter(String collectorName)

addIdentifiedByFilter

public void addIdentifiedByFilter(String collectorName)

addRecordNumberFilter

public void addRecordNumberFilter(String recordNumber)

addCountryFilter

public void addCountryFilter(Country country)

addContinentFilter

public void addContinentFilter(Continent continent)

addDatasetKeyFilter

public void addDatasetKeyFilter(UUID datasetKey)

addGeometryFilter

public void addGeometryFilter(String geometryAsWkt)

addDecimalLatitudeFilter

public void addDecimalLatitudeFilter(double latitude)

addDecimalLongitudeFilter

public void addDecimalLongitudeFilter(double longitude)

addCoordinateUncertaintyInMetersFilter

public void addCoordinateUncertaintyInMetersFilter(double uncertainty)

addMonthFilter

public void addMonthFilter(int month)

addTaxonKeyFilter

public void addTaxonKeyFilter(int taxonKey)

addKingdomKeyFilter

public void addKingdomKeyFilter(int kingdomKey)

addPhylumKeyFilter

public void addPhylumKeyFilter(int phylumKey)

addClassKeyFilter

public void addClassKeyFilter(int classKey)

addOrderKeyFilter

public void addOrderKeyFilter(int orderKey)

addFamilyKeyFilter

public void addFamilyKeyFilter(int familyKey)

addGenusKeyFilter

public void addGenusKeyFilter(int genusKey)

addSubGenusKeyFilter

public void addSubGenusKeyFilter(int subGenusKey)

addSpeciesKeyFilter

public void addSpeciesKeyFilter(int speciesKey)

addYearFilter

public void addYearFilter(int year)

addEventDateFilter

public void addEventDateFilter(IsoDateInterval date)

addLastInterpretedFilter

public void addLastInterpretedFilter(Date modified)

addPublishingCountryFilter

public void addPublishingCountryFilter(Country country)

addInstitutionCodeFilter

public void addInstitutionCodeFilter(String code)

addHasCoordinateFilter

public void addHasCoordinateFilter(boolean hasCoordinate)

addSpatialIssueFilter

public void addSpatialIssueFilter(boolean hasSpatialIssue)

addIssueFilter

public void addIssueFilter(OccurrenceIssue issue)

addElevationFilter

public void addElevationFilter(double elevation)

addMediaTypeFilter

public void addMediaTypeFilter(MediaType mediaType)

addRecordedByIdsFilter

public void addRecordedByIdsFilter(String recordedByIds)

addIdentifiedByIdsFilter

public void addIdentifiedByIdsFilter(String identifiedByIds)

addOccurrenceStatusFilter

public void addOccurrenceStatusFilter(OccurrenceStatus occurrenceStatus)

addGadmGidFilter

public void addGadmGidFilter(String gadmGid)

addGadmLevel0GidFilter

public void addGadmLevel0GidFilter(String gadm0)

addGadmLevel1GidFilter

public void addGadmLevel1GidFilter(String gadm1)

addGadmLevel2GidFilter

public void addGadmLevel2GidFilter(String gadm2)

addGadmLevel3GidFilter

public void addGadmLevel3GidFilter(String gadm3)

addInstitutionKeyFilter

@Experimental
public void addInstitutionKeyFilter(String institutionKey)

addCollectionKeyFilter

@Experimental
public void addCollectionKeyFilter(String collectionKey)