Package org.gbif.api.model.checklistbank.search

Class NameUsageSuggestResult

java.lang.Object

org.gbif.api.model.checklistbank.search.NameUsageSuggestResult

All Implemented Interfaces:

LinneanClassification, LinneanClassificationKeys

public class NameUsageSuggestResult
extends Object
implements LinneanClassification, LinneanClassificationKeys

Class used for returning results of a suggest operation. This class contains additional attributes that are required for displaying/providing textual information.

Constructor Summary

Constructors

Constructor	Description
NameUsageSuggestResult()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getCanonicalName()
Integer	getClassKey()	Return the class key for this usage.
String	getClazz()	Return the class for this usage.
String	getFamily()	Return the family for this usage.
Integer	getFamilyKey()	Return the family key for this usage.
String	getGenus()	Return the genus for this usage.
Integer	getGenusKey()	Return the genus key for this usage.
@NotNull LinkedHashMap<Integer,String>	getHigherClassificationMap()	An ordered map with entries for all higher Linnean ranks down to the actual direct parent of this usage.
String	getHigherRank(Rank rank)	Gets a higher taxon property by passing the rank of it.
Integer	getHigherRankKey(Rank rank)	Gets a higher taxon key by passing the rank of it.
Integer	getKey()	Taxon key.
String	getKingdom()	Return the kingdom for this usage.
Integer	getKingdomKey()	Return the kingdom key for this usage.
Integer	getNameKey()
Integer	getNubKey()
String	getOrder()	Return the order for this usage.
Integer	getOrderKey()	Return the order key for this usage.
String	getParent()
Integer	getParentKey()
String	getPhylum()	Return the phylum for this usage.
Integer	getPhylumKey()	Return the phylum key for this usage.
Rank	getRank()
String	getScientificName()
String	getSpecies()	Return the species for this usage.
Integer	getSpeciesKey()	Return the species key for this usage.
TaxonomicStatus	getStatus()
String	getSubgenus()	Return the canonical subgenus name for this usage.
Integer	getSubgenusKey()	Return the subgenus key for this usage.
int	hashCode()
boolean	isSynonym()
void	setCanonicalName(String canonicalName)
void	setClassKey(Integer classKey)
void	setClazz(String clazz)
void	setFamily(String family)
void	setFamilyKey(Integer familyKey)
void	setGenus(String genus)
void	setGenusKey(Integer genusKey)
void	setKey(Integer key)
void	setKingdom(String kingdom)
void	setKingdomKey(Integer kingdomKey)
void	setNameKey(Integer nameKey)
void	setNubKey(Integer nubKey)
void	setOrder(String order)
void	setOrderKey(Integer orderKey)
void	setParent(String parent)
void	setParentKey(Integer parentKey)
void	setPhylum(String phylum)
void	setPhylumKey(Integer phylumKey)
void	setRank(Rank rank)
void	setScientificName(String scientificName)
void	setSpecies(String species)
void	setSpeciesKey(Integer speciesKey)
void	setStatus(TaxonomicStatus status)
void	setSubgenus(String subgenus)
void	setSubgenusKey(Integer subgenusKey)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NameUsageSuggestResult

public NameUsageSuggestResult()

Method Details

getNameKey

public Integer getNameKey()

Returns:

the name key for retrieving a parsed name object

setNameKey

public void setNameKey(Integer nameKey)

isSynonym

public boolean isSynonym()

Returns:

true if its a synonym

getScientificName

public String getScientificName()

setScientificName

public void setScientificName(String scientificName)

getStatus

public TaxonomicStatus getStatus()

setStatus

public void setStatus(TaxonomicStatus status)

getNubKey

public Integer getNubKey()

setNubKey

public void setNubKey(Integer nubKey)

getKey

public Integer getKey()

Taxon key.

getKingdom

public String getKingdom()

Description copied from interface: LinneanClassification

Return the kingdom for this usage. If the usage is for something above the "kingdom" taxonomic level, return null.

Specified by:

getKingdom in interface LinneanClassification

Returns:

the kingdom

getPhylum

public String getPhylum()

