Package org.gbif.api.model.checklistbank

Class 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

    • Method Detail

      • 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

      • 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

      • 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

      • 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

      • 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

      • getOccurrenceId

        @Nullable
@Deprecated
public String getOccurrenceId()
        Deprecated.
        An identifier for the specimen, preferably a resolvable globally unique identifier.
        Returns:
        the occurrenceId

      • 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

      • 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

      • 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

      • 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

      • 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