TypeSpecimen (GBIF Common :: API 1.16.13 API)

java.lang.Object
- org.gbif.api.model.checklistbank.TypeSpecimen

All Implemented Interfaces:

NameUsageExtension
```
public class TypeSpecimen
extends Object
implements NameUsageExtension
```
TypeSpecimen Model originally designed for both specimens and types, including type specimens, type species and type genera and simple specimens unrelated to types. Since the initial release of the GBIF API version 1.0 ChecklistBank has been modified to only store type species or type genera. All specimens including types are stored in the Occurrence store, hence the majority of properties in this class are now deprecated!

See Also:

Types And Specimen Definition

Constructor Summary

Constructors
Constructor and Description

TypeSpecimen()

Constructors
Constructor and Description
`TypeSpecimen()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getCatalogNumber()` Deprecated.
`String`	`getCitation()` Deprecated.
`String`	`getCollectionCode()` Deprecated.
`String`	`getInstitutionCode()` Deprecated.
`String`	`getLocality()` Deprecated.
`String`	`getOccurrenceId()` Deprecated.
`String`	`getRecordedBy()` Deprecated.
`String`	`getScientificName()` The scientific name originally used for the specimen, species or genus.
`String`	`getSource()` The source.
`Integer`	`getSourceTaxonKey()` If the source is another name usage this is the taxonKey of that usage.
`Integer`	`getTaxonKey()` The name usage "taxon" key this description belongs to.
`Rank`	`getTaxonRank()` The rank of the taxon bearing the scientific name.
`String`	`getTypeDesignatedBy()` The citation of the publication where the type designation is found.
`TypeDesignationType`	`getTypeDesignationType()` The reason why this specimen or name is designated as a type.
`TypeStatus`	`getTypeStatus()` Deprecated.
`String`	`getVerbatimEventDate()` Deprecated.
`String`	`getVerbatimLabel()` Deprecated.
`String`	`getVerbatimLatitude()` Deprecated.
`String`	`getVerbatimLongitude()` Deprecated.
`int`	`hashCode()`
`void`	`setCatalogNumber(String catalogNumber)` Deprecated.
`void`	`setCitation(String citation)` Deprecated.
`void`	`setCollectionCode(String collectionCode)` Deprecated.
`void`	`setInstitutionCode(String institutionCode)` Deprecated.
`void`	`setLocality(String locality)` Deprecated.
`void`	`setOccurrenceId(String occurrenceId)` Deprecated.
`void`	`setRecordedBy(String recordedBy)` Deprecated.
`void`	`setScientificName(String scientificName)`
`void`	`setSource(String source)`
`void`	`setSourceTaxonKey(Integer sourceTaxonKey)`
`void`	`setTaxonKey(Integer taxonKey)`
`void`	`setTaxonRank(Rank taxonRank)`
`void`	`setTypeDesignatedBy(String typeDesignatedBy)`
`void`	`setTypeDesignationType(TypeDesignationType typeDesignationType)`
`void`	`setTypeStatus(TypeStatus typeStatus)` Deprecated.
`void`	`setVerbatimEventDate(String verbatimEventDate)` Deprecated.
`void`	`setVerbatimLabel(String verbatimLabel)` Deprecated.
`void`	`setVerbatimLatitude(String verbatimLatitude)` Deprecated.
`void`	`setVerbatimLongitude(String verbatimLongitude)` Deprecated.
`String`	`toString()`

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

- Constructor Detail
  - TypeSpecimen
```
public TypeSpecimen()
```
- Method Detail
  - getTaxonKey
```
public Integer getTaxonKey()
```
    The name usage "taxon" key this description belongs to.
    
    Specified by:
    
    getTaxonKey in interface NameUsageExtension
  - setTaxonKey
```
public void setTaxonKey(Integer taxonKey)
```
    Specified by:
    
    setTaxonKey in interface NameUsageExtension
  - getCatalogNumber
```
@Nullable
 @Deprecated
public String getCatalogNumber()
```
    Deprecated.
    
    An identifier (preferably unique) for the record within the data set or collection.
    
    Examples: "2008.1334", "145732a", "145732".
    
    Returns:
    
    the catalogNumber
  - setCatalogNumber
```
@Deprecated
public void setCatalogNumber(String catalogNumber)
```
    Deprecated.
    
    Parameters:
    
    catalogNumber - the catalogNumber to set.
  - getCitation
