Distribution (GBIF Common :: API 1.16.18 API)

java.lang.Object
- org.gbif.api.model.checklistbank.Distribution

All Implemented Interfaces:

NameUsageExtension
```
public class Distribution
extends Object
implements NameUsageExtension
```
Distribution Model Object represents a species distribution.

See Also:

Distribution Definition

Constructor Summary

Constructors
Constructor and Description

Distribution()

Constructors
Constructor and Description
`Distribution()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`CitesAppendix`	`getAppendixCites()` The CITES (Convention on International Trade in Endangered Species of Wild Fauna and Flora) Appendix number under which the taxon is listed.
`Country`	`getCountry()`
`@Min(value=1L) @Max(value=366L) Integer`	`getEndDayOfYear()` Seasonal temporal subcontext within the eventDate context.
`EstablishmentMeans`	`getEstablishmentMeans()` Term describing whether the organism occurs natively, is introduced or cultivated.
`LifeStage`	`getLifeStage()` The distribution information pertains solely to a specific life stage of the taxon.
`String`	`getLocality()` The verbatim name of the area this distribution record is about.
`String`	`getLocationId()` A code for the named area this distributon record is about.
`String`	`getRemarks()` Additional notes on the distribution.
`String`	`getSource()` Source reference for this distribution record.
`Integer`	`getSourceTaxonKey()` If the source is another name usage this is the taxonKey of that usage.
`@Min(value=1L) @Max(value=366L) Integer`	`getStartDayOfYear()` Seasonal temporal subcontext within the eventDate context.
`DistributionStatus`	`getStatus()` Term describing the occurrence status of the organism in the given area based on how frequent the species occurs.
`Integer`	`getTaxonKey()` The name usage "taxon" key this description belongs to.
`String`	`getTemporal()` Relevant temporal context for this entire distribution record including all properties preferably given as a year range or single year on which the distribution record is valid.
`ThreatStatus`	`getThreatStatus()` Threat status of a species as defined by IUCN (http://www.iucnredlist.org/static/categories_criteria_3_1#categories).
`int`	`hashCode()`
`void`	`setAppendixCites(CitesAppendix appendixCites)`
`void`	`setCountry(Country country)`
`void`	`setEndDayOfYear(Integer endDayOfYear)`
`void`	`setEstablishmentMeans(EstablishmentMeans establishmentMeans)`
`void`	`setLifeStage(LifeStage lifeStage)`
`void`	`setLocality(String locality)`
`void`	`setLocationId(String locationId)`
`void`	`setRemarks(String remarks)`
`void`	`setSource(String source)`
`void`	`setSourceTaxonKey(Integer sourceTaxonKey)`
`void`	`setStartDayOfYear(Integer startDayOfYear)`
`void`	`setStatus(DistributionStatus status)`
`void`	`setTaxonKey(Integer taxonKey)`
`void`	`setTemporal(String temporal)`
`void`	`setThreatStatus(ThreatStatus threatStatus)`
`String`	`toString()`

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

- Constructor Detail
  - Distribution
```
public Distribution()
```
- Method Detail
  - getTaxonKey
```
public Integer getTaxonKey()
```
    The name usage "taxon" key this description belongs to.
    
    Specified by:
    
    getTaxonKey in interface NameUsageExtension
  - setTaxonKey
```
public void setTaxonKey(Integer taxonKey)
```
    Specified by:
    
    setTaxonKey in interface NameUsageExtension
  - getAppendixCites
```
@Nullable
public CitesAppendix getAppendixCites()
```
    The CITES (Convention on International Trade in Endangered Species of Wild Fauna and Flora) Appendix number under which the taxon is listed. It is possible to have different appendix numbers for different areas, but "global" as an area is also valid if it's the same worldwide see also http://www.cites.org/eng/app/index.shtml
    
    Example: II
    
    Returns:
    
    the appendixCites.
  - setAppendixCites
```
public void setAppendixCites(CitesAppendix appendixCites)
```
    Parameters:
    
    appendixCites - the appendixCites to set
  - getCountry
```
@Nullable
public Country getCountry()
```
    Returns:
    
    the country
  - setCountry
```
public void setCountry(Country country)
```
    Parameters:
    
    country - the country to set
  - getEndDayOfYear
```
@Nullable
 @Min(value=1L)
 @Max(value=366L)