Description copied from interface: LinneanClassification

Return the phylum for this usage. If the usage is for something above the "phylum" taxonomic level, return null.

Specified by:

getPhylum in interface LinneanClassification

Returns:

the phylum

getClazz

public String getClazz()

Description copied from interface: LinneanClassification

Return the class for this usage. If the usage is for something above the "class" taxonomic level, return null.

Specified by:

getClazz in interface LinneanClassification

Returns:

the class

getOrder

public String getOrder()

Description copied from interface: LinneanClassification

Return the order for this usage. If the usage is for something above the "order" taxonomic level, return null.

Specified by:

getOrder in interface LinneanClassification

Returns:

the order

getFamily

public String getFamily()

Description copied from interface: LinneanClassification

Return the family for this usage. If the usage is for something above the "family" taxonomic level, return null.

Specified by:

getFamily in interface LinneanClassification

Returns:

the family

getGenus

public String getGenus()

Description copied from interface: LinneanClassification

Return the genus for this usage. If the usage is for something above the "genus" taxonomic level, return null.

Specified by:

getGenus in interface LinneanClassification

Returns:

the genus

getSubgenus

public String getSubgenus()

Description copied from interface: LinneanClassification

Return the canonical subgenus name for this usage. If the usage is for something above the "subgenus" taxonomic level, return null.

Specified by:

getSubgenus in interface LinneanClassification

Returns:

the subgenus name

getSpecies

public String getSpecies()

Description copied from interface: LinneanClassification

Return the species for this usage. If the usage is for something above the "species" taxonomic level, return null.

Specified by:

getSpecies in interface LinneanClassification

Returns:

the species

getKingdomKey

public Integer getKingdomKey()

Description copied from interface: LinneanClassificationKeys

Return the kingdom key for this usage. If the usage is for something above the "kingdom" taxonomic level, return null.

Specified by:

getKingdomKey in interface LinneanClassificationKeys

Returns:

the kingdomKey

getPhylumKey

public Integer getPhylumKey()

Description copied from interface: LinneanClassificationKeys

Return the phylum key for this usage. If the usage is for something above the "phylum" taxonomic level, return null.

Specified by:

getPhylumKey in interface LinneanClassificationKeys

Returns:

the phylumKey

getClassKey

public Integer getClassKey()

Description copied from interface: LinneanClassificationKeys

Return the class key for this usage. If the usage is for something above the "class" taxonomic level, return null.

Specified by:

getClassKey in interface LinneanClassificationKeys

Returns:

the classKey

getOrderKey

public Integer getOrderKey()

Description copied from interface: LinneanClassificationKeys

Return the order key for this usage. If the usage is for something above the "order" taxonomic level, return null.

Specified by:

getOrderKey in interface LinneanClassificationKeys

Returns:

the orderKey

getFamilyKey

public Integer getFamilyKey()

Description copied from interface: LinneanClassificationKeys

Return the family key for this usage. If the usage is for something above the "family" taxonomic level, return null.

Specified by:

getFamilyKey in interface LinneanClassificationKeys

Returns:

the familyKey

getGenusKey

public Integer getGenusKey()

Description copied from interface: LinneanClassificationKeys

Return the genus key for this usage. If the usage is for something above the "genus" taxonomic level, return null.

Specified by:

getGenusKey in interface LinneanClassificationKeys

Returns:

the genusKey

getSubgenusKey

public Integer getSubgenusKey()

Description copied from interface: LinneanClassificationKeys

Return the subgenus key for this usage. If the usage is for something above the "subgenus" taxonomic level, return null.

Specified by:

getSubgenusKey in interface LinneanClassificationKeys

Returns:

subgenusKey

getSpeciesKey

public Integer getSpeciesKey()

Description copied from interface: LinneanClassificationKeys

Return the species key for this usage. If the usage is for something above the "species" taxonomic level, return null.

Specified by:

getSpeciesKey in interface LinneanClassificationKeys

Returns:

the speciesKey

getCanonicalName

public String getCanonicalName()

setCanonicalName

public void setCanonicalName(String canonicalName)

setClassKey

