Package org.gbif.api.model.checklistbank

Class VernacularName

java.lang.Object
org.gbif.api.model.checklistbank.VernacularName
All Implemented Interfaces:
NameUsageExtension
public class VernacularName extends Object implements NameUsageExtension
VernacularName Model Object represents a vernacular name for a scientific taxon.
See Also:

  • Constructor Details

  • Method Details

    • getTaxonKey

      public Integer getTaxonKey()
      The name usage "taxon" key to which this vernacular name belongs.
      Specified by:
      getTaxonKey in interface NameUsageExtension

    • setTaxonKey

      public void setTaxonKey(Integer taxonKey)
      Specified by:
      setTaxonKey in interface NameUsageExtension

    • getArea

      @Nullable public String getArea()
      The area for the vernacular name.
      Returns:
      the area

    • setArea

      public void setArea(String area)
      Parameters:
      area - the area to set

    • getCountry

      @Nullable public Country getCountry()
      The country in which the vernacular name is used.
      Returns:
      the country

    • setCountry

      public void setCountry(Country country)
      Parameters:
      country - the country to set

    • getLanguage

      @Nullable public Language getLanguage()
      ISO 639-1 language code used for the vernacular name value.

      Example: es

      Returns:
      the language

    • setLanguage

      public void setLanguage(Language language)
      Parameters:
      language - the language to set

    • getLifeStage

      @Nullable public LifeStage getLifeStage()
      The age class or life stage of the species for which the vernacular name applies. Best practice is to utilise a controlled list of terms for this value.

      Example: "juvenile" is the life stage of the fish Pomatomus saltatrix for which the name "snapper blue" refers.

      Returns:
      the lifeStage
      See Also:

    • setLifeStage

      public void setLifeStage(LifeStage lifeStage)
      Parameters:
      lifeStage - the lifeStage to set

    • getSex

      @Nullable public Sex getSex()
      The sex (gender) of the taxon for which the vernacular name applies when the vernacular name is limited to a specific gender of a species. If not limited sex should be empty. For example the vernacular name "Buck" applies to the "Male" gender of the species, Odocoileus virginianus.

      Example: male.

      Returns:
      the sex
      See Also:

    • setSex

      public void setSex(Sex sex)
      Parameters:
      sex - the sex to set

    • getSource

      @Nullable public String getSource()
      Bibliographic citation referencing a source where the vernacular name refers to the cited species.

      Example: Peterson Field Guide to the Eastern Seashore, Houghton Mifflin Co, 1961, p131.

      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

    • getVernacularName

      @NotNull public @NotNull String getVernacularName()
      A common or vernacular name.

      Example: Andean Condor", "Condor Andino", "American Eagle", "Gänsegeier".

      Returns:
      the vernacularName

    • setVernacularName

      public void setVernacularName(String vernacularName)
      Parameters:
      vernacularName - the vernacularName to set

    • isPlural

      @Nullable public Boolean isPlural()
      This value is true if the vernacular name it qualifies refers to a plural form of the name.

      Example: The term "Schoolies" is the plural form of a name used along the coastal Northeastern U.S. for groups of juvenile fish of the species, Morone saxatilis.

      Returns:
      the plural
      See Also:

    • setPlural

      public void setPlural(Boolean plural)
      Parameters:
      plural - the plural to set

    • isPreferred

      @Nullable public Boolean isPreferred()
      This term is true if the source citing the use of this vernacular name indicates the usage has some preference or specific standing over other possible vernacular names used for the species.

      Example: Some organisations have attempted to assign specific and unique vernacular names for particular taxon groups in a systematic attempt to bring order and consistency to the use of these names. For example, the American Ornithological Union assigns the name "Pearl Kite" for the taxon, Gampsonyx swainsonii. The value of isPreferredName for this record would be true.

      Returns:
      the preferred
      See Also:

    • setPreferred

      public void setPreferred(Boolean preferred)
      Parameters:
      preferred - the preferred 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