Package org.gbif.api.model.checklistbank
Class SpeciesProfile
- java.lang.Object
-
- org.gbif.api.model.checklistbank.SpeciesProfile
-
- All Implemented Interfaces:
NameUsageExtension
public class SpeciesProfile extends Object implements NameUsageExtension
SpeciesProfile Model Object represents a species profile which describes basic species characteristics.- See Also:
- Species Profile Extension Definition
-
-
Constructor Summary
Constructors Constructor Description SpeciesProfile()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)IntegergetAgeInDays()Maximum observed age of an organism given as number of days.StringgetHabitat()Comma separated list of mayor habitat classification as defined by IUCN in which a species is known to exist: Habitats VocabularyStringgetLifeForm()A term describing the growth/lifeform of an organism.StringgetLivingPeriod()The (geological) time a currently extinct organism is known to have lived.IntegergetMassInGram()Maximum observed weight of an organism in grams.IntegergetSizeInMillimeter()Maximum observed size of an organism in millimetres.StringgetSource()IntegergetSourceTaxonKey()If the source is another name usage this is the taxonKey of that usage.IntegergetTaxonKey()The name usage "taxon" key this species profile belongs to.inthashCode()BooleanisExtinct()Flag indicating an extinct organism.BooleanisFreshwater()A Boolean flag indicating whether the taxon is a freshwater organism.BooleanisHybrid()Flag indicating a hybrid organism.BooleanisMarine()A Boolean flag indicating whether the taxon is a marine organism, i.e.BooleanisTerrestrial()A Boolean flag indicating the taxon is a terrestrial organism, i.e.voidsetAgeInDays(Integer ageInDays)voidsetExtinct(Boolean extinct)voidsetFreshwater(Boolean freshwater)voidsetHabitat(String habitat)voidsetHybrid(Boolean hybrid)voidsetLifeForm(String lifeForm)voidsetLivingPeriod(String livingPeriod)voidsetMarine(Boolean marine)voidsetMassInGram(Integer massInGram)voidsetSizeInMillimeter(Integer sizeInMillimeter)voidsetSource(String source)voidsetSourceTaxonKey(Integer sourceTaxonKey)voidsetTaxonKey(Integer taxonKey)voidsetTerrestrial(Boolean terrestrial)StringtoString()
-
-
-
Constructor Detail
-
SpeciesProfile
public SpeciesProfile()
-
-
Method Detail
-
getTaxonKey
public Integer getTaxonKey()
The name usage "taxon" key this species profile belongs to.- Specified by:
getTaxonKeyin interfaceNameUsageExtension
-
setTaxonKey
public void setTaxonKey(Integer taxonKey)
- Specified by:
setTaxonKeyin interfaceNameUsageExtension
-
getAgeInDays
@Nullable public Integer getAgeInDays()
Maximum observed age of an organism given as number of days.Example: 5.
- Returns:
- the ageInDays
-
setAgeInDays
public void setAgeInDays(Integer ageInDays)
- Parameters:
ageInDays- the ageInDays to set
-
isFreshwater
@Nullable public Boolean isFreshwater()
A Boolean flag indicating whether the taxon is a freshwater organism.- Returns:
- freshwater flag
-
setFreshwater
public void setFreshwater(Boolean freshwater)
-
getHabitat
@Nullable public String getHabitat()
Comma separated list of mayor habitat classification as defined by IUCN in which a species is known to exist: Habitats VocabularyExample: 1.1.
- Returns:
- the habitat
-
setHabitat
public void setHabitat(String habitat)
- Parameters:
habitat- the habitat to set.
-
getLifeForm
@Nullable public String getLifeForm()
A term describing the growth/lifeform of an organism. Should be based on a vocabulary like Raunkiær for plants: http://en.wikipedia.org/wiki/Raunkiær_plant_life- form. Recommended vocabulary: http://rs.gbif.org/vocabulary/gbif/life_form.xmlExample: Phanerophyte.
- Returns:
- the lifeForm
-
setLifeForm
public void setLifeForm(String lifeForm)
- Parameters:
lifeForm- the lifeForm to set
-
getLivingPeriod
@Nullable public String getLivingPeriod()
The (geological) time a currently extinct organism is known to have lived. For geological times of fossils ideally based on a vocabulary like http://en.wikipedia.org/wiki/Geologic_columnExample: Cretaceous.
- Returns:
- the livingPeriod
-
setLivingPeriod
public void setLivingPeriod(String livingPeriod)
- Parameters:
livingPeriod- the livingPeriod to set
-
getMassInGram
@Nullable public Integer getMassInGram()
Maximum observed weight of an organism in grams.Example: 12.
- Returns:
- the massInGram
-
setMassInGram
public void setMassInGram(Integer massInGram)
- Parameters:
massInGram- the massInGram to set
-
getSizeInMillimeter
@Nullable public Integer getSizeInMillimeter()
Maximum observed size of an organism in millimetres. Can be either height, length or width, whichever is greater.Example: 1500.
- Returns:
- the sizeInMillimeter
-
setSizeInMillimeter
public void setSizeInMillimeter(Integer sizeInMillimeter)
- Parameters:
sizeInMillimeter- the sizeInMillimeter to se
-
isExtinct
@Nullable public Boolean isExtinct()
Flag indicating an extinct organism. Details about the timeperiod the organism has lived in can be supplied below.Example: true - false.
- Returns:
- the extinct
-
setExtinct
public void setExtinct(Boolean extinct)
- Parameters:
extinct- the extinct to set
-
isHybrid
@Nullable public Boolean isHybrid()
Flag indicating a hybrid organism. This does not have to be reflected in the name, but can be based on other studies like chromosome numbers etc.Example: true - false.
- Returns:
- the hybrid
-
isMarine
@Nullable public Boolean isMarine()
A Boolean flag indicating whether the taxon is a marine organism, i.e. can be found in/above sea waterExample: true - false.
- Returns:
- is marine flag
-
isTerrestrial
@Nullable public Boolean isTerrestrial()
A Boolean flag indicating the taxon is a terrestrial organism, i.e. occurs on land as opposed to the sea.Example: true - false.
- Returns:
- the terrestrial
-
setTerrestrial
public void setTerrestrial(Boolean terrestrial)
- Parameters:
terrestrial- the terrestrial to set
-
getSource
@Nullable public String getSource()
- Specified by:
getSourcein interfaceNameUsageExtension- Returns:
- a source reference string
-
setSource
public void setSource(String source)
- Specified by:
setSourcein interfaceNameUsageExtension
-
getSourceTaxonKey
@Nullable public Integer getSourceTaxonKey()
Description copied from interface:NameUsageExtensionIf the source is another name usage this is the taxonKey of that usage. Only useful for the backbone dataset.- Specified by:
getSourceTaxonKeyin interfaceNameUsageExtension- Returns:
- The key of the name usage this instance is derived from.
-
setSourceTaxonKey
public void setSourceTaxonKey(Integer sourceTaxonKey)
- Specified by:
setSourceTaxonKeyin interfaceNameUsageExtension
-
-