Package org.odpi.openmetadata.accessservices.assetmanager.properties

Enum Class DataItemSortOrder

java.lang.Object
java.lang.Enum<DataItemSortOrder>
org.odpi.openmetadata.accessservices.assetmanager.properties.DataItemSortOrder
All Implemented Interfaces:
Serializable, Comparable<DataItemSortOrder>, Constable
public enum DataItemSortOrder extends Enum<DataItemSortOrder>
DataItemSortOrder is used for schema attributes that may have multiple instances.

  • 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
    ASCENDING
    Ascending - The attribute instances are organized so that the smallest/lowest values first and the rest of the instances follow in ascending order.
    DESCENDING
    Descending - The attribute instances are organized so that the largest/highest value is first and the rest of the instances follow in descending order.
    UNKNOWN
    Unknown - The sort order is not specified.
    UNSORTED
    Unsorted - The instances of the schema attribute may appear in any order.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Return the default description for this enum.
    String
    getName()
    Return the default name for this enum type.
    String
    getOpenTypeGUID()
    Return the unique identifier for the open metadata enum type that this enum class represents.
    String
    getOpenTypeName()
    Return the unique name for the open metadata enum type that this enum class represents.
    int
    getOpenTypeOrdinal()
    Return the code for this enum that comes from the Open Metadata Type that this enum represents.
    int
    getOrdinal()
    Return the code for this enum used for indexing based on the enum value.
    String
    toString()
    Standard toString method.
    static DataItemSortOrder
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static DataItemSortOrder[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNKNOWN

      public static final DataItemSortOrder UNKNOWN
      Unknown - The sort order is not specified.

    • ASCENDING

      public static final DataItemSortOrder ASCENDING
      Ascending - The attribute instances are organized so that the smallest/lowest values first and the rest of the instances follow in ascending order.

    • DESCENDING

      public static final DataItemSortOrder DESCENDING
      Descending - The attribute instances are organized so that the largest/highest value is first and the rest of the instances follow in descending order.

    • UNSORTED

      public static final DataItemSortOrder UNSORTED
      Unsorted - The instances of the schema attribute may appear in any order.

  • Method Details

    • values

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

    • getOrdinal

      public int getOrdinal()
      Return the code for this enum used for indexing based on the enum value.
      Returns:
      int code number

    • getName

      public String getName()
      Return the default name for this enum type.
      Returns:
      String name

    • getDescription

      public String getDescription()
      Return the default description for this enum.
      Returns:
      String description

    • getOpenTypeOrdinal

      public int getOpenTypeOrdinal()
      Return the code for this enum that comes from the Open Metadata Type that this enum represents.
      Returns:
      int code number

    • getOpenTypeGUID

      public String getOpenTypeGUID()
      Return the unique identifier for the open metadata enum type that this enum class represents.
      Returns:
      string guid

    • getOpenTypeName

      public String getOpenTypeName()
      Return the unique name for the open metadata enum type that this enum class represents.
      Returns:
      string name

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Enum<DataItemSortOrder>
      Returns:
      print out of variables in a JSON-style