Package org.gbif.api.model.checklistbank

Class NameUsageMatch

java.lang.Object

org.gbif.api.model.checklistbank.NameUsageMatch

All Implemented Interfaces:

Serializable, LinneanClassification, LinneanClassificationKeys

public class NameUsageMatch
extends Object
implements LinneanClassification, LinneanClassificationKeys, Serializable

The resulting lookup of a name usage match. A single name usage key with its Linnean classification and a confidence value for the match.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NameUsageMatch.MatchType

Constructor Summary

Constructors

Constructor	Description
NameUsageMatch()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Integer	getAcceptedUsageKey()	The key of the accepted name usage in case the matched usage was a synonym.
List<NameUsageMatch>	getAlternatives()
String	getCanonicalName()
Integer	getClassKey()	Return the class key for this usage.
String	getClazz()	Return the class for this usage.
@Min(0L) @Max(100L) Integer	getConfidence()	The confidence that the lookup was correct.
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.
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.
String	getKingdom()	Return the kingdom for this usage.
Integer	getKingdomKey()	Return the kingdom key for this usage.
NameUsageMatch.MatchType	getMatchType()
String	getNote()	Optional notes on the matching.
String	getOrder()	Return the order for this usage.
Integer	getOrderKey()	Return the order key for this usage.
String	getPhylum()	Return the phylum for this usage.
Integer	getPhylumKey()	Return the phylum key for this usage.
Rank	getRank()
String	getScientificName()	The scientific name of the matched name usage.
String	getSpecies()	Return the species for this usage.
Integer	getSpeciesKey()	Return the species key for this usage.
TaxonomicStatus	getStatus()	The taxonomic status of the backbone usage.
String	getSubgenus()	Return the canonical subgenus name for this usage.
Integer	getSubgenusKey()	Return the subgenus key for this usage.
Integer	getUsageKey()	The name usage key of the name usage that has been matched.
int	hashCode()
boolean	isSynonym()
void	setAcceptedUsageKey(Integer acceptedUsageKey)
void	setAlternatives(List<NameUsageMatch> alternatives)
void	setCanonicalName(String canonicalName)
void	setClassKey(Integer classKey)
void	setClazz(String clazz)
void	setConfidence(Integer confidence)
void	setFamily(String family)
void	setFamilyKey(Integer familyKey)
void	setGenus(String genus)
void	setGenusKey(Integer genusKey)
void	setKingdom(String kingdom)
void	setKingdomKey(Integer kingdomKey)
void	setMatchType(NameUsageMatch.MatchType matchType)
void	setNote(String note)
void	setOrder(String order)
void	setOrderKey(Integer orderKey)
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)
void	setUsageKey(Integer usageKey)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NameUsageMatch

public NameUsageMatch()

Method Details

getConfidence

@Min(0L)
@Max(100L)
public @Min(0L) @Max(100L) Integer getConfidence()

The confidence that the lookup was correct. A value between 0 and 100 with higher values being better matches.

Returns:

the lookup confidence

setConfidence

public void setConfidence(Integer confidence)

Parameters:

confidence - the confidence to set

getMatchType

public NameUsageMatch.MatchType getMatchType()

Returns:

the type of match for this result

setMatchType

public void setMatchType(NameUsageMatch.MatchType matchType)

getRank

@Nullable
public Rank getRank()

Returns:

the rank of the matching usage

setRank

public void setRank(Rank rank)

getScientificName

@Nullable
public String getScientificName()

The scientific name of the matched name usage.

Returns:

the scientific name of the matched usage

setScientificName

public void setScientificName(String scientificName)

getUsageKey

@Nullable
public Integer getUsageKey()

The name usage key of the name usage that has been matched.

Returns:

the usageKey

setUsageKey

public void setUsageKey(Integer usageKey)

Parameters:

usageKey - the usageKey to set

getAcceptedUsageKey

@Nullable
public Integer getAcceptedUsageKey()

The key of the accepted name usage in case the matched usage was a synonym.

setAcceptedUsageKey

public void setAcceptedUsageKey(Integer acceptedUsageKey)

isSynonym