```
@Nullable
 @Deprecated
public String getCitation()
```
    Deprecated.
    
    A text string citing the described specimen. Often found in taxonomic treatments and frequently based on institution code and catalog number.
    
    Examples: Iraq: Mosul: Jabal Khantur prope Sharanish N. Zakho, in fissures rupium calc., 1200 m, Rech. 12083. (W!).
    
    Returns:
    
    the citation
  - setCitation
```
@Deprecated
public void setCitation(String citation)
```
    Deprecated.
    
    Parameters:
    
    citation - the citation to set
  - getCollectionCode
```
@Nullable
 @Deprecated
public String getCollectionCode()
```
    Deprecated.
    
    The name, acronym, coden, or initialism identifying the collection or data set from which the record was derived.
    
    Examples: "Mammals", "Hildebrandt", "eBird".
    
    Returns:
    
    the collectionCode
  - setCollectionCode
```
@Deprecated
public void setCollectionCode(String collectionCode)
```
    Deprecated.
    
    Parameters:
    
    collectionCode - the collectionCode to set
  - getInstitutionCode
```
@Nullable
 @Deprecated
public String getInstitutionCode()
```
    Deprecated.
    
    The name (or acronym) in use by the institution having custody of the object(s) or information referred to in the record.
    
    Examples: "MVZ", "FMNH", "AKN-CLO", "University of California Museum of Paleontology (UCMP)".
    
    Returns:
    
    the institutionCode
  - setInstitutionCode
```
@Deprecated
public void setInstitutionCode(String institutionCode)
```
    Deprecated.
    
    Parameters:
    
    institutionCode - the institutionCode to set
  - getLocality
```
@Nullable
 @Deprecated
public String getLocality()
```
    Deprecated.
    
    The location where the specimen was collected. In case of type specimens the type locality.
    
    Examples: Iraq: Mosul: Jabal Khantur prope Sharanish N. Zakho, in fissures rupium calc., 1200 m.
    
    Returns:
    
    the locality
  - setLocality
```
@Deprecated
public void setLocality(String locality)
```
    Deprecated.
    
    Parameters:
    
    locality - the locality to set
  - getOccurrenceId
```
@Nullable
 @Deprecated
public String getOccurrenceId()
```
    Deprecated.
    
    An identifier for the specimen, preferably a resolvable globally unique identifier.
    
    Returns:
    
    the occurrenceId
  - setOccurrenceId
```
@Deprecated
public void setOccurrenceId(String occurrenceId)
```
    Deprecated.
    
    Parameters:
    
    occurrenceId - the occurrenceId to set
  - getRecordedBy
```
@Nullable
 @Deprecated
public String getRecordedBy()
```
    Deprecated.
    
    The primary collector or observer, especially one who applies a personal identifier (recordNumber), should be listed first.
    
    Examples: KH Rechinger.
    
    Returns:
    
    the recordedBy
  - setRecordedBy
```
@Deprecated
public void setRecordedBy(String recordedBy)
```
    Deprecated.
    
    Parameters:
    
    recordedBy - the recordedBy to set
  - getScientificName
```
@Nullable
public String getScientificName()
```
    The scientific name originally used for the specimen, species or genus. Not necessarily the same as the currently recognized name. For type species this is the species name.
    
    Examples: "Ctenomys sociabilis" - "Roptrocerus typographi (Györfi, 1952)".
    
    Returns:
    
    the scientificName
  - setScientificName
```
public void setScientificName(String scientificName)
```
    Parameters:
    
    scientificName - the scientificName to set
  - getSource
```
@Nullable
public String getSource()
```
    The source.
    
    Specified by:
    
    getSource in interface NameUsageExtension
    
    Returns:
    
    the source
  - setSource
```
public void setSource(String source)
```
    Specified by:
    
    setSource in interface NameUsageExtension
    
    Parameters:
    
    source - the source to set
  - getSourceTaxonKey
```
@Nullable
public Integer getSourceTaxonKey()
```
    Description copied from interface: NameUsageExtension
    
    If the source is another name usage this is the taxonKey of that usage. Only useful for the backbone dataset.
    
    Specified by:
    
    getSourceTaxonKey in interface NameUsageExtension
    
    Returns:
    
    The key of the name usage this instance is derived from.
  - setSourceTaxonKey
```
public void setSourceTaxonKey(Integer sourceTaxonKey)
```
    Specified by:
    
    setSourceTaxonKey in interface NameUsageExtension
  - getTaxonRank
```
public Rank getTaxonRank()
```
    The rank of the taxon bearing the scientific name.
    
    Returns:
    
    the taxonRank
  - setTaxonRank
