SpeciesProfile (GBIF Common :: API 1.16.18 API)

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 and Description

SpeciesProfile()

Constructors
Constructor and Description
`SpeciesProfile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Integer`	`getAgeInDays()` Maximum observed age of an organism given as number of days.
`String`	`getHabitat()` Comma separated list of mayor habitat classification as defined by IUCN in which a species is known to exist: Habitats Vocabulary
`String`	`getLifeForm()` A term describing the growth/lifeform of an organism.
`String`	`getLivingPeriod()` The (geological) time a currently extinct organism is known to have lived.
`Integer`	`getMassInGram()` Maximum observed weight of an organism in grams.
`Integer`	`getSizeInMillimeter()` Maximum observed size of an organism in millimetres.
`String`	`getSource()`
`Integer`	`getSourceTaxonKey()` If the source is another name usage this is the taxonKey of that usage.
`Integer`	`getTaxonKey()` The name usage "taxon" key this species profile belongs to.
`int`	`hashCode()`
`Boolean`	`isExtinct()` Flag indicating an extinct organism.
`Boolean`	`isFreshwater()` A Boolean flag indicating whether the taxon is a freshwater organism.
`Boolean`	`isHybrid()` Flag indicating a hybrid organism.
`Boolean`	`isMarine()` A Boolean flag indicating whether the taxon is a marine organism, i.e.
`Boolean`	`isTerrestrial()` A Boolean flag indicating the taxon is a terrestrial organism, i.e.
`void`	`setAgeInDays(Integer ageInDays)`
`void`	`setExtinct(Boolean extinct)`
`void`	`setFreshwater(Boolean freshwater)`
`void`	`setHabitat(String habitat)`
`void`	`setHybrid(Boolean hybrid)`
`void`	`setLifeForm(String lifeForm)`
`void`	`setLivingPeriod(String livingPeriod)`
`void`	`setMarine(Boolean marine)`
`void`	`setMassInGram(Integer massInGram)`
`void`	`setSizeInMillimeter(Integer sizeInMillimeter)`
`void`	`setSource(String source)`
`void`	`setSourceTaxonKey(Integer sourceTaxonKey)`
`void`	`setTaxonKey(Integer taxonKey)`
`void`	`setTerrestrial(Boolean terrestrial)`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SpeciesProfile
```
public SpeciesProfile()
```
- Method Detail
  - getTaxonKey
```
public Integer getTaxonKey()
```
    The name usage "taxon" key this species profile belongs to.
    
    Specified by:
    
    getTaxonKey in interface NameUsageExtension
  - setTaxonKey
```
public void setTaxonKey(Integer taxonKey)
```
    Specified by:
    
    setTaxonKey in interface NameUsageExtension
  - 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 Vocabulary
    
    Example: 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.xml
    
    Example: 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_column
    
    Example: 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
  - setHybrid
```
public void setHybrid(Boolean hybrid)
```
    Parameters:
    
    hybrid - the hybrid to set
  - isMarine
```
@Nullable
public Boolean isMarine()
```
    A Boolean flag indicating whether the taxon is a marine organism, i.e. can be found in/above sea water
    
    Example: true - false.
    
    Returns:
    
    is marine flag
  - setMarine
```
public void setMarine(Boolean marine)
```
    Parameters:
    
    marine - the marine to set
  - 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:
    
    getSource in interface NameUsageExtension
    
    Returns:
    
    a source reference string
  - setSource
```
public void setSource(String source)
```
    Specified by:
    
    setSource in interface NameUsageExtension
  - getSourceTaxonKey
```
@Nullable
public Integer getSourceTaxonKey()
```
    Description copied from interface: NameUsageExtension
    
    If the source is another name usage this is the taxonKey of that usage. Only useful for the backbone dataset.
    
    Specified by:
    
    getSourceTaxonKey in interface NameUsageExtension
    
    Returns:
    
    The key of the name usage this instance is derived from.
  - setSourceTaxonKey
```
public void setSourceTaxonKey(Integer sourceTaxonKey)
```
    Specified by:
    
    setSourceTaxonKey in interface NameUsageExtension
  - 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

Class SpeciesProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpeciesProfile

Method Detail

getTaxonKey

setTaxonKey

getAgeInDays

setAgeInDays

isFreshwater

setFreshwater

getHabitat

setHabitat

getLifeForm

setLifeForm

getLivingPeriod

setLivingPeriod

getMassInGram

setMassInGram

getSizeInMillimeter

setSizeInMillimeter

isExtinct

setExtinct

isHybrid

setHybrid

isMarine

setMarine

isTerrestrial

setTerrestrial

getSource

setSource

getSourceTaxonKey

setSourceTaxonKey

equals

hashCode

toString