Package tethys

Enum Class Collection

java.lang.Object
java.lang.Enum<Collection>
tethys.Collection
All Implemented Interfaces:
Serializable, Comparable<Collection>, Constable
public enum Collection extends Enum<Collection>
Names of Tethys Collections. These are the plural names, though contain functionality to get the document names, which are generally the singular of the enum
Author:
dg50

  • Enum Constant Details

    • Deployments

      public static final Collection Deployments

    • Detections

      public static final Collection Detections

    • Calibrations

      public static final Collection Calibrations

    • Localizations

      public static final Collection Localizations

    • SpeciesAbbreviations

      public static final Collection SpeciesAbbreviations

    • Ensembles

      public static final Collection Ensembles

    • SourceMaps

      public static final Collection SourceMaps

    • ITIS

      public static final Collection ITIS

    • ITIS_ranks

      public static final Collection ITIS_ranks

    • OTHER

      public static final Collection OTHER

  • Method Details

    • values

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

    • mainList

      public static Collection[] mainList()
      A list of the main collections in the database, i.e. ones the user will possibly want to interract with through the GUI.
      Returns:
      list of main collections.

    • documentName

      public String documentName()
      Get the name of a document in this collection, this is generally the singular of the collection name.
      Returns:
      Document name, e.g. Detection for Detections

    • collectionName

      public String collectionName()

    • fromName

      public static Collection fromName(String name)
      Find a collection for the given name. This does a bit more than the simple 'valueof' since it also allows the user to input a documentname in place, which is just the collection name without the plural 's' on the end
      Parameters:
      name - Collection name.
      Returns:
      Collection or null.

    • fromClass

      public static Collection fromClass(Class nilusClass)
      get Tethys collection name from nilus collection objects
      Parameters:
      className - nilus object Class Name
      Returns:
      name of Tethys collection