Package org.gbif.api.vocabulary

Enum Class TagName

java.lang.Object
java.lang.Enum<TagName>
org.gbif.api.vocabulary.TagName
All Implemented Interfaces:
Serializable, Comparable<TagName>, Constable
public enum TagName extends Enum<TagName>
Known MachineTag.getName() name value. The tag names listed here are used/recognized by different services.

  • Enum Constant Details

    • DATASET_ID

      public static final TagName DATASET_ID
      The Darwin Core term datasetID which is found in dwc archives to reference subdatasets such as the Catalogue of Life GSDs. Stored in the registry to keep a mapping between the subdataset registry key and the dwca datasetID value.
      See Also:

    • CRAWL_ATTEMPT

      public static final TagName CRAWL_ATTEMPT
      This is a counter starting at 1 incremented every time we try to crawl a dataset. This is even incremented when a crawl fails for any reason.

    • OMIT_FROM_SCHEDULED_CRAWL

      public static final TagName OMIT_FROM_SCHEDULED_CRAWL
      Datasets marked with this tag will not be in the periodic crawl.

    • ARCHIVE_ORIGIN

      public static final TagName ARCHIVE_ORIGIN
      Records the source of an archive endpoint, e.g. that it is from a BioCASe installation.

    • CONCEPTUAL_SCHEMA

      public static final TagName CONCEPTUAL_SCHEMA
      TaPIR or BioCASe conceptual schema.

    • DATASET_TITLE

      @Deprecated public static final TagName DATASET_TITLE
      Deprecated.
      Dataset title for BioCASe, no longer used.

    • DATE_LAST_UPDATED

      public static final TagName DATE_LAST_UPDATED
      Date the records in the dataset were last updated.

    • DECLARED_COUNT

      public static final TagName DECLARED_COUNT
      Number of records declared in the dataset by the source.

    • DIGIR_CODE

      public static final TagName DIGIR_CODE
      DiGIR code.

    • LOCAL_ID

      @Deprecated public static final TagName LOCAL_ID
      Deprecated.
      Not sure, no longer in use?

    • MAX_SEARCH_RESPONSE_RECORDS

      public static final TagName MAX_SEARCH_RESPONSE_RECORDS
      Number of records to request in each search.

    • ORPHAN_STATUS

      public static final TagName ORPHAN_STATUS
      Records whether an orphan dataset has been RESCUED.

    • ORPHANED_ENDPOINT

      public static final TagName ORPHANED_ENDPOINT
      The endpoint which was not working when the dataset was rescued.

    • ORPHAN_DOWNLOAD

      public static final TagName ORPHAN_DOWNLOAD
      The GBIF download used to rescue the orphaned dataset.

    • ORPHAN_DWCA_CACHE_TIME

      public static final TagName ORPHAN_DWCA_CACHE_TIME
      The modification time of the last-available Darwin Core Archive from temporary storage, used to rescue the dataset.

  • Method Details

    • values

      public static TagName[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TagName valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getNamespace

      public TagNamespace getNamespace()
      Namespace to which belong this tag.
      Returns:
      the namespace

    • getName

      public String getName()
      Actual machine tag name.
      Returns:
      the machine tag name