Enum OccurrenceSearchParameter
- java.lang.Object
-
- java.lang.Enum<OccurrenceSearchParameter>
-
- org.gbif.api.model.occurrence.search.OccurrenceSearchParameter
-
- All Implemented Interfaces:
Serializable
,Comparable<OccurrenceSearchParameter>
,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.
-
-
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 countryGENUS_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.identifiedByIDINSTALLATION_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 extensionISLAND
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 countryPUBLISHING_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.recordedByIDRELATIVE_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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Class<?>
type()
static OccurrenceSearchParameter
valueOf(String name)
Returns the enum constant of this type with the specified name.static OccurrenceSearchParameter[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface org.gbif.api.model.common.search.SearchParameter
name
-
-
-
-
Enum Constant Detail
-
DATASET_KEY
public static final OccurrenceSearchParameter DATASET_KEY
The dataset key as a UUID.
-
YEAR
public static final OccurrenceSearchParameter YEAR
The 4 digit year. A year of 98 will be 98 common era, not 1998. This parameter accepts comma separated range values, e.g.:- *,1810
- Found before or equal to 1810
- 1848,1933
- Year between 1848 and 1933
-
MONTH
public static final OccurrenceSearchParameter MONTH
The month of the year, starting with 1 for January. A month query can be used to retrieve seasonal records when used without a year or a year range. This parameter accepts comma separated range values, e.g.:- 4,8
- Month between April and August
-
START_DAY_OF_YEAR
public static final OccurrenceSearchParameter 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).
-
END_DAY_OF_YEAR
public static final OccurrenceSearchParameter 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).
-
EVENT_DATE
public static final OccurrenceSearchParameter EVENT_DATE
Event date (date the occurrence was recorded) in ISO 8601 formats:yyyy, yyyy-MM, yyyy-MM-dd and MM-dd. This parameter accepts comma separated range values, examples of valid ranges are:- 2001-02-11,2010-01-10
- Dates between 2001-02-11 and 2010-01-10
- 2001-02,2010-01
- Dates between first day of 2001-02 and last day of 2010-01
- 2001,2010
- Dates between first day of 2001 and last day of 2010
- 2001,2010-01
- Dates between first day of 2001 and last day of 2010-01
- 2001-01-10,2010
- Dates between 2001-01-10 and last day of 2010
- 2001-01-10,*
- Dates after 2001-01-10
- *,2001-01-10
- Dates before 2001-01-10
- *
- all dates
-
EVENT_DATE_GTE
@Deprecated public static final OccurrenceSearchParameter EVENT_DATE_GTE
Deprecated.Lower limit for the range of the event date (date the occurrence was recorded). Included for backward compatibility as it mimicks the previous search behaviour: https://github.com/gbif/occurrence/issues/346
-
EVENT_ID
public static final OccurrenceSearchParameter EVENT_ID
An identifier for the set of information associated with an Event (something that occurs at a place and time). Maybe a global unique identifier or an identifier specific to the data set.
-
PARENT_EVENT_ID
public static final OccurrenceSearchParameter PARENT_EVENT_ID
An identifier for the broader Event that groups this and potentially other Events.
-
SAMPLING_PROTOCOL
public static final OccurrenceSearchParameter SAMPLING_PROTOCOL
The name of, reference to, or description of the method or protocol used during an Event.
-
PREVIOUS_IDENTIFICATIONS
public static final OccurrenceSearchParameter PREVIOUS_IDENTIFICATIONS
A list (concatenated and separated) of previous assignments of names to the organism.
-
LAST_INTERPRETED
public static final OccurrenceSearchParameter LAST_INTERPRETED
Last interpreted date in ISO 8601 formats:yyyy, yyyy-MM, yyyy-MM-dd and MM-dd. This parameter accepts comma separated range values, examples of valid ranges are:- 2001-02-11,2010-01-10
- Dates between 2001-02-11 and 2010-01-10
- 2001-02,2010-01
- Dates between first day of 2001-02 and last day of 2010-01
- 2001,2010
- Dates between first day of 2001 and last day of 2010
- 2001,2010-01
- Dates between first day of 2001 and last day of 2010-01
- 2001-01-10,2010
- Dates between 2001-01-10 and last day of 2010
- 2001-01-10,*
- Dates after 2001-01-10
- *,2001-01-10
- Dates before 2001-01-10
- *
- all dates
-
MODIFIED
public static final OccurrenceSearchParameter MODIFIED
Modified date in ISO 8601 formats:yyyy, yyyy-MM, yyyy-MM-dd and MM-dd. This parameter accepts comma separated range values, examples of valid ranges are:- 2001-02-11,2010-01-10
- Dates between 2001-02-11 and 2010-01-10
- 2001-02,2010-01
- Dates between first day of 2001-02 and last day of 2010-01
- 2001,2010
- Dates between first day of 2001 and last day of 2010
- 2001,2010-01
- Dates between first day of 2001 and last day of 2010-01
- 2001-01-10,2010
- Dates between 2001-01-10 and last day of 2010
- 2001-01-10,*
- Dates after 2001-01-10
- *,2001-01-10
- Dates before 2001-01-10
- *
- all dates
-
DECIMAL_LATITUDE
public static final OccurrenceSearchParameter DECIMAL_LATITUDE
Latitude in decimals between -90 and 90 based on WGS 84.
-
DECIMAL_LONGITUDE
public static final OccurrenceSearchParameter DECIMAL_LONGITUDE
Longitude in decimals between -180 and 180 based on WGS 84.
-
COORDINATE_UNCERTAINTY_IN_METERS
public static final OccurrenceSearchParameter COORDINATE_UNCERTAINTY_IN_METERS
The uncertainty of the coordinate in meters. This parameter accepts comma separated range values, e.g.:- *,100
- Uncertainty below or equals 100m
- 10000,*
- Uncertainty above or equals 10,000m
- 1000,5000
- Uncertainty between or equals 1000m and 5000m
-
COUNTRY
public static final OccurrenceSearchParameter COUNTRY
Country the occurrence was recorded in.
-
GBIF_REGION
public static final OccurrenceSearchParameter GBIF_REGION
GBIF region based on country
-
CONTINENT
public static final OccurrenceSearchParameter CONTINENT
Continent the occurrence was recorded in.
-
PUBLISHING_COUNTRY
public static final OccurrenceSearchParameter PUBLISHING_COUNTRY
The country of the organization that publishes the dataset the occurrence belongs to.
-
PUBLISHED_BY_GBIF_REGION
public static final OccurrenceSearchParameter PUBLISHED_BY_GBIF_REGION
GBIF region based on publishibg country
-
ELEVATION
public static final OccurrenceSearchParameter ELEVATION
Altitude/elevation in meters above sea level. This parameter accepts comma separated range values, e.g.:- *,100
- Altitude below or equals 100m
- 100,*
- Altitude above or equals 100m
- -2,8.8
- Altitude between or equals -2m and 8.8m
-
DEPTH
public static final OccurrenceSearchParameter DEPTH
Depth in meters relative to altitude. For example 10 meters below a lake surface with given altitude. This parameter accepts comma separated range values, e.g.:- *,10
- Depth below or equals 10m
- 100,*
- Depth above or equals 100m
- 12.1,28.8
- Depth between or equals 12.1m and 28.8m
-
INSTITUTION_CODE
public static final OccurrenceSearchParameter INSTITUTION_CODE
An identifier of any form assigned by the source to identify the institution the record belongs to. Not guaranteed to be unique.
-
COLLECTION_CODE
public static final OccurrenceSearchParameter 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.
-
CATALOG_NUMBER
public static final OccurrenceSearchParameter 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.
-
RECORDED_BY
public static final OccurrenceSearchParameter RECORDED_BY
The person who recorded the occurrence.
-
IDENTIFIED_BY
public static final OccurrenceSearchParameter IDENTIFIED_BY
The person who identified the occurrence.
-
RECORD_NUMBER
public static final OccurrenceSearchParameter RECORD_NUMBER
An identifier given to the Occurrence at the time it was recorded.
-
BASIS_OF_RECORD
public static final OccurrenceSearchParameter BASIS_OF_RECORD
A basis of record enumeration value.
-
SEX
public static final OccurrenceSearchParameter SEX
The sex of the biological individual(s) represented in the occurrence.
-
IS_SEQUENCED
public static final OccurrenceSearchParameter IS_SEQUENCED
Presents of associated sequences or an extension
-
TAXON_KEY
public static final OccurrenceSearchParameter TAXON_KEY
A taxon key from the GBIF backbone. All included and synonym taxa are included in the search, so a search for aves with taxonKey=212 will match all birds, no matter which species.
-
ACCEPTED_TAXON_KEY
public static final OccurrenceSearchParameter ACCEPTED_TAXON_KEY
A taxon key from the GBIF backbone for the name usage of the currently valid or accepted taxon.
-
KINGDOM_KEY
public static final OccurrenceSearchParameter KINGDOM_KEY
A kingdom key from the GBIF backbone.
-
PHYLUM_KEY
public static final OccurrenceSearchParameter PHYLUM_KEY
A phylum key from the GBIF backbone.
-
CLASS_KEY
public static final OccurrenceSearchParameter CLASS_KEY
A class key from the GBIF backbone.
-
ORDER_KEY
public static final OccurrenceSearchParameter ORDER_KEY
A order key from the GBIF backbone.
-
FAMILY_KEY
public static final OccurrenceSearchParameter FAMILY_KEY
A family key from the GBIF backbone.
-
GENUS_KEY
public static final OccurrenceSearchParameter GENUS_KEY
A genus key from the GBIF backbone.
-
SUBGENUS_KEY
public static final OccurrenceSearchParameter SUBGENUS_KEY
A subgenus key from the GBIF backbone.
-
SPECIES_KEY
public static final OccurrenceSearchParameter SPECIES_KEY
A species key from the GBIF backbone.
-
SCIENTIFIC_NAME
public static final OccurrenceSearchParameter SCIENTIFIC_NAME
Searches the interpreted, full scientific name of the occurrence.
-
VERBATIM_SCIENTIFIC_NAME
public static final OccurrenceSearchParameter VERBATIM_SCIENTIFIC_NAME
Scientific name as provided byt the source.
-
TAXON_ID
public static final OccurrenceSearchParameter TAXON_ID
Verbatim identifier for the set of taxon information. Maybe a global unique identifier or an identifier specific to the data set.
-
TAXON_CONCEPT_ID
public static final OccurrenceSearchParameter TAXON_CONCEPT_ID
An identifier for the taxonomic concept to which the record refers - not for the nomenclatural details of a taxon.
-
TAXONOMIC_STATUS
public static final OccurrenceSearchParameter TAXONOMIC_STATUS
The status of the use of the GBIF Backbone taxonKey.
-
HAS_COORDINATE
public static final OccurrenceSearchParameter HAS_COORDINATE
Searches for occurrence records which contain a value on its coordinate fields (latitude and longitude). HAS_COORDINATE=true searches for occurrence records with a coordinate value. HAS_COORDINATE=false searches for occurrence records without a coordinate value.
-
GEOMETRY
public static final OccurrenceSearchParameter GEOMETRY
Geometry in Well Known Text (WKT) format. E.g.: POLYGON ((30.0 10.0, 10.12 20.23, 20 40, 40 40, 30 10)). Multi geometries like MULTIPOLYGON are not supported and multiple parameters should be used instead. Valid geometries are:- POINT
- LINESTRING
- POLYGON
- LINEARRING
-
GEO_DISTANCE
public static final OccurrenceSearchParameter GEO_DISTANCE
Use in combination of LATITUDE and LONGITUDE parameters matches within a given distance. E.g.: geo_distance=100m,40,90 geo_distance=100km,40,90 geo_distance=100mi,40,90. See supported units inDistanceUnit
.
-
DISTANCE_FROM_CENTROID_IN_METERS
public static final OccurrenceSearchParameter DISTANCE_FROM_CENTROID_IN_METERS
The distance from a known centroid, e.g. a country centroid.
-
HAS_GEOSPATIAL_ISSUE
public static final OccurrenceSearchParameter HAS_GEOSPATIAL_ISSUE
Includes/excludes occurrence records which contain geospatial issues for their coordinate. SeeOccurrenceIssue.GEOSPATIAL_RULES
HAS_GEOSPATIAL_ISSUE=true include records with spatial issues. HAS_GEOSPATIAL_ISSUE=false exclude records with spatial issues. The absence of this parameter returns any record with or without spatial issues.
-
ISSUE
public static final OccurrenceSearchParameter ISSUE
Searches occurrence for those that have a specific issue.
-
TYPE_STATUS
public static final OccurrenceSearchParameter TYPE_STATUS
Nomenclatural type (type status, typified scientific name, publication) applied to the subject.
-
MEDIA_TYPE
public static final OccurrenceSearchParameter MEDIA_TYPE
The kind of media object. Recommended terms from the DCMI Type Vocabulary are StillImage, Sound or MovingImage for GBIF to index and show the media files.
-
OCCURRENCE_ID
public static final OccurrenceSearchParameter OCCURRENCE_ID
An identifier for the Occurrence (as opposed to a particular digital record of the occurrence). In the absence of a persistent global unique identifier, construct one from a combination of identifiers in the record that will most closely make the occurrenceID globally unique.
-
ESTABLISHMENT_MEANS
public static final OccurrenceSearchParameter ESTABLISHMENT_MEANS
The process by which the biological individual(s) represented in the Occurrence became established at the location.
-
DEGREE_OF_ESTABLISHMENT
public static final OccurrenceSearchParameter 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.
-
PATHWAY
public static final OccurrenceSearchParameter 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. The pathway of an organism or organisms have been introduced to a given place and time.
-
REPATRIATED
public static final OccurrenceSearchParameter REPATRIATED
Searches for records whose publishing country is different to the country where the record was recorded in.
-
ORGANISM_ID
public static final OccurrenceSearchParameter ORGANISM_ID
An identifier for the Organism instance (as opposed to a particular digital record of the Organism). May be a globally unique identifier or an identifier specific to the data set.
-
STATE_PROVINCE
public static final OccurrenceSearchParameter STATE_PROVINCE
The name of the next smaller administrative region than country in which the Location occurs.
-
WATER_BODY
public static final OccurrenceSearchParameter WATER_BODY
The name of the water body in which the Location occurs.
-
LOCALITY
public static final OccurrenceSearchParameter LOCALITY
The specific description of the place. It may contain information modified from the original to correct perceived errors or standardize the description.
-
PROTOCOL
public static final OccurrenceSearchParameter PROTOCOL
Protocol used to provide the occurrence record.
-
LICENSE
public static final OccurrenceSearchParameter LICENSE
The license applied to the dataset.
-
PUBLISHING_ORG
public static final OccurrenceSearchParameter PUBLISHING_ORG
The owning organizations uuid key.
-
NETWORK_KEY
public static final OccurrenceSearchParameter NETWORK_KEY
The GBIF network that the publishing organisation belongs to.
-
INSTALLATION_KEY
public static final OccurrenceSearchParameter INSTALLATION_KEY
The technical installation key that hosts/publishes this record.
-
HOSTING_ORGANIZATION_KEY
public static final OccurrenceSearchParameter HOSTING_ORGANIZATION_KEY
The organization key of the installation that hosts this record.
-
CRAWL_ID
public static final OccurrenceSearchParameter CRAWL_ID
Crawl attempt that harvested this record.
-
PROJECT_ID
public static final OccurrenceSearchParameter PROJECT_ID
GBIF ProjectId.
-
PROGRAMME
public static final OccurrenceSearchParameter PROGRAMME
GBIF Programme Acronym.
-
ORGANISM_QUANTITY
public static final OccurrenceSearchParameter ORGANISM_QUANTITY
A number or enumeration value for the quantity of organisms.
-
ORGANISM_QUANTITY_TYPE
public static final OccurrenceSearchParameter ORGANISM_QUANTITY_TYPE
The type of quantification system used for the quantity of organisms.
-
SAMPLE_SIZE_UNIT
public static final OccurrenceSearchParameter 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
public static final OccurrenceSearchParameter 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.
-
RELATIVE_ORGANISM_QUANTITY
public static final OccurrenceSearchParameter RELATIVE_ORGANISM_QUANTITY
Calculated organismQuantity relative to the sampleSizeValue i.e. -> organismQuantity / sampleSizeValue.
-
COLLECTION_KEY
public static final OccurrenceSearchParameter COLLECTION_KEY
Collection key. It links to the collection to which this record belongs.
-
INSTITUTION_KEY
public static final OccurrenceSearchParameter INSTITUTION_KEY
Institution key. It links to the institution that maintains, recorded or digitized this record.
-
RECORDED_BY_ID
public static final OccurrenceSearchParameter RECORDED_BY_ID
Agent identifiers from GbifTerm.recordedByID
-
IDENTIFIED_BY_ID
public static final OccurrenceSearchParameter IDENTIFIED_BY_ID
Agent identifiers from GbifTerm.identifiedByID
-
OCCURRENCE_STATUS
public static final OccurrenceSearchParameter OCCURRENCE_STATUS
An occurrence status enumeration value.
-
GADM_GID
public static final OccurrenceSearchParameter GADM_GID
A GADM identifier at any level.
-
GADM_LEVEL_0_GID
public static final OccurrenceSearchParameter GADM_LEVEL_0_GID
A GADM country, island or territory (level zero) identifier.
-
GADM_LEVEL_1_GID
public static final OccurrenceSearchParameter GADM_LEVEL_1_GID
A GADM first-level identifier.
-
GADM_LEVEL_2_GID
public static final OccurrenceSearchParameter GADM_LEVEL_2_GID
A GADM second-level identifier.
-
GADM_LEVEL_3_GID
public static final OccurrenceSearchParameter GADM_LEVEL_3_GID
A GADM third-level identifier.
-
LIFE_STAGE
public static final OccurrenceSearchParameter LIFE_STAGE
The life stage of an occurrence.
-
IS_IN_CLUSTER
public static final OccurrenceSearchParameter IS_IN_CLUSTER
Searches for occurrences that are clustered.
-
DWCA_EXTENSION
public static final OccurrenceSearchParameter DWCA_EXTENSION
Searches for occurrences that have a particular DwC-A extension.
-
IUCN_RED_LIST_CATEGORY
public static final OccurrenceSearchParameter IUCN_RED_LIST_CATEGORY
Searches for occurrences that have a IUCN Red List Category.
-
DATASET_ID
public static final OccurrenceSearchParameter DATASET_ID
The dwc dataset id.
-
DATASET_NAME
public static final OccurrenceSearchParameter DATASET_NAME
The dwc dataset name.
-
OTHER_CATALOG_NUMBERS
public static final OccurrenceSearchParameter OTHER_CATALOG_NUMBERS
Other catalog numbers associated to an occurrence.
-
PREPARATIONS
public static final OccurrenceSearchParameter PREPARATIONS
Preparations methods of an occurrence.
-
ISLAND
public static final OccurrenceSearchParameter ISLAND
The name of the island on or near which the location occurs.
-
ISLAND_GROUP
public static final OccurrenceSearchParameter ISLAND_GROUP
The name of the island group in which the location occurs.
-
GEOREFERENCED_BY
public static final OccurrenceSearchParameter GEOREFERENCED_BY
A list (concatenated and separated) of names of people, groups, or organizations who determined the georeference (spatial representation) for the location.
-
HIGHER_GEOGRAPHY
public static final OccurrenceSearchParameter HIGHER_GEOGRAPHY
A list (concatenated and separated) of geographic names less specific than the information captured in the locality term.
-
FIELD_NUMBER
public static final OccurrenceSearchParameter FIELD_NUMBER
An identifier given to the event in the field. Often serves as a link between field notes and the event.
-
EARLIEST_EON_OR_LOWEST_EONOTHEM
public static final OccurrenceSearchParameter 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.
-
LATEST_EON_OR_HIGHEST_EONOTHEM
public static final OccurrenceSearchParameter 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.
-
EARLIEST_ERA_OR_LOWEST_ERATHEM
public static final OccurrenceSearchParameter 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.
-
LATEST_ERA_OR_HIGHEST_ERATHEM
public static final OccurrenceSearchParameter 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.
-
EARLIEST_PERIOD_OR_LOWEST_SYSTEM
public static final OccurrenceSearchParameter 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.
-
LATEST_PERIOD_OR_HIGHEST_SYSTEM
public static final OccurrenceSearchParameter 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.
-
EARLIEST_EPOCH_OR_LOWEST_SERIES
public static final OccurrenceSearchParameter 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.
-
LATEST_EPOCH_OR_HIGHEST_SERIES
public static final OccurrenceSearchParameter 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.
-
EARLIEST_AGE_OR_LOWEST_STAGE
public static final OccurrenceSearchParameter 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.
-
LATEST_AGE_OR_HIGHEST_STAGE
public static final OccurrenceSearchParameter 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.
-
LOWEST_BIOSTRATIGRAPHIC_ZONE
public static final OccurrenceSearchParameter LOWEST_BIOSTRATIGRAPHIC_ZONE
The full name of the lowest possible geological biostratigraphic zone of the stratigraphic horizon from which the MaterialEntity was collected.
-
HIGHEST_BIOSTRATIGRAPHIC_ZONE
public static final OccurrenceSearchParameter HIGHEST_BIOSTRATIGRAPHIC_ZONE
The full name of the highest possible geological biostratigraphic zone of the stratigraphic horizon from which the MaterialEntity was collected.
-
GROUP
public static final OccurrenceSearchParameter GROUP
The full name of the lithostratigraphic group from which the MaterialEntity was collected.
-
FORMATION
public static final OccurrenceSearchParameter FORMATION
The full name of the lithostratigraphic formation from which the MaterialEntity was collected.
-
MEMBER
public static final OccurrenceSearchParameter MEMBER
The full name of the lithostratigraphic member from which the MaterialEntity was collected.
-
BED
public static final OccurrenceSearchParameter BED
The full name of the lithostratigraphic bed from which the MaterialEntity was collected.
-
ASSOCIATED_SEQUENCES
public static final OccurrenceSearchParameter ASSOCIATED_SEQUENCES
A list (concatenated and separated) of identifiers (publication, global unique identifier, URI) of genetic sequence information associated with the material entity.
-
GBIF_ID
public static final OccurrenceSearchParameter GBIF_ID
Unique GBIF key for the occurrence.
-
GEOLOGICAL_TIME
public static final OccurrenceSearchParameter GEOLOGICAL_TIME
Geological time of an occurrence that searchs in the chronostratigraphy fields.
-
LITHOSTRATIGRAPHY
public static final OccurrenceSearchParameter LITHOSTRATIGRAPHY
Searchs in the lithostratigraphy fields(bed, formation, group, member).
-
BIOSTRATIGRAPHY
public static final OccurrenceSearchParameter BIOSTRATIGRAPHY
Searchs in the biostratigraphy fields(lowest and highest biostratigraphy).
-
-
Method Detail
-
values
public static OccurrenceSearchParameter[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (OccurrenceSearchParameter c : OccurrenceSearchParameter.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static OccurrenceSearchParameter valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
type
public Class<?> type()
- Specified by:
type
in interfaceSearchParameter
- Returns:
- the data type expected for the value of the respective search parameter
-
-