Package org.gbif.api.model.occurrence.search

Enum Class OccurrenceSearchParameter

java.lang.Object
java.lang.Enum<OccurrenceSearchParameter>
org.gbif.api.model.occurrence.search.OccurrenceSearchParameter
All Implemented Interfaces:
Serializable, Comparable<OccurrenceSearchParameter>, Constable, SearchParameter
public enum OccurrenceSearchParameter extends Enum<OccurrenceSearchParameter> implements SearchParameter
Supported query parameters by the occurrence search and download service. For download predicates only the numerical types support comparisons other than equals.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    ACCEPTED_TAXON_KEY
    A taxon key from the GBIF backbone for the name usage of the currently valid or accepted taxon.
    ASSOCIATED_SEQUENCES
    A list (concatenated and separated) of identifiers (publication, global unique identifier, URI) of genetic sequence information associated with the material entity.
    BASIS_OF_RECORD
    A basis of record enumeration value.
    BED
    The full name of the lithostratigraphic bed from which the MaterialEntity was collected.
    BIOSTRATIGRAPHY
    Searchs in the biostratigraphy fields(lowest and highest biostratigraphy).
    CATALOG_NUMBER
    An identifier of any form assigned by the source within a physical collection or digital dataset for the record which may not be unique, but should be fairly unique in combination with the institution and collection code.
    CLASS_KEY
    A class key from the GBIF backbone.
    COLLECTION_CODE
    An identifier of any form assigned by the source to identify the physical collection or digital dataset uniquely within the context of an institution.
    COLLECTION_KEY
    Collection key.
    CONTINENT
    Continent the occurrence was recorded in.
    COORDINATE_UNCERTAINTY_IN_METERS
    The uncertainty of the coordinate in meters.
    COUNTRY
    Country the occurrence was recorded in.
    CRAWL_ID
    Crawl attempt that harvested this record.
    DATASET_ID
    The dwc dataset id.
    DATASET_KEY
    The dataset key as a UUID.
    DATASET_NAME
    The dwc dataset name.
    DECIMAL_LATITUDE
    Latitude in decimals between -90 and 90 based on WGS 84.
    DECIMAL_LONGITUDE
    Longitude in decimals between -180 and 180 based on WGS 84.
    DEGREE_OF_ESTABLISHMENT
    Provides the controlled vocabulary for information about degree to which an Organism survives, reproduces, and expands its range at the given place and time.
    DEPTH
    Depth in meters relative to altitude.
    DISTANCE_FROM_CENTROID_IN_METERS
    The distance from a known centroid, e.g.
    DWCA_EXTENSION
    Searches for occurrences that have a particular DwC-A extension.
    EARLIEST_AGE_OR_LOWEST_STAGE
    The full name of the earliest possible geochronologic age or lowest chronostratigraphic stage attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    EARLIEST_EON_OR_LOWEST_EONOTHEM
    The full name of the earliest possible geochronologic eon or lowest chrono-stratigraphic eonothem or the informal name ("Precambrian") attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    EARLIEST_EPOCH_OR_LOWEST_SERIES
    The full name of the earliest possible geochronologic epoch or lowest chronostratigraphic series attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    EARLIEST_ERA_OR_LOWEST_ERATHEM
    The full name of the earliest possible geochronologic era or lowest chronostratigraphic erathem attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    EARLIEST_PERIOD_OR_LOWEST_SYSTEM
    The full name of the earliest possible geochronologic period or lowest chronostratigraphic system attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    ELEVATION
    Altitude/elevation in meters above sea level.
    END_DAY_OF_YEAR
    The latest integer day of the year on which the event occurred (1 for January 1, 365 for December 31, except in a leap year, in which case it is 366).
    ESTABLISHMENT_MEANS
    The process by which the biological individual(s) represented in the Occurrence became established at the location.
    EVENT_DATE
    Event date (date the occurrence was recorded) in ISO 8601 formats:yyyy, yyyy-MM, yyyy-MM-dd and MM-dd.
    EVENT_DATE_GTE
    Deprecated.
    EVENT_ID
    An identifier for the set of information associated with an Event (something that occurs at a place and time).
    FAMILY_KEY
    A family key from the GBIF backbone.
    FIELD_NUMBER
    An identifier given to the event in the field.
    FORMATION
    The full name of the lithostratigraphic formation from which the MaterialEntity was collected.
    GADM_GID
    A GADM identifier at any level.
    GADM_LEVEL_0_GID
    A GADM country, island or territory (level zero) identifier.
    GADM_LEVEL_1_GID
    A GADM first-level identifier.
    GADM_LEVEL_2_GID
    A GADM second-level identifier.
    GADM_LEVEL_3_GID
    A GADM third-level identifier.
    GBIF_ID
    Unique GBIF key for the occurrence.
    GBIF_REGION
    GBIF region based on country
    GENUS_KEY
    A genus key from the GBIF backbone.
    GEO_DISTANCE
    Use in combination of LATITUDE and LONGITUDE parameters matches within a given distance.
    GEOLOGICAL_TIME
    Geological time of an occurrence that searchs in the chronostratigraphy fields.
    GEOMETRY
    Geometry in Well Known Text (WKT) format.
    GEOREFERENCED_BY
    A list (concatenated and separated) of names of people, groups, or organizations who determined the georeference (spatial representation) for the location.
    GROUP
    The full name of the lithostratigraphic group from which the MaterialEntity was collected.
    HAS_COORDINATE
    Searches for occurrence records which contain a value on its coordinate fields (latitude and longitude).
    HAS_GEOSPATIAL_ISSUE
    Includes/excludes occurrence records which contain geospatial issues for their coordinate.
    HIGHER_GEOGRAPHY
    A list (concatenated and separated) of geographic names less specific than the information captured in the locality term.
    HIGHEST_BIOSTRATIGRAPHIC_ZONE
    The full name of the highest possible geological biostratigraphic zone of the stratigraphic horizon from which the MaterialEntity was collected.
    HOSTING_ORGANIZATION_KEY
    The organization key of the installation that hosts this record.
    IDENTIFIED_BY
    The person who identified the occurrence.
    IDENTIFIED_BY_ID
    Agent identifiers from GbifTerm.identifiedByID
    INSTALLATION_KEY
    The technical installation key that hosts/publishes this record.
    INSTITUTION_CODE
    An identifier of any form assigned by the source to identify the institution the record belongs to.
    INSTITUTION_KEY
    Institution key.
    IS_IN_CLUSTER
    Searches for occurrences that are clustered.
    IS_SEQUENCED
    Presents of associated sequences or an extension
    ISLAND
    The name of the island on or near which the location occurs.
    ISLAND_GROUP
    The name of the island group in which the location occurs.
    ISSUE
    Searches occurrence for those that have a specific issue.
    IUCN_RED_LIST_CATEGORY
    Searches for occurrences that have a IUCN Red List Category.
    KINGDOM_KEY
    A kingdom key from the GBIF backbone.
    LAST_INTERPRETED
    Last interpreted date in ISO 8601 formats:yyyy, yyyy-MM, yyyy-MM-dd and MM-dd.
    LATEST_AGE_OR_HIGHEST_STAGE
    The full name of the latest possible geochronologic age or highest chronostratigraphic stage attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    LATEST_EON_OR_HIGHEST_EONOTHEM
    The full name of the latest possible geochronologic eon or highest chrono-stratigraphic eonothem or the informal name ("Precambrian") attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    LATEST_EPOCH_OR_HIGHEST_SERIES
    The full name of the latest possible geochronologic epoch or highest chronostratigraphic series attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    LATEST_ERA_OR_HIGHEST_ERATHEM
    The full name of the latest possible geochronologic era or highest chronostratigraphic erathem attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    LATEST_PERIOD_OR_HIGHEST_SYSTEM
    The full name of the latest possible geochronologic period or highest chronostratigraphic system attributable to the stratigraphic horizon from which the MaterialEntity was collected.
    LICENSE
    The license applied to the dataset.
    LIFE_STAGE
    The life stage of an occurrence.
    LITHOSTRATIGRAPHY
    Searchs in the lithostratigraphy fields(bed, formation, group, member).
    LOCALITY
    The specific description of the place.
    LOWEST_BIOSTRATIGRAPHIC_ZONE
    The full name of the lowest possible geological biostratigraphic zone of the stratigraphic horizon from which the MaterialEntity was collected.
    MEDIA_TYPE
    The kind of media object.
    MEMBER
    The full name of the lithostratigraphic member from which the MaterialEntity was collected.
    MODIFIED
    Modified date in ISO 8601 formats:yyyy, yyyy-MM, yyyy-MM-dd and MM-dd.
    MONTH
    The month of the year, starting with 1 for January.
    NETWORK_KEY
    The GBIF network that the publishing organisation belongs to.
    OCCURRENCE_ID
    An identifier for the Occurrence (as opposed to a particular digital record of the occurrence).
    OCCURRENCE_STATUS
    An occurrence status enumeration value.
    ORDER_KEY
    A order key from the GBIF backbone.
    ORGANISM_ID
    An identifier for the Organism instance (as opposed to a particular digital record of the Organism).
    ORGANISM_QUANTITY
    A number or enumeration value for the quantity of organisms.
    ORGANISM_QUANTITY_TYPE
    The type of quantification system used for the quantity of organisms.
    OTHER_CATALOG_NUMBERS
    Other catalog numbers associated to an occurrence.
    PARENT_EVENT_ID
    An identifier for the broader Event that groups this and potentially other Events.
    PATHWAY
    Provides the controlled vocabulary for information about the process by which an Organism came to be in a given place at a given time.
    PHYLUM_KEY
    A phylum key from the GBIF backbone.
    PREPARATIONS
    Preparations methods of an occurrence.
    PREVIOUS_IDENTIFICATIONS
    A list (concatenated and separated) of previous assignments of names to the organism.
    PROGRAMME
    GBIF Programme Acronym.
    PROJECT_ID
    GBIF ProjectId.
    PROTOCOL
    Protocol used to provide the occurrence record.
    PUBLISHED_BY_GBIF_REGION
    GBIF region based on publishibg country
    PUBLISHING_COUNTRY
    The country of the organization that publishes the dataset the occurrence belongs to.
    PUBLISHING_ORG
    The owning organizations uuid key.
    RECORD_NUMBER
    An identifier given to the Occurrence at the time it was recorded.
    RECORDED_BY
    The person who recorded the occurrence.
    RECORDED_BY_ID
    Agent identifiers from GbifTerm.recordedByID
    RELATIVE_ORGANISM_QUANTITY
    Calculated organismQuantity relative to the sampleSizeValue i.e.
    REPATRIATED
    Searches for records whose publishing country is different to the country where the record was recorded in.
    SAMPLE_SIZE_UNIT
    The unit of measurement of the size (time duration, length, area, or volume) of a sample in a sampling event.
    SAMPLE_SIZE_VALUE
    A numeric value for a measurement of the size (time duration, length, area, or volume) of a sample in a sampling event.
    SAMPLING_PROTOCOL
    The name of, reference to, or description of the method or protocol used during an Event.
    SCIENTIFIC_NAME
    Searches the interpreted, full scientific name of the occurrence.
    SEX
    The sex of the biological individual(s) represented in the occurrence.
    SPECIES_KEY
    A species key from the GBIF backbone.
    START_DAY_OF_YEAR
    The earliest integer day of the year on which the event occurred (1 for January 1, 365 for December 31, except in a leap year, in which case it is 366).
    STATE_PROVINCE
    The name of the next smaller administrative region than country in which the Location occurs.
    SUBGENUS_KEY
    A subgenus key from the GBIF backbone.
    TAXON_CONCEPT_ID
    An identifier for the taxonomic concept to which the record refers - not for the nomenclatural details of a taxon.
    TAXON_ID
    Verbatim identifier for the set of taxon information.
    TAXON_KEY
    A taxon key from the GBIF backbone.
    TAXONOMIC_STATUS
    The status of the use of the GBIF Backbone taxonKey.
    TYPE_STATUS
    Nomenclatural type (type status, typified scientific name, publication) applied to the subject.
    VERBATIM_SCIENTIFIC_NAME
    Scientific name as provided byt the source.
    WATER_BODY
    The name of the water body in which the Location occurs.
    YEAR
    The 4 digit year.

  • Method Summary

    Modifier and Type
    Method
    Description
    Class<?>
    type()
     
    static OccurrenceSearchParameter
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OccurrenceSearchParameter[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.gbif.api.model.common.search.SearchParameter

    name