Package org.gbif.api.model.checklistbank

Class Distribution

    • Method Detail

      • 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.

      • setCountry

        public void setCountry​(Country country)
        Parameters:
        country - the country to set

      • getEndDayOfYear

        @Nullable
@Min(1L)
@Max(366L)
public @Min(1L) @Max(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

      • 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

      • 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

      • getStartDayOfYear

        @Nullable
@Min(1L)
@Max(366L)
public @Min(1L) @Max(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

      • 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