org.gbif.api.model.common

Interface LinneanClassification

All Known Implementing Classes:

NameUsage, NameUsageContainer, NameUsageMatch, NameUsageSearchResult, NameUsageSuggestResult, Occurrence

public interface LinneanClassification

A flat taxonomic classification using the major, Linnean ranks with verbatim names.

Method Summary

Modifier and Type	Method and Description
String	getClazz() Return the class for this usage.
String	getFamily() Return the family for this usage.
String	getGenus() Return the genus for this usage.
String	getHigherRank(Rank rank) Gets a higher taxon property by passing the rank of it.
String	getKingdom() Return the kingdom for this usage.
String	getOrder() Return the order for this usage.
String	getPhylum() Return the phylum for this usage.
String	getSpecies() Return the species for this usage.
String	getSubgenus() Return the canonical subgenus name for this usage.
void	setClazz(String clazz)
void	setFamily(String family)
void	setGenus(String genus)
void	setKingdom(String kingdom)
void	setOrder(String order)
void	setPhylum(String phylum)
void	setSpecies(String species)
void	setSubgenus(String subgenus)

Method Detail

getClazz

@Nullable
String getClazz()

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

Returns:

the class

setClazz

void setClazz(String clazz)

Parameters:

clazz - the clazz to set

getFamily

@Nullable
String getFamily()

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

Returns:

the family

setFamily

void setFamily(String family)

Parameters:

family - the family to set

getGenus

@Nullable
String getGenus()

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

Returns:

the genus

setGenus

void setGenus(String genus)

Parameters:

genus - the genus to set

getKingdom

@Nullable
String getKingdom()

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

Returns:

the kingdom

setKingdom

void setKingdom(String kingdom)

Parameters:

kingdom - the kingdom to set

getOrder

@Nullable
String getOrder()

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

Returns:

the order

setOrder

void setOrder(String order)

Parameters:

order - the order to set

getPhylum

@Nullable
String getPhylum()

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

Returns:

the phylum

setPhylum

void setPhylum(String phylum)

Parameters:

phylum - the phylum to set

getSpecies

@Nullable
String getSpecies()

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

Returns:

the species

setSpecies

void setSpecies(String species)

Parameters:

species - the species to set

getSubgenus

@Nullable
String getSubgenus()

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

Returns:

the subgenus name

setSubgenus

void setSubgenus(String subgenus)

Parameters:

subgenus - the subgenus canonical name

getHigherRank

@Nullable
String getHigherRank(Rank rank)

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

Parameters:

rank - the higher linnean rank to retrieve

Returns:

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