public void setClassKey(Integer classKey)

Specified by:

setClassKey in interface LinneanClassificationKeys

Parameters:

classKey - the classKey to set

setClazz

public void setClazz(String clazz)

Specified by:

setClazz in interface LinneanClassification

Parameters:

clazz - the clazz to set

setFamily

public void setFamily(String family)

Specified by:

setFamily in interface LinneanClassification

Parameters:

family - the family to set

setFamilyKey

public void setFamilyKey(Integer familyKey)

Specified by:

setFamilyKey in interface LinneanClassificationKeys

Parameters:

familyKey - the familyKey to set

setGenus

public void setGenus(String genus)

Specified by:

setGenus in interface LinneanClassification

Parameters:

genus - the genus to set

setGenusKey

public void setGenusKey(Integer genusKey)

Specified by:

setGenusKey in interface LinneanClassificationKeys

Parameters:

genusKey - the genusKey to set

setKey

public void setKey(Integer key)

setKingdom

public void setKingdom(String kingdom)

Specified by:

setKingdom in interface LinneanClassification

Parameters:

kingdom - the kingdom to set

setKingdomKey

public void setKingdomKey(Integer kingdomKey)

Specified by:

setKingdomKey in interface LinneanClassificationKeys

Parameters:

kingdomKey - the kingdomKey to set

setOrder

public void setOrder(String order)

Specified by:

setOrder in interface LinneanClassification

Parameters:

order - the order to set

setOrderKey

public void setOrderKey(Integer orderKey)

Specified by:

setOrderKey in interface LinneanClassificationKeys

Parameters:

orderKey - the orderKey to set

setPhylum

public void setPhylum(String phylum)

Specified by:

setPhylum in interface LinneanClassification

Parameters:

phylum - the phylum to set

setPhylumKey

public void setPhylumKey(Integer phylumKey)

Specified by:

setPhylumKey in interface LinneanClassificationKeys

Parameters:

phylumKey - the phylumKey to set

setSpecies

public void setSpecies(String species)

Specified by:

setSpecies in interface LinneanClassification

Parameters:

species - the species to set

setSpeciesKey

public void setSpeciesKey(Integer speciesKey)

Specified by:

setSpeciesKey in interface LinneanClassificationKeys

Parameters:

speciesKey - the speciesKey to set

setSubgenus

public void setSubgenus(String subgenus)

Specified by:

setSubgenus in interface LinneanClassification

Parameters:

subgenus - the subgenus canonical name

setSubgenusKey

public void setSubgenusKey(Integer subgenusKey)

Specified by:

setSubgenusKey in interface LinneanClassificationKeys

Parameters:

subgenusKey - the subgenus usage key

getParent

public String getParent()

getParentKey

public Integer getParentKey()

setParent

public void setParent(String parent)

setParentKey

public void setParentKey(Integer parentKey)

getRank

public Rank getRank()

setRank

public void setRank(Rank rank)

getHigherRank

public String getHigherRank(Rank rank)

Description copied from interface: LinneanClassification

Gets a higher taxon property by passing the rank of it. Only Linnean ranks are supported.

Specified by:

getHigherRank in interface LinneanClassification

Parameters:

rank - the higher linnean rank to retrieve

Returns:

the name of the higher taxon or null if rank doesnt exist

getHigherRankKey

public Integer getHigherRankKey(Rank rank)

Description copied from interface: LinneanClassificationKeys

Gets a higher taxon key by passing the rank of it. Only Linnean ranks are supported.

Specified by:

getHigherRankKey in interface LinneanClassificationKeys

Parameters:

rank - the higher linnean rank to retrieve

Returns:

the key of the higher taxon or null if rank doesnt exist

getHigherClassificationMap

@NotNull
public @NotNull LinkedHashMap<Integer,String> getHigherClassificationMap()

An ordered map with entries for all higher Linnean ranks down to the actual direct parent of this usage. The map starts with the highest rank, e.g. the kingdom and maps the name usage key to its canonical name. The name usage itself is never included, even though a higher rank might point to the usage itself.

Returns:

map of higher ranks

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