Package org.gbif.api.model.common

Interface LinneanClassificationKeys

All Known Implementing Classes:
NameUsage, NameUsageContainer, NameUsageMatch, NameUsageSearchResult, NameUsageSuggestResult, Occurrence
public interface LinneanClassificationKeys
A flat taxonomic classification using the major, Linnean ranks with verbatim names and integer based keys.

  • Method Details

    • getClassKey

      @Nullable Integer getClassKey()
      Return the class key for this usage. If the usage is for something above the "class" taxonomic level, return null.
      Returns:
      the classKey

    • setClassKey

      void setClassKey(Integer classKey)
      Parameters:
      classKey - the classKey to set

    • getFamilyKey

      @Nullable Integer getFamilyKey()
      Return the family key for this usage. If the usage is for something above the "family" taxonomic level, return null.
      Returns:
      the familyKey

    • setFamilyKey

      void setFamilyKey(Integer familyKey)
      Parameters:
      familyKey - the familyKey to set

    • getGenusKey

      @Nullable Integer getGenusKey()
      Return the genus key for this usage. If the usage is for something above the "genus" taxonomic level, return null.
      Returns:
      the genusKey

    • setGenusKey

      void setGenusKey(Integer genusKey)
      Parameters:
      genusKey - the genusKey to set

    • getKingdomKey

      @Nullable Integer getKingdomKey()
      Return the kingdom key for this usage. If the usage is for something above the "kingdom" taxonomic level, return null.
      Returns:
      the kingdomKey

    • setKingdomKey

      void setKingdomKey(Integer kingdomKey)
      Parameters:
      kingdomKey - the kingdomKey to set

    • getOrderKey

      @Nullable Integer getOrderKey()
      Return the order key for this usage. If the usage is for something above the "order" taxonomic level, return null.
      Returns:
      the orderKey

    • setOrderKey

      void setOrderKey(Integer orderKey)
      Parameters:
      orderKey - the orderKey to set

    • getPhylumKey

      @Nullable Integer getPhylumKey()
      Return the phylum key for this usage. If the usage is for something above the "phylum" taxonomic level, return null.
      Returns:
      the phylumKey

    • setPhylumKey

      void setPhylumKey(Integer phylumKey)
      Parameters:
      phylumKey - the phylumKey to set

    • getSpeciesKey

      @Nullable Integer getSpeciesKey()
      Return the species key for this usage. If the usage is for something above the "species" taxonomic level, return null.
      Returns:
      the speciesKey

    • setSpeciesKey

      void setSpeciesKey(Integer speciesKey)
      Parameters:
      speciesKey - the speciesKey to set

    • getSubgenusKey

      @Nullable Integer getSubgenusKey()
      Return the subgenus key for this usage. If the usage is for something above the "subgenus" taxonomic level, return null.
      Returns:
      subgenusKey

    • setSubgenusKey

      void setSubgenusKey(Integer subgenusKey)
      Parameters:
      subgenusKey - the subgenus usage key

    • getHigherRankKey

      @Nullable Integer getHigherRankKey(Rank rank)
      Gets a higher taxon key by passing the rank of it. Only Linnean ranks are supported.
      Parameters:
      rank - the higher linnean rank to retrieve
      Returns:
      the key of the higher taxon or null if rank doesnt exist