Enum Class DataItemSortOrder
java.lang.Object
java.lang.Enum<DataItemSortOrder>
org.odpi.openmetadata.accessservices.assetmanager.properties.DataItemSortOrder
- All Implemented Interfaces:
Serializable
,Comparable<DataItemSortOrder>
,Constable
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 ConstantsEnum ConstantDescriptionAscending - The attribute instances are organized so that the smallest/lowest values first and the rest of the instances follow in ascending order.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 - The sort order is not specified.Unsorted - The instances of the schema attribute may appear in any order. -
Method Summary
Modifier and TypeMethodDescriptionReturn the default description for this enum.getName()
Return the default name for this enum type.Return the unique identifier for the open metadata enum type that this enum class represents.Return the unique name for the open metadata enum type that this enum class represents.int
Return the code for this enum that comes from the Open Metadata Type that this enum represents.int
Return the code for this enum used for indexing based on the enum value.toString()
Standard toString method.static DataItemSortOrder
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.
-
Enum Constant Details
-
UNKNOWN
Unknown - The sort order is not specified. -
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. -
UNSORTED
Unsorted - The instances of the schema attribute may appear in any order.
-
-
Method Details
-
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
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 nameNullPointerException
- 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
Return the default name for this enum type.- Returns:
- String name
-
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
Return the unique identifier for the open metadata enum type that this enum class represents.- Returns:
- string guid
-
getOpenTypeName
Return the unique name for the open metadata enum type that this enum class represents.- Returns:
- string name
-
toString
Standard toString method.- Overrides:
toString
in classEnum<DataItemSortOrder>
- Returns:
- print out of variables in a JSON-style
-