Package org.gbif.api.model.checklistbank

Class Reference

java.lang.Object
org.gbif.api.model.checklistbank.Reference
All Implemented Interfaces:
NameUsageExtension
public class Reference extends Object implements NameUsageExtension
Reference Model Object represents a literature reference stating a bibliography for a taxon. Since the initial release of the GBIF API version 1.0 ChecklistBank has been modified to only store the entire citation string of a reference and none of the atomised fields which are now deprecated.
See Also:

  • Constructor Details

  • Method Details

    • 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

    • getAuthor

      @Nullable @Deprecated public String getAuthor()
      Deprecated.
      The author or authors of the referenced work.

      Example: Patricia Hartge.

      Returns:
      the author

    • setAuthor

      @Deprecated public void setAuthor(String author)
      Deprecated.
      Parameters:
      author - the author to set

    • getCitation

      @NotNull public @NotNull String getCitation()
      A text string referring to an un-parsed bibliographic citation. The full citation given here should include all the details potentially found in the other atomised fields, i.e. includes authorship, title, etc.

      Example: Hartge, P., Genetics of reproductive lifespan. Nature Genetics 41, 637 - 638 (2009).

      Returns:
      the citation

    • setCitation

      public void setCitation(String citation)
      Parameters:
      citation - the citation to set

    • getDate

      @Nullable @Deprecated public String getDate()
      Deprecated.
      Date of publication, recommended ISO format YYYY or YYYY-MM-DD.
      Returns:
      the publication date

    • setDate

      @Deprecated public void setDate(String date)
      Deprecated.

    • getDoi

      @Nullable public String getDoi()
      The pure DOI for the publication without potential http resolver or URI prefix. For example 10.1038/ng0609-637 instead of doi:10.1038/ng0609-637 or http://dx.doi.org/10.1038/ng0609-637. A valid DOI always starts with 10..
      Returns:
      the doi
      See Also:

    • setDoi

      public void setDoi(String doi)

    • getLink

      @Nullable public String getLink()
      Link.
      Returns:
      the link

    • setLink

      public void setLink(String link)
      Parameters:
      link - the link to set

    • getRemarks

      @Nullable public String getRemarks()
      Annotation of taxon-specific information related to the referenced publication.

      Examples: "transferred H. nigritarsus to Acanolonia"; "Type specimen is a skeleton"

      Returns:
      the taxonomic remarks

    • setRemarks

      public void setRemarks(String remarks)

    • getTitle

      @Nullable @Deprecated public String getTitle()
      Deprecated.
      Title of book or article.

      Example: "Genetics of reproductive lifespan", "Field Guide to Moths of Eastern North America".

      Returns:
      the title

    • setTitle

      @Deprecated public void setTitle(String title)
      Deprecated.
      Parameters:
      title - the title to set

    • getType

      @Nullable public String getType()
      Used to assign a bibliographic reference to list of taxonomic or nomenclatural categories. Best practice is to use a controlled vocabulary.

      Examples: Original publication of new combination (comb nov.)

      Returns:
      the publication type

    • setType

      public void setType(String type)

    • getSource

      @Nullable public String getSource()
      Specified by:
      getSource in interface NameUsageExtension
      Returns:
      a source reference string

    • setSource

      public void setSource(String source)
      Specified by:
      setSource in interface NameUsageExtension

    • 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

    • 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