Package org.gbif.api.service.occurrence

Interface OccurrenceSearchService

All Superinterfaces:

SearchService<Occurrence,OccurrenceSearchParameter,OccurrenceSearchRequest>

public interface OccurrenceSearchService
extends SearchService<Occurrence,OccurrenceSearchParameter,OccurrenceSearchRequest>

Interface that provides search operations over Occurrences. As the occurrence Solr index doesn't store values we use the full Occurrence class for search responses as we need to do lookups by key anyways.

Method Summary

Modifier and Type	Method	Description
SearchResponse<Occurrence,OccurrenceSearchParameter>	search(OccurrencePredicateSearchRequest request)	Occurrence search implementation that uses a predicate instead of request parameters.
List<String>	suggestCatalogNumbers(@Min(1L) String prefix, Integer limit)	Searches catalog numbers which start with the input prefix.
List<String>	suggestCollectionCodes(@Min(1L) String prefix, Integer limit)	Searches collection codes which start with the input prefix.
List<String>	suggestDatasetName(@Min(1L) String prefix, Integer limit)	Searches dataset names which start with the input prefix.
List<String>	suggestEventId(@Min(1L) String prefix, Integer limit)	Searches DwC eventIds which start with the input prefix.
List<String>	suggestIdentifiedBy(@Min(1L) String prefix, Integer limit)	Searches collector names (dwc:identifiedBy) which start with the input prefix.
List<String>	suggestInstitutionCodes(@Min(1L) String prefix, Integer limit)	Searches institution codes which start with the input prefix.
List<String>	suggestLocalities(@Min(1L) String prefix, Integer limit)	Searches DwC localities which start with the input prefix.
List<String>	suggestOccurrenceIds(@Min(1L) String prefix, Integer limit)	Searches DwC occurrenceIds which start with the input prefix.
List<String>	suggestOrganismIds(@Min(1L) String prefix, Integer limit)	Searches DwC organismsIds which start with the input prefix.
List<String>	suggestOtherCatalogNumbers(@Min(1L) String prefix, Integer limit)	Searches other catalog numbers which start with the input prefix.
List<String>	suggestParentEventId(@Min(1L) String prefix, Integer limit)	Searches DwC parentEventIds which start with the input prefix.
List<String>	suggestRecordedBy(@Min(1L) String prefix, Integer limit)	Searches collector names (dwc:recordedBy) which start with the input prefix.
List<String>	suggestRecordNumbers(@Min(1L) String prefix, Integer limit)	Searches record numbers which start with the input prefix.
List<String>	suggestSamplingProtocol(@Min(1L) String prefix, Integer limit)	Searches DwC sampling protocols which start with the input prefix.
List<String>	suggestStateProvinces(@Min(1L) String prefix, Integer limit)	Searches DwC state/provinces which start with the input prefix.
List<String>	suggestWaterBodies(@Min(1L) String prefix, Integer limit)	Searches DwC water bodies which start with the input prefix.

Methods inherited from interface org.gbif.api.service.common.SearchService

search

Method Detail

search

SearchResponse<Occurrence,OccurrenceSearchParameter> search(OccurrencePredicateSearchRequest request)

Occurrence search implementation that uses a predicate instead of request parameters.

suggestCatalogNumbers

List<String> suggestCatalogNumbers(@Min(1L)
                                   @Min(1L) String prefix,
                                   @Nullable
                                   Integer limit)

Searches catalog numbers which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of catalog numbers

suggestCollectionCodes

List<String> suggestCollectionCodes(@Min(1L)
                                    @Min(1L) String prefix,
                                    @Nullable
                                    Integer limit)

Searches collection codes which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of collection names

suggestRecordedBy

List<String> suggestRecordedBy(@Min(1L)
                               @Min(1L) String prefix,
                               @Nullable
                               Integer limit)

Searches collector names (dwc:recordedBy) which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of collector names

suggestIdentifiedBy

List<String> suggestIdentifiedBy(@Min(1L)
                                 @Min(1L) String prefix,
                                 @Nullable
                                 Integer limit)

Searches collector names (dwc:identifiedBy) which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of collector names

suggestRecordNumbers

List<String> suggestRecordNumbers(@Min(1L)
                                  @Min(1L) String prefix,
                                  @Nullable
                                  Integer limit)

Searches record numbers which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of collector names

suggestInstitutionCodes

List<String> suggestInstitutionCodes(@Min(1L)
                                     @Min(1L) String prefix,
                                     @Nullable
                                     Integer limit)

Searches institution codes which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of institution codes

suggestOccurrenceIds

List<String> suggestOccurrenceIds(@Min(1L)
                                  @Min(1L) String prefix,
                                  @Nullable
                                  Integer limit)

Searches DwC occurrenceIds which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of occurrenceIds

suggestOrganismIds

List<String> suggestOrganismIds(@Min(1L)
                                @Min(1L) String prefix,
                                @Nullable
                                Integer limit)

Searches DwC organismsIds which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of organismIds

suggestLocalities

List<String> suggestLocalities(@Min(1L)
                               @Min(1L) String prefix,
                               @Nullable
                               Integer limit)

Searches DwC localities which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of localities

suggestWaterBodies

List<String> suggestWaterBodies(@Min(1L)
                                @Min(1L) String prefix,
                                @Nullable
                                Integer limit)

Searches DwC water bodies which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of water bodies

suggestStateProvinces

List<String> suggestStateProvinces(@Min(1L)
                                   @Min(1L) String prefix,
                                   @Nullable
                                   Integer limit)

Searches DwC state/provinces which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of state provinces

suggestSamplingProtocol

List<String> suggestSamplingProtocol(@Min(1L)
                                     @Min(1L) String prefix,
                                     @Nullable
                                     Integer limit)

Searches DwC sampling protocols which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of state provinces

suggestEventId

List<String> suggestEventId(@Min(1L)
                            @Min(1L) String prefix,
                            @Nullable
                            Integer limit)

Searches DwC eventIds which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of state provinces

suggestParentEventId

List<String> suggestParentEventId(@Min(1L)
                                  @Min(1L) String prefix,
                                  @Nullable
                                  Integer limit)

Searches DwC parentEventIds which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of state provinces

suggestOtherCatalogNumbers

List<String> suggestOtherCatalogNumbers(@Min(1L)
                                        @Min(1L) String prefix,
                                        @Nullable
                                        Integer limit)

Searches other catalog numbers which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of other catalog numbers

suggestDatasetName

List<String> suggestDatasetName(@Min(1L)
                                @Min(1L) String prefix,
                                @Nullable
                                Integer limit)

Searches dataset names which start with the input prefix. If the limit is set to a number less than 0, then no maximum limit is enforced. If limit contains a null value, a default value is set by the service implementation.

Parameters:

prefix - search pattern

limit - maximum number of results to return

Returns:

of dataset names