001/*
002 * Copyright 2020 Global Biodiversity Information Facility (GBIF)
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.gbif.api.vocabulary;
017
018/**
019 * A statement about the presence or absence of a Taxon at a Location.
020 *
021 * @see <a href="http://rs.gbif.org/vocabulary/gbif/distribution_status_2020-05-14.xml">rs.gbif.org vocabulary</a>
022 */
023public enum DistributionStatus {
024
025  /*
026   * Javadoc definitions are copied from the vocabulary.
027   */
028
029  /**
030   * There is at least one well documented record of the taxon's presence in the area.
031   */
032  PRESENT,
033
034  /**
035   * Subclass of present: Species observed frequently in most proper habitat.
036   */
037  COMMON,
038
039  /**
040   * Subclass of present: Species occurs regularly, but in small numbers. Requires careful searching of proper habitat.
041   */
042  RARE,
043
044  /**
045   * Subclass of present: May be common in certain years and entirely absent other years.
046   */
047  IRREGULAR,
048
049  /**
050   * The taxon is scored as being present in the area but there is some doubt over the evidence.
051   * The doubt may be of different kinds including taxonomic or geographic imprecision in the records.
052   */
053  DOUBTFUL,
054
055  /**
056   * Subclass of absent: The organism is reported in some (gray) literature for a certain region, but is is erroneous.
057   * Reason for exclusion could be a misidentification, an old report, a simple publishing mistake or any other or
058   * unknown reason.
059   */
060  EXCLUDED,
061
062  /**
063   * There is evidence to document the absence of a taxon in the area. An extinct organism is absent while its
064   * establishmentMeans is native.
065   */
066  ABSENT
067
068}