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
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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
addBasisOfRecordFilter
(BasisOfRecord basisOfRecord) void
addBiostratigraphyFilter
(String biostratigraphy) 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
addDayFilter
(int day) void
addDecimalLatitudeFilter
(double latitude) void
addDecimalLongitudeFilter
(double longitude) void
addDnaSequenceIDFilter
(String dnaSequenceID) void
addElevationFilter
(double elevation) void
addEstablishmentMeansFilter
(String establishmentMeans) void
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
addGeologicalTimeFilter
(String geologicalTimeConcept) void
addGeometryFilter
(String geometryAsWkt) void
addHasCoordinateFilter
(boolean hasCoordinate) void
addIdentifiedByFilter
(String collectorName) void
addIdentifiedByIdsFilter
(String identifiedByIds) void
void
addInstitutionKeyFilter
(String institutionKey) void
addIssueFilter
(OccurrenceIssue issue) void
addKingdomKeyFilter
(int kingdomKey) void
addLastInterpretedFilter
(Date modified) void
addLithostratigraphyFilter
(String lithostratigraphy) 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
(String typeStatus) void
addYearFilter
(int year) This flag allows to sort the results in a random order by specifying a seed.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, 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
-
OccurrenceSearchRequest
public OccurrenceSearchRequest() -
OccurrenceSearchRequest
-
OccurrenceSearchRequest
-
-
Method Details
-
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.
-
setMatchCase
-
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
-
addOccurrenceIDFilter
-
addEstablishmentMeansFilter
-
addBasisOfRecordFilter
-
addTypeStatusFilter
-
addCatalogNumberFilter
-
addRecordedByFilter
-
addIdentifiedByFilter
-
addRecordNumberFilter
-
addCountryFilter
-
addContinentFilter
-
addDatasetKeyFilter
-
addGeometryFilter
-
addDecimalLatitudeFilter
-
addDecimalLongitudeFilter
-
addCoordinateUncertaintyInMetersFilter
-
addMonthFilter
-
addDayFilter
-
addTaxonKeyFilter
-
addKingdomKeyFilter
-
addPhylumKeyFilter
-
addClassKeyFilter
-
addOrderKeyFilter
-
addFamilyKeyFilter
-
addGenusKeyFilter
-
addSubGenusKeyFilter
-
addSpeciesKeyFilter
-
addYearFilter
-
addEventDateFilter
-
addLastInterpretedFilter
-
addPublishingCountryFilter
-
addInstitutionCodeFilter
-
addHasCoordinateFilter
-
addSpatialIssueFilter
-
addIssueFilter
-
addElevationFilter
-
addMediaTypeFilter
-
addRecordedByIdsFilter
-
addIdentifiedByIdsFilter
-
addOccurrenceStatusFilter
-
addGadmGidFilter
-
addGadmLevel0GidFilter
-
addGadmLevel1GidFilter
-
addGadmLevel2GidFilter
-
addGadmLevel3GidFilter
-
addGeologicalTimeFilter
-
addLithostratigraphyFilter
-
addBiostratigraphyFilter
-
addInstitutionKeyFilter
-
addCollectionKeyFilter
-
addDnaSequenceIDFilter
-