public @Min(value=1L) @Max(value=366L) Integer getEndDayOfYear()
```
    Seasonal temporal subcontext within the eventDate context. The latest ordinal day of the year on which the distribution record is valid.
    
    Example: 120
    
    Returns:
    
    the endDayOfYear.
  - setEndDayOfYear
```
public void setEndDayOfYear(Integer endDayOfYear)
```
    Parameters:
    
    endDayOfYear - the endDayOfYear to set
  - getEstablishmentMeans
```
@Nullable
public EstablishmentMeans getEstablishmentMeans()
```
    Term describing whether the organism occurs natively, is introduced or cultivated.
    
    Example: introduced
    
    Returns:
    
    the establishmentMeans
  - setEstablishmentMeans
```
public void setEstablishmentMeans(EstablishmentMeans establishmentMeans)
```
    Parameters:
    
    establishmentMeans - the establishmentMeans to set
  - getLifeStage
```
@Nullable
public LifeStage getLifeStage()
```
    The distribution information pertains solely to a specific life stage of the taxon.
    
    Example: adult
    
    Returns:
    
    the lifeStage
    
    See Also:
    
    life stage vocabulary for recommended values
  - setLifeStage
```
public void setLifeStage(LifeStage lifeStage)
```
    Parameters:
    
    lifeStage - the lifeStage to set
  - getLocality
```
@Nullable
public String getLocality()
```
    The verbatim name of the area this distribution record is about.
    
    Example: Patagonia
    
    Returns:
    
    the locality
  - setLocality
```
public void setLocality(String locality)
```
    Parameters:
    
    locality - the locality to set
  - getLocationId
```
public String getLocationId()
```
    A code for the named area this distributon record is about. See http://en.wikipedia.org/wiki/ISO_3166-2 for state codes within a country, otherwise use a prefix for each code to indicate the source of the code.
    
    Example: TDWG:AGS-TF Example: ISO3166:AR Example: WOEID:564721
    
    Returns:
    
    the location id
  - setLocationId
```
public void setLocationId(String locationId)
```
    Parameters:
    
    locationId - the locationId to set
  - getRemarks
```
@Nullable
public String getRemarks()
```
    Additional notes on the distribution.
    
    Returns:
    
    the notes
  - setRemarks
```
public void setRemarks(String remarks)
```
  - getSource
```
@Nullable
public String getSource()
```
    Source reference for this distribution record. Can be proper publication citation, a webpage URL, etc.
    
    Example: "Euro+Med Plantbase - the information resource for Euro-Mediterranean plant diversity (2006-). Published on the Internet http://ww2.bgbm.org/EuroPlusMed/ July, 2009"
    
    Specified by:
    
    getSource in interface NameUsageExtension
    
    Returns:
    
    the source
  - setSource
```
public void setSource(String source)
```
    Specified by:
    
    setSource in interface NameUsageExtension
    
    Parameters:
    
    source - the source to set
  - 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
  - getStartDayOfYear
```
@Nullable
 @Min(value=1L)
 @Max(value=366L)
public @Min(value=1L) @Max(value=366L) Integer getStartDayOfYear()
```
    Seasonal temporal subcontext within the eventDate context. Useful for migratory species. The earliest ordinal day of the year on which the distribution record is valid. Numbering starts with 1 for 1 January and ends with 365 or 366 for 31 December.
    
    Example: 90
    
    Returns:
    
    the startDayOfYear.
  - setStartDayOfYear
```
public void setStartDayOfYear(Integer startDayOfYear)
```
    Parameters:
    
    startDayOfYear - the startDayOfYear to set
  - getStatus
```
@Nullable
public DistributionStatus getStatus()
```
    Term describing the occurrence status of the organism in the given area based on how frequent the species occurs.
    
    Example: absent
    
    Returns:
    
    the status.
    
    See Also:
    
    occurrence status vocabulary for recommended values
  - setStatus
```
public void setStatus(DistributionStatus status)
```
    Parameters:
    
    status - the status to set
  - getTemporal
```
@Nullable
public String getTemporal()
```
    Relevant temporal context for this entire distribution record including all properties preferably given as a year range or single year on which the distribution record is valid. For the same area and taxon there could therefore be several records with different temporal context, e.g. in 5-year intervals for invasive species.
    
    Example: "1930"; "1939-1945"
    
    Returns:
    
    the temporal
  - setTemporal
```
public void setTemporal(String temporal)
```
    Parameters:
    
    temporal - the temporal to set
  - getThreatStatus
```
@Nullable
public ThreatStatus getThreatStatus()
```
    Threat status of a species as defined by IUCN (http://www.iucnredlist.org/static/categories_criteria_3_1#categories).
    
    Examples: "EX" - "EW" - "CR"
    
    Returns:
    
    the threatStatus.
    
    See Also:
    
    threat status vocabulary for recommended values
  - setThreatStatus
```
public void setThreatStatus(ThreatStatus threatStatus)
```
    Parameters:
    
    threatStatus - the threatStatus to set
  - 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 Distribution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Distribution

Method Detail

getTaxonKey

setTaxonKey

getAppendixCites

setAppendixCites

getCountry

setCountry

getEndDayOfYear

setEndDayOfYear

getEstablishmentMeans

setEstablishmentMeans

getLifeStage

setLifeStage

getLocality

setLocality

getLocationId

setLocationId

getRemarks

setRemarks

getSource

setSource

getSourceTaxonKey

setSourceTaxonKey

getStartDayOfYear

setStartDayOfYear

getStatus

setStatus

getTemporal

setTemporal

getThreatStatus

setThreatStatus

equals

hashCode

toString