Package org.gbif.dwc.terms
Enum Class GbifTerm
- All Implemented Interfaces:
Serializable,Comparable<GbifTerm>,Constable,AlternativeNames,Term
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe scientific name the type associated acceptedNubKey.The GBIF backbone key of the accepted taxon key.The key to the accepted class in the GBIF backbone.Deprecated.The UUID key for the dataset registered in GBIF.Depth in metres below the surface.Depth accuracy is the uncertainty for the depth in metres.The GBIF Taxon Description extension row type.Deprecated.Deprecated.The distance in metres from a known centroid, e.g.The GBIF Species Distribution extension row type.Elevation in metres above sea level (altitude).Elevation accuracy is the uncertainty for the elevation in metres.The key to the accepted family in the GBIF backbone.Numerical, stable identifier assigned by GBIF to an Occurrence record.GBIF region based on country codeThe key to the accepted genus in the GBIF backbone.Boolean indicating that a valid latitude and longitude exists.Boolean indicating that some spatial validation rule has not passed.The GBIF Alternative Identifiers extension row type.The deprecated GBIF Simple Images extension row type.Flag occurrence when associatedSequences/extension existsAny issue found during processing and interpretation or the record.The key to the accepted kingdom in the GBIF backbone.The date this record was last crawled/harvested by GBIF from the endpoint.Timestamp of the last time the record was (re)interpreted by GBIF.The date this record was last parsed from raw xml/json into a verbatim GBIF record.The media type given as Dublin Core type values, in particular StillImage, MovingImage or Sound.The GBIF Simple Multimedia extension row type.The key to the accepted order in the GBIF backbone.The key to the accepted phylum in the GBIF backbone.An identifier for a project to which a record belongs.The kind of protocol used when the record was last crawled by GBIF.GBIF region based on publishing country codeThe ISO 3166 2-letter code of the country of the organization that publishes the dataset to which the occurrence belongs.The GBIF Literature References extension row type.Calculated relative organism quantity, based on organism and sample measure typesBoolean indicating if the publishing country is different to the location country.The canonical name without authorship of the accepted species.The backbone key to the accepted species.The GBIF Species Profile extension row type.The key to the accepted subgenus in the GBIF backbone.The GBIF backbone key.The GBIF Types and Specimen extension row type.The scientific name the type status of this specimen applies to.Scientific name as provided by the source.The GBIF Vernacular Names extension row type. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String[]Lists all GBIF term groups.final String[]static final GbifTerm[]Lists all GBIF terms in taxon group. -
Method Summary
Modifier and TypeMethodDescriptionString[]Array of alternative simple names in use for the term.getGroup()The optional group the term is grouped in.booleanisClass()Informs if a term is generally used as a class term, i.e.booleanlistByGroup(String group) List all terms that belong to a given group.The namespace the terms are in.prefix()A unique standard prefix representing the namespace.The simple term name without a namespace.toString()static GbifTermReturns the enum constant of this class with the specified name.static GbifTerm[]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, valueOfMethods inherited from interface org.gbif.dwc.terms.Term
prefixedName, qualifiedName
-
Enum Constant Details
-
Description
The GBIF Taxon Description extension row type. -
Distribution
The GBIF Species Distribution extension row type. -
Identifier
The GBIF Alternative Identifiers extension row type. -
Image
The deprecated GBIF Simple Images extension row type. -
Reference
The GBIF Literature References extension row type. -
SpeciesProfile
The GBIF Species Profile extension row type. -
TypesAndSpecimen
The GBIF Types and Specimen extension row type. -
VernacularName
The GBIF Vernacular Names extension row type. -
Multimedia
The GBIF Simple Multimedia extension row type. -
datasetKey
The UUID key for the dataset registered in GBIF. -
publishingCountry
The ISO 3166 2-letter code of the country of the organization that publishes the dataset to which the occurrence belongs. -
gbifID
Numerical, stable identifier assigned by GBIF to an Occurrence record. -
lastInterpreted
Timestamp of the last time the record was (re)interpreted by GBIF. -
coordinateAccuracy
Deprecated.The uncertainty radius for the latitude and longitude in decimal degrees. -
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
Elevation accuracy is the uncertainty for the elevation in metres.The elevation accuracy is calculated using the equation:
(maximumElevationInMeters - minimumElevationInMeters) / 2in case a minimum and maximum verbatim value is given. -
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
Depth accuracy is the uncertainty for the depth in metres.The depth accuracy is calculated using the equation:
(maximumDepthInMeters - minimumDepthInMeters) / 2in case a minimum and maximum verbatim value is given. -
distanceAboveSurface
Deprecated.Replaced by Darwin Core terms dwc:minimumDistanceAboveSurfaceInMeters and dwc:maximumDistanceAboveSurfaceInMeters. -
distanceAboveSurfaceAccuracy
Deprecated.Replaced by Darwin Core terms dwc:minimumDistanceAboveSurfaceInMeters and dwc:maximumDistanceAboveSurfaceInMeters. -
distanceFromCentroidInMeters
The distance in metres from a known centroid, e.g. a country centroid. -
issue
Any issue found during processing and interpretation or the record. See OccurrenceIssue enumeration for possible values. -
mediaType
The media type given as Dublin Core type values, in particular StillImage, MovingImage or Sound. -
infraspecificMarker
-
typeDesignatedBy
-
typeDesignationType
-
hasCoordinate
Boolean indicating that a valid latitude and longitude exists. Even if existing it might still have issues, see hasGeospatialIssues and issue. -
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
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
The GBIF backbone key of the accepted taxon key. -
kingdomKey
The key to the accepted kingdom in the GBIF backbone. -
phylumKey
The key to the accepted phylum in the GBIF backbone. -
classKey
The key to the accepted class in the GBIF backbone. -
orderKey
The key to the accepted order in the GBIF backbone. -
familyKey
The key to the accepted family in the GBIF backbone. -
genusKey
The key to the accepted genus in the GBIF backbone. -
subgenusKey
The key to the accepted subgenus in the GBIF backbone. -
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
The canonical name without authorship of the accepted species. -
canonicalName
-
nameType
-
acceptedScientificName
The scientific name the type associated acceptedNubKey. -
verbatimScientificName
Scientific name as provided by the source. -
typifiedName
The scientific name the type status of this specimen applies to. Term proposed in Darwin Core, but not yet ratified. -
protocol
The kind of protocol used when the record was last crawled by GBIF. See EndpointType enumeration for possible values. -
lastParsed
The date this record was last parsed from raw xml/json into a verbatim GBIF record. -
lastCrawled
The date this record was last crawled/harvested by GBIF from the endpoint. -
isMarine
-
isTerrestrial
-
isFreshwater
-
isHybrid
-
isExtinct
-
livingPeriod
-
lifeForm
-
ageInDays
-
sizeInMillimeter
-
massInGram
-
organismPart
-
isPlural
-
isPreferredName
-
appendixCITES
-
numberOfOccurrences
-
repatriated
Boolean indicating if the publishing country is different to the location country. -
relativeOrganismQuantity
Calculated relative organism quantity, based on organism and sample measure types -
projectId
An identifier for a project to which a record belongs. -
isSequenced
Flag occurrence when associatedSequences/extension exists -
gbifRegion
GBIF region based on country code -
publishedByGbifRegion
GBIF region based on publishing country code -
geologicalTime
-
lithostratigraphy
-
biostratigraphy
-
dnaSequenceID
-
-
Field Details
-
GROUP_CRAWLING
- See Also:
-
GROUP_DATASET
- See Also:
-
GROUP_ROW_TYPE
- See Also:
-
GROUP_SPECIES_DISTRIBUTION_EXTENSION
- See Also:
-
GROUP_SPECIES_PROFILE_EXTENSION
- See Also:
-
GROUP_VERNACULAR_NAME_EXTENSION
- See Also:
-
GROUP_DNA_DERIVED_DATA
- See Also:
-
GROUPS
Lists all GBIF term groups. -
TAXONOMIC_TERMS
Lists all GBIF terms in taxon group. -
normAlts
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException- if the argument is null
-
simpleName
The simple term name without a namespace. For example taxonKey.- Specified by:
simpleNamein interfaceTerm- Returns:
- simple term name
-
alternativeNames
Array of alternative simple names in use for the term.- Specified by:
alternativeNamesin interfaceAlternativeNames- Returns:
- simple term name
-
getGroup
The optional group the term is grouped in. For example Occurrence, Taxon, etc. -
listByGroup
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
-
isClass
Description copied from interface:TermInforms if a term is generally used as a class term, i.e. defining rowTypes not properties. For example VernacularName, Taxon or Occurrence -
prefix
Description copied from interface:TermA unique standard prefix representing the namespace. For example dwc. -
namespace
Description copied from interface:TermThe namespace the terms are in. Default implementations here expect the namespace to end with a slash. -
isDeprecated
- Returns:
- true if the Term is annotated with @Deprecated.
-