public boolean isSynonym()

Returns:

true if it's a synonym

getStatus

public TaxonomicStatus getStatus()

The taxonomic status of the backbone usage. This field is required and only 3 values are allowed:

• accepted: regular accepted taxon
• synonym: any kind of synonym
• doubtful: treated as accepted but in doubt for some reason

setStatus

public void setStatus(TaxonomicStatus status)

getKingdom

@Nullable
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

setKingdom

public void setKingdom(String kingdom)

Specified by:

setKingdom in interface LinneanClassification

Parameters:

kingdom - the kingdom to set

getPhylum

@Nullable
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

setPhylum

public void setPhylum(String phylum)

Specified by:

setPhylum in interface LinneanClassification

Parameters:

phylum - the phylum to set

getClazz

@Nullable
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

setClazz

public void setClazz(String clazz)

Specified by:

setClazz in interface LinneanClassification

Parameters:

clazz - the clazz to set

getOrder

@Nullable
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

setOrder

public void setOrder(String order)

Specified by:

setOrder in interface LinneanClassification

Parameters:

order - the order to set

getFamily

@Nullable
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

setFamily

public void setFamily(String family)

Specified by:

setFamily in interface LinneanClassification

Parameters:

family - the family to set

getGenus

@Nullable
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

setGenus

public void setGenus(String genus)

Specified by:

setGenus in interface LinneanClassification

Parameters:

genus - the genus to set

getSubgenus

@Nullable
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

setSubgenus

public void setSubgenus(String subgenus)

Specified by:

setSubgenus in interface LinneanClassification

Parameters:

subgenus - the subgenus canonical name

getSpecies

@Nullable
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

setSpecies

public void setSpecies(String species)

Specified by:

setSpecies in interface LinneanClassification

Parameters:

species - the species to set

getKingdomKey

@Nullable
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

setKingdomKey

public void setKingdomKey(Integer kingdomKey)

Specified by:

setKingdomKey in interface LinneanClassificationKeys

Parameters:

kingdomKey - the kingdomKey to set

getPhylumKey

@Nullable
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

setPhylumKey

public void setPhylumKey(Integer phylumKey)

Specified by:

setPhylumKey in interface LinneanClassificationKeys

Parameters:

phylumKey - the phylumKey to set

getClassKey

@Nullable
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

setClassKey

public void setClassKey(Integer classKey)

Specified by:

setClassKey in interface LinneanClassificationKeys

Parameters:

classKey - the classKey to set

getOrderKey

@Nullable
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

setOrderKey

public void setOrderKey(Integer orderKey)

Specified by:

setOrderKey in interface LinneanClassificationKeys

Parameters:

orderKey - the orderKey to set

getFamilyKey

@Nullable
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

setFamilyKey

public void setFamilyKey(Integer familyKey)

Specified by:

setFamilyKey in interface LinneanClassificationKeys

Parameters:

familyKey - the familyKey to set

getGenusKey

@Nullable
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

setGenusKey

public void setGenusKey(Integer genusKey)

Specified by:

setGenusKey in interface LinneanClassificationKeys

Parameters:

genusKey - the genusKey to set

getSubgenusKey

@Nullable
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

setSubgenusKey

public void setSubgenusKey(Integer subgenusKey)

Specified by:

setSubgenusKey in interface LinneanClassificationKeys

Parameters:

subgenusKey - the subgenus usage key

getSpeciesKey

@Nullable
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

setSpeciesKey

public void setSpeciesKey(Integer speciesKey)

Specified by:

setSpeciesKey in interface LinneanClassificationKeys

Parameters:

speciesKey - the speciesKey to set

getHigherRank

@Nullable
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

getCanonicalName

@Nullable
public String getCanonicalName()

setCanonicalName

public void setCanonicalName(String canonicalName)

getNote

@Nullable
public String getNote()

Optional notes on the matching.

setNote

public void setNote(String note)

getAlternatives

@Nullable
public List<NameUsageMatch> getAlternatives()

Returns:

a list of alternative matches considered

setAlternatives

public void setAlternatives(List<NameUsageMatch> alternatives)

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