```
public void setTaxonRank(Rank taxonRank)
```
    Parameters:
    
    taxonRank - the taxonRank to set
  - getTypeDesignatedBy
```
@Nullable
public String getTypeDesignatedBy()
```
    The citation of the publication where the type designation is found.
    
    Examples: Vachal, J. (1897) Éclaircissements sur de genre Scrapter et description d’une espéce nouvelle de Dufourea. Bulletin de la Société Entomologique de France, 1897, 61–64.
    
    Returns:
    
    the typeDesignatedBy
  - setTypeDesignatedBy
```
public void setTypeDesignatedBy(String typeDesignatedBy)
```
    Parameters:
    
    typeDesignatedBy - the typeDesignatedBy to set
  - getTypeDesignationType
```
@Nullable
public TypeDesignationType getTypeDesignationType()
```
    The reason why this specimen or name is designated as a type.
    
    Examples: monotypy, original designation, tautonomy.
    
    Returns:
    
    the typeDesignationType
  - setTypeDesignationType
```
public void setTypeDesignationType(TypeDesignationType typeDesignationType)
```
    Parameters:
    
    typeDesignationType - the typeDesignationType to set
  - getTypeStatus
```
@Nullable
 @Deprecated
public TypeStatus getTypeStatus()
```
    Deprecated.
    
    The type status of the specimen, not used for type species or type genus.
    
    Examples: holotype, syntype, lectotype, type species.
    
    Returns:
    
    the typeStatus
  - setTypeStatus
```
@Deprecated
public void setTypeStatus(TypeStatus typeStatus)
```
    Deprecated.
    
    Parameters:
    
    typeStatus - the typeStatus to set
  - getVerbatimEventDate
```
@Nullable
 @Deprecated
public String getVerbatimEventDate()
```
    Deprecated.
    
    The date when the specimen was collected.
    
    Examples: "spring 1910", "Marzo 2002", "1999-03-XX", "17IV1934".
    
    Returns:
    
    the verbatimEventDate
  - setVerbatimEventDate
```
@Deprecated
public void setVerbatimEventDate(String verbatimEventDate)
```
    Deprecated.
    
    Parameters:
    
    verbatimEventDate - the verbatimEventDate to set
  - getVerbatimLabel
```
@Nullable
 @Deprecated
public String getVerbatimLabel()
```
    Deprecated.
    
    The full, verbatim text from the specimen label.
    
    Returns:
    
    the verbatimLabel
  - setVerbatimLabel
```
@Deprecated
public void setVerbatimLabel(String verbatimLabel)
```
    Deprecated.
    
    Parameters:
    
    verbatimLabel - the verbatimLabel to set
  - getVerbatimLatitude
```
@Nullable
 @Deprecated
public String getVerbatimLatitude()
```
    Deprecated.
    
    The geographic latitude.
    
    Examples: 41 05 54.03 S.
    
    Returns:
    
    the verbatimLatitude
  - setVerbatimLatitude
```
@Deprecated
public void setVerbatimLatitude(String verbatimLatitude)
```
    Deprecated.
    
    Parameters:
    
    verbatimLatitude - the verbatimLatitude to set
  - getVerbatimLongitude
```
@Nullable
 @Deprecated
public String getVerbatimLongitude()
```
    Deprecated.
    
    The geographic longitude.
    
    Examples: 121d 10' 34 W.
    
    Returns:
    
    the verbatimLongitude
  - setVerbatimLongitude
```
@Deprecated
public void setVerbatimLongitude(String verbatimLongitude)
```
    Deprecated.
    
    Parameters:
    
    verbatimLongitude - the verbatimLongitude to set
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TypeSpecimen

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TypeSpecimen

Method Detail

getTaxonKey

setTaxonKey

getCatalogNumber

setCatalogNumber

getCitation

setCitation

getCollectionCode

setCollectionCode

getInstitutionCode

setInstitutionCode

getLocality

setLocality

getOccurrenceId

setOccurrenceId

getRecordedBy

setRecordedBy

getScientificName

setScientificName

getSource

setSource

getSourceTaxonKey

setSourceTaxonKey

getTaxonRank

setTaxonRank

getTypeDesignatedBy

setTypeDesignatedBy

getTypeDesignationType

setTypeDesignationType

getTypeStatus

setTypeStatus

getVerbatimEventDate

setVerbatimEventDate

getVerbatimLabel

setVerbatimLabel

getVerbatimLatitude

setVerbatimLatitude

getVerbatimLongitude

setVerbatimLongitude

equals

hashCode

toString