GbifTerm (GBIF Common :: API 1.16.18 API)

java.lang.Object
- java.lang.Enum<GbifTerm>
- - org.gbif.dwc.terms.GbifTerm

All Implemented Interfaces:: Serializable, Comparable<GbifTerm>, AlternativeNames, Term

public enum GbifTerm
extends Enum<GbifTerm>
implements Term, AlternativeNames, Serializable

Enum Constant Summary

Enum Constants
Enum Constant and Description
`acceptedScientificName` The scientific name the type associated acceptedNubKey.
`acceptedTaxonKey` The GBIF backbone key of the accepted taxon key.
`ageInDays`
`appendixCITES`
`canonicalName`
`classKey` The key to the accepted class in the GBIF backbone.
`coordinateAccuracy` Deprecated.
`datasetKey` The UUID key for the dataset registered in GBIF.
`depth` Depth in metres below the surface.
`depthAccuracy` Depth accuracy is the uncertainty for the depth in metres.
`Description` The GBIF Taxon Description extension row type.
`distanceAboveSurface` Deprecated.
`distanceAboveSurfaceAccuracy` Deprecated.
`distanceFromCentroidInMeters` The distance in metres from a known centroid, e.g.
`Distribution` The GBIF Species Distribution extension row type.
`elevation` Elevation in metres above sea level (altitude).
`elevationAccuracy` Elevation accuracy is the uncertainty for the elevation in metres.
`familyKey` The key to the accepted family in the GBIF backbone.
`gbifID` Numerical, stable identifier assigned by GBIF to an Occurrence record.
`gbifRegion` GBIF region based on country code
`genusKey` The key to the accepted genus in the GBIF backbone.
`hasCoordinate` Boolean indicating that a valid latitude and longitude exists.
`hasGeospatialIssues` Boolean indicating that some spatial validation rule has not passed.
`Identifier` The GBIF Alternative Identifiers extension row type.
`Image` The deprecated GBIF Simple Images extension row type.
`infraspecificMarker`
`isExtinct`
`isFreshwater`
`isHybrid`
`isMarine`
`isPlural`
`isPreferredName`
`isSequenced` Flag occurrence when associatedSequences/extension exists
`issue` Any issue found during processing and interpretation or the record.
`isTerrestrial`
`kingdomKey` The key to the accepted kingdom in the GBIF backbone.
`lastCrawled` The date this record was last crawled/harvested by GBIF from the endpoint.
`lastInterpreted` Timestamp of the last time the record was (re)interpreted by GBIF.
`lastParsed` The date this record was last parsed from raw xml/json into a verbatim GBIF record.
`lifeForm`
`livingPeriod`
`massInGram`
`mediaType` The media type given as Dublin Core type values, in particular StillImage, MovingImage or Sound.
`Multimedia` The GBIF Simple Multimedia extension row type.
`nameType`
`numberOfOccurrences`
`orderKey` The key to the accepted order in the GBIF backbone.
`organismPart`
`phylumKey` The key to the accepted phylum in the GBIF backbone.
`projectId`
`protocol` The kind of protocol used when the record was last crawled by GBIF.
`publishedByGbifRegion` GBIF region based on publishing country code
`publishingCountry` The ISO 3166 2-letter code of the country of the organization that publishes the dataset to which the occurrence belongs.
`Reference` The GBIF Literature References extension row type.
`relativeOrganismQuantity` Calculated relative organism quantity, based on organism and sample measure types
`repatriated` Boolean indicating if the publishing country is different to the location country.
`sizeInMillimeter`
`species` The canonical name without authorship of the accepted species.
`speciesKey` The backbone key to the accepted species.
`SpeciesProfile` The GBIF Species Profile extension row type.
`subgenusKey` The key to the accepted subgenus in the GBIF backbone.
`taxonKey` The GBIF backbone key.
`typeDesignatedBy`
`typeDesignationType`
`TypesAndSpecimen` The GBIF Types and Specimen extension row type.
`typifiedName` The scientific name the type status of this specimen applies to.
`verbatimScientificName` Scientific name as provided by the source.
`VernacularName` The GBIF Vernacular Names extension row type.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`GROUP_CRAWLING`
`static String`	`GROUP_DATASET`
`static String`	`GROUP_ROW_TYPE`
`static String`	`GROUP_SPECIES_DISTRIBUTION_EXTENSION`
`static String`	`GROUP_SPECIES_PROFILE_EXTENSION`
`static String`	`GROUP_VERNACULAR_NAME_EXTENSION`
`static String[]`	`GROUPS` Lists all GBIF term groups.
`String[]`	`normAlts`
`static GbifTerm[]`	`TAXONOMIC_TERMS` Lists all GBIF terms in taxon group.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`alternativeNames()` Array of alternative simple names in use for the term.
`String`	`getGroup()` The optional group the term is grouped in.
`boolean`	`isClass()` Informs if a term is generally used as a class term, i.e.
`boolean`	`isDeprecated()`
`static List<GbifTerm>`	`listByGroup(String group)` List all terms that belong to a given group.
`URI`	`namespace()` The namespace the terms are in.
`String`	`prefix()` A unique standard prefix representing the namespace.
`String`	`simpleName()` The simple term name without a namespace.
`String`	`toString()`
`static GbifTerm`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GbifTerm[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gbif.dwc.terms.Term
prefixedName, qualifiedName

- Enum Constant Detail
  - Description
```
public static final GbifTerm Description
```
    The GBIF Taxon Description extension row type.
  - Distribution
```
public static final GbifTerm Distribution
```
    The GBIF Species Distribution extension row type.
  - Identifier
```
public static final GbifTerm Identifier
```
    The GBIF Alternative Identifiers extension row type.
  - Image
```
public static final GbifTerm Image
```
    The deprecated GBIF Simple Images extension row type.
  - Reference
```
public static final GbifTerm Reference
```
    The GBIF Literature References extension row type.
  - SpeciesProfile
```
public static final GbifTerm SpeciesProfile
```
    The GBIF Species Profile extension row type.
  - TypesAndSpecimen
```
public static final GbifTerm TypesAndSpecimen
```
    The GBIF Types and Specimen extension row type.
  - VernacularName
```
public static final GbifTerm VernacularName
```
    The GBIF Vernacular Names extension row type.
  - Multimedia
```
public static final GbifTerm Multimedia
```
    The GBIF Simple Multimedia extension row type.
  - datasetKey
```
public static final GbifTerm datasetKey
```
    The UUID key for the dataset registered in GBIF.
  - publishingCountry
```
public static final GbifTerm publishingCountry
```
    The ISO 3166 2-letter code of the country of the organization that publishes the dataset to which the occurrence belongs.
  - gbifID
```
public static final GbifTerm gbifID
```
    Numerical, stable identifier assigned by GBIF to an Occurrence record.
  - lastInterpreted
```
public static final GbifTerm lastInterpreted
```
    Timestamp of the last time the record was (re)interpreted by GBIF.
  - coordinateAccuracy
```
@Deprecated
public static final GbifTerm coordinateAccuracy
```
    Deprecated.
    
    The uncertainty radius for the latitude and longitude in decimal degrees.
  - elevation
```
public static final GbifTerm elevation
```
    Elevation in metres above sea level (altitude).
    The elevation is the absolute vertical position of the observed location (z-coordinate). If depth is given or not will not impact the 3-dimensional position. For example a location 100m below the surface of a lake in 2000m altitude has a depth of 100 and an elevation of 1900.
    
    If minimum and maximum values are given the elevation is calculated using the equation: (minimumElevationInMeters + maximumElevationInMeters) / 2. For consistency and ease of use GBIF decided to always use a value in metres plus its accuracy instead of min/max values which are sometimes used in Darwin Core. See also depth & distanceAboveSurface.
  - elevationAccuracy
```
public static final GbifTerm elevationAccuracy
```
    Elevation accuracy is the uncertainty for the elevation in metres.
    The elevation accuracy is calculated using the equation: (maximumElevationInMeters - minimumElevationInMeters) / 2 in case a minimum and maximum verbatim value is given.
  - depth
```
public static final GbifTerm depth
```
    Depth in metres below the surface.
    Complimentary and relative to elevation, depth indicates the distance to the earth surface, whether that is water or ground. For example a location 100m below the surface of a lake in 2000m altitude has a depth of 100 and an elevation of 1900.
    
    The depth is calculated using the equation: (minimumDepthInMeters + maximumDepthInMeters) / 2. For consistency and ease of use GBIF decided to always use a value in meters plus it's accuracy instead of min/max values which are sometimes used in Darwin Core. See also elevation & distanceAboveSurface.
  - depthAccuracy
```
public static final GbifTerm depthAccuracy
```
    Depth accuracy is the uncertainty for the depth in metres.
    The depth accuracy is calculated using the equation: (maximumDepthInMeters - minimumDepthInMeters) / 2 in case a minimum and maximum verbatim value is given.
  - distanceAboveSurface
```
@Deprecated
public static final GbifTerm distanceAboveSurface
```
    Deprecated.
    
    Replaced by Darwin Core terms dwc:minimumDistanceAboveSurfaceInMeters and dwc:maximumDistanceAboveSurfaceInMeters.
  - distanceAboveSurfaceAccuracy
```
@Deprecated
public static final GbifTerm distanceAboveSurfaceAccuracy
```
    Deprecated.
    
    Replaced by Darwin Core terms dwc:minimumDistanceAboveSurfaceInMeters and dwc:maximumDistanceAboveSurfaceInMeters.
  - distanceFromCentroidInMeters
```
public static final GbifTerm distanceFromCentroidInMeters
```
    The distance in metres from a known centroid, e.g. a country centroid.
  - issue
```
public static final GbifTerm issue
```
    Any issue found during processing and interpretation or the record. See OccurrenceIssue enumeration for possible values.
  - mediaType
```
public static final GbifTerm mediaType
```
    The media type given as Dublin Core type values, in particular StillImage, MovingImage or Sound.
  - infraspecificMarker
```
public static final GbifTerm infraspecificMarker
```
  - typeDesignatedBy
```
public static final GbifTerm typeDesignatedBy
```
  - typeDesignationType
```
public static final GbifTerm typeDesignationType
```
  - hasCoordinate
```
public static final GbifTerm hasCoordinate
```
    Boolean indicating that a valid latitude and longitude exists. Even if existing it might still have issues, see hasGeospatialIssues and issue.
  - hasGeospatialIssues
```
public static final GbifTerm hasGeospatialIssues
```
    Boolean indicating that some spatial validation rule has not passed. Primarily used to indicate that the record should not be displayed on a map.
  - taxonKey
```
public static final GbifTerm taxonKey
```
    The GBIF backbone key.
    The best matching, accepted GBIF backbone name usage representing this occurrence. In case the verbatim scientific name and its classification can only be matched to a higher rank this will represent the lowest matching rank. In the worst case this could just be for example Animalia.
    
    In contrast dwc:taxonID is only used for the source ids similar to occurrenceID
  - acceptedTaxonKey
```
public static final GbifTerm acceptedTaxonKey
```
    The GBIF backbone key of the accepted taxon key.
  - kingdomKey
```
public static final GbifTerm kingdomKey
```
    The key to the accepted kingdom in the GBIF backbone.
  - phylumKey
```
public static final GbifTerm phylumKey
```
    The key to the accepted phylum in the GBIF backbone.
  - classKey
```
public static final GbifTerm classKey
```
    The key to the accepted class in the GBIF backbone.
  - orderKey
```
public static final GbifTerm orderKey
```
    The key to the accepted order in the GBIF backbone.
  - familyKey
```
public static final GbifTerm familyKey
```
    The key to the accepted family in the GBIF backbone.
  - genusKey
```
public static final GbifTerm genusKey
```
    The key to the accepted genus in the GBIF backbone.
  - subgenusKey
```
public static final GbifTerm subgenusKey
```
    The key to the accepted subgenus in the GBIF backbone.
  - speciesKey
```
public static final GbifTerm speciesKey
```
    The backbone key to the accepted species. In case the taxonKey is of a higher rank than species (e.g. genus) speciesKey is null. In case taxonKey represents an infraspecific taxon the speciesKey points to the species the infraspecies is classified as. In case of taxonKey being a species the speciesKey is the same.
  - species
```
public static final GbifTerm species
```
    The canonical name without authorship of the accepted species.
  - canonicalName
```
public static final GbifTerm canonicalName
```
  - nameType
```
public static final GbifTerm nameType
```
  - acceptedScientificName
```
public static final GbifTerm acceptedScientificName
```
    The scientific name the type associated acceptedNubKey.
  - verbatimScientificName
```
public static final GbifTerm verbatimScientificName
```
    Scientific name as provided by the source.
  - typifiedName
```
public static final GbifTerm typifiedName
```
    The scientific name the type status of this specimen applies to. Term proposed in Darwin Core, but not yet ratified.
  - protocol
```
public static final GbifTerm protocol
```
    The kind of protocol used when the record was last crawled by GBIF. See EndpointType enumeration for possible values.
  - lastParsed
```
public static final GbifTerm lastParsed
```
    The date this record was last parsed from raw xml/json into a verbatim GBIF record.
  - lastCrawled
```
public static final GbifTerm lastCrawled
```
    The date this record was last crawled/harvested by GBIF from the endpoint.
  - isMarine
```
public static final GbifTerm isMarine
```
  - isTerrestrial
```
public static final GbifTerm isTerrestrial
```
  - isFreshwater
```
public static final GbifTerm isFreshwater
```
  - isHybrid
```
public static final GbifTerm isHybrid
```
  - isExtinct
```
public static final GbifTerm isExtinct
```
  - livingPeriod
```
public static final GbifTerm livingPeriod
```
  - lifeForm
```
public static final GbifTerm lifeForm
```
  - ageInDays
```
public static final GbifTerm ageInDays
```
  - sizeInMillimeter
```
public static final GbifTerm sizeInMillimeter
```
  - massInGram
```
public static final GbifTerm massInGram
```
  - organismPart
```
public static final GbifTerm organismPart
```
  - isPlural
```
public static final GbifTerm isPlural
```
  - isPreferredName
```
public static final GbifTerm isPreferredName
```
  - appendixCITES
```
public static final GbifTerm appendixCITES
```
  - numberOfOccurrences
```
public static final GbifTerm numberOfOccurrences
```
  - repatriated
```
public static final GbifTerm repatriated
```
    Boolean indicating if the publishing country is different to the location country.
  - relativeOrganismQuantity
```
public static final GbifTerm relativeOrganismQuantity
```
    Calculated relative organism quantity, based on organism and sample measure types
  - projectId
```
public static final GbifTerm projectId
```
  - isSequenced
```
public static final GbifTerm isSequenced
```
    Flag occurrence when associatedSequences/extension exists
  - gbifRegion
```
public static final GbifTerm gbifRegion
```
    GBIF region based on country code
  - publishedByGbifRegion
```
public static final GbifTerm publishedByGbifRegion
```
    GBIF region based on publishing country code
- Field Detail
  - GROUP_CRAWLING
```
public static final String GROUP_CRAWLING
```
    See Also:
    
    Constant Field Values
  - GROUP_DATASET
```
public static final String GROUP_DATASET
```
    See Also:
    
    Constant Field Values
  - GROUP_ROW_TYPE
```
public static final String GROUP_ROW_TYPE
```
    See Also:
    
    Constant Field Values
  - GROUP_SPECIES_DISTRIBUTION_EXTENSION
```
public static final String GROUP_SPECIES_DISTRIBUTION_EXTENSION
```
    See Also:
    
    Constant Field Values
  - GROUP_SPECIES_PROFILE_EXTENSION
```
public static final String GROUP_SPECIES_PROFILE_EXTENSION
```
    See Also:
    
    Constant Field Values
  - GROUP_VERNACULAR_NAME_EXTENSION
```
public static final String GROUP_VERNACULAR_NAME_EXTENSION
```
    See Also:
    
    Constant Field Values
  - GROUPS
```
public static final String[] GROUPS
```
    Lists all GBIF term groups.
  - TAXONOMIC_TERMS
```
public static final GbifTerm[] TAXONOMIC_TERMS
```
    Lists all GBIF terms in taxon group.
  - normAlts
```
public final String[] normAlts
```
- Method Detail
  - values
```
public static GbifTerm[] 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 (GbifTerm c : GbifTerm.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GbifTerm 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 name
    
    NullPointerException - if the argument is null
  - simpleName
```
public String simpleName()
```
    The simple term name without a namespace. For example taxonKey.
    
    Specified by:
    
    simpleName in interface Term
    
    Returns:
    
    simple term name
  - alternativeNames
```
public String[] alternativeNames()
```
    Array of alternative simple names in use for the term.
    
    Specified by:
    
    alternativeNames in interface AlternativeNames
    
    Returns:
    
    simple term name
  - getGroup
```
public String getGroup()
```
    The optional group the term is grouped in. For example Occurrence, Taxon, etc.
  - listByGroup
```
public static List<GbifTerm> listByGroup(String group)
```
    List all terms that belong to a given group.
    
    Parameters:
    
    group - the group to list terms for
    
    Returns:
    
    the list of GBIF terms in the given group
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<GbifTerm>
  - isClass
```
public boolean isClass()
```
    Description copied from interface: Term
    
    Informs if a term is generally used as a class term, i.e. defining rowTypes not properties. For example VernacularName, Taxon or Occurrence
    
    Specified by:
    
    isClass in interface Term
    
    Returns:
    
    true if the term is defining a class instead of a property, e.g. Taxon
  - prefix
```
public String prefix()
```
    Description copied from interface: Term
    
    A unique standard prefix representing the namespace. For example dwc.
    
    Specified by:
    
    prefix in interface Term
  - namespace
```
public URI namespace()
```
    Description copied from interface: Term
    
    The namespace the terms are in. Default implementations here expect the namespace to end with a slash.
    
    Specified by:
    
    namespace in interface Term
  - isDeprecated
```
public boolean isDeprecated()
```
    Returns:
    
    true if the Term is annotated with @Deprecated.

Enum GbifTerm

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface org.gbif.dwc.terms.Term

Enum Constant Detail

Description

Distribution

Identifier

Image

Reference

SpeciesProfile

TypesAndSpecimen

VernacularName

Multimedia

datasetKey

publishingCountry

gbifID

lastInterpreted

coordinateAccuracy

elevation

elevationAccuracy

depth

depthAccuracy

distanceAboveSurface

distanceAboveSurfaceAccuracy

distanceFromCentroidInMeters

issue

mediaType

infraspecificMarker

typeDesignatedBy

typeDesignationType

hasCoordinate

hasGeospatialIssues

taxonKey

acceptedTaxonKey

kingdomKey

phylumKey

classKey

orderKey

familyKey

genusKey

subgenusKey

speciesKey

species

canonicalName

nameType

acceptedScientificName

verbatimScientificName

typifiedName

protocol

lastParsed

lastCrawled

isMarine

isTerrestrial

isFreshwater

isHybrid

isExtinct

livingPeriod

lifeForm

ageInDays

sizeInMillimeter

massInGram

organismPart

isPlural

isPreferredName

appendixCITES

numberOfOccurrences

repatriated

relativeOrganismQuantity

projectId

isSequenced

gbifRegion

publishedByGbifRegion

Field Detail

GROUP_CRAWLING

GROUP_DATASET

GROUP_ROW_TYPE