Package org.gbif.api.model.occurrence

Enum Class DownloadFormat

java.lang.Object
java.lang.Enum<DownloadFormat>
org.gbif.api.model.occurrence.DownloadFormat
All Implemented Interfaces:
Serializable, Comparable<DownloadFormat>, Constable
public enum DownloadFormat extends Enum<DownloadFormat>
Download output requested format.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BIONOMIA
    Special export format for the Bionomia project.
    DWCA
    Darwin Core Archive file that is a zip of all indexed fields in both verbatim and interpreted, plus multimedia and metadata files.
    FASTA_ARCHIVE
    Variant of a DWCA download that includes a FASTA file and DNA sequences.
    MAP_OF_LIFE
    Special Avro format for the Map of Life project.
    SIMPLE_AVRO
    Avro (with Deflate compression codec) format export of the most common indexed terms.
    SIMPLE_CSV
    Zipped text file of the most common indexed terms, but note that it is delimited by tabs, not commas.
    SIMPLE_PARQUET
    Parquet (with Snappy compression codec) format export of the most common indexed terms.
    SIMPLE_WITH_VERBATIM_AVRO
    Avro (with Deflate compression codec) format export of the most common indexed terms, plus many verbatim terms.
    SPECIES_LIST
    TSV format export of the distinct species and taxonomic field associated to each.
    SQL_TSV_ZIP
    Experimental feature. Zipped tab-delimited text file resulting from an SQL query.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getExtension()
     
    static DownloadFormat
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static DownloadFormat[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • DWCA

      public static final DownloadFormat DWCA
      Darwin Core Archive file that is a zip of all indexed fields in both verbatim and interpreted, plus multimedia and metadata files.

    • SIMPLE_CSV

      public static final DownloadFormat SIMPLE_CSV
      Zipped text file of the most common indexed terms, but note that it is delimited by tabs, not commas.

    • SIMPLE_AVRO

      public static final DownloadFormat SIMPLE_AVRO
      Avro (with Deflate compression codec) format export of the most common indexed terms.

    • SIMPLE_WITH_VERBATIM_AVRO

      public static final DownloadFormat SIMPLE_WITH_VERBATIM_AVRO
      Avro (with Deflate compression codec) format export of the most common indexed terms, plus many verbatim terms. More verbatim terms may be added upon request.

    • SPECIES_LIST

      public static final DownloadFormat SPECIES_LIST
      TSV format export of the distinct species and taxonomic field associated to each.

    • MAP_OF_LIFE

      public static final DownloadFormat MAP_OF_LIFE
      Special Avro format for the Map of Life project.

    • BIONOMIA

      public static final DownloadFormat BIONOMIA
      Special export format for the Bionomia project.

    • SIMPLE_PARQUET

      public static final DownloadFormat SIMPLE_PARQUET
      Parquet (with Snappy compression codec) format export of the most common indexed terms.

    • SQL_TSV_ZIP

      public static final DownloadFormat SQL_TSV_ZIP
      Experimental feature. Zipped tab-delimited text file resulting from an SQL query.

    • FASTA_ARCHIVE

      public static final DownloadFormat FASTA_ARCHIVE
      Variant of a DWCA download that includes a FASTA file and DNA sequences.

  • Method Details

    • values

      public static DownloadFormat[] 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 DownloadFormat 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

    • getExtension

      public String getExtension()