- All Implemented Interfaces:
Serializable
,Comparable<SortOrder>
,Constable
,ControlledVocabulary
@UML(identifier="SortOrder",
specification=ISO_19143)
public enum SortOrder
extends Enum<SortOrder>
implements ControlledVocabulary
Captures the
SortBy
order, ascending or descending.- Since:
- 3.1
-
Nested Class Summary
Nested classes/interfaces inherited from class Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionIndicates that an ascending sort, in the collation sequence of the underlying data store, is performed.Indicates that a descending sort, in the collation sequence of the filter expression processor, is performed. -
Method Summary
Modifier and TypeMethodDescriptionfamily()
Returns all constants defined by this enumeration type.Returns the UML identifier for this enumeration constant.String[]
names()
Returns the programmatic name of this constant together with its identifier and SQL name.toSQL()
Returns the name used in SQL statements.static SortOrder
Returns the enum constant of this class with the specified name.static SortOrder[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from interface ControlledVocabulary
name, ordinal
-
Enum Constant Details
-
ASCENDING
@UML(identifier="ascending", obligation=CONDITIONAL, specification=ISO_19143) public static final SortOrder ASCENDINGIndicates that an ascending sort, in the collation sequence of the underlying data store, is performed. This is theSortProperty
default value. -
DESCENDING
@UML(identifier="descending", obligation=CONDITIONAL, specification=ISO_19143) public static final SortOrder DESCENDINGIndicates that a descending sort, in the collation sequence of the filter expression processor, is performed.
-
-
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
-
identifier
Returns the UML identifier for this enumeration constant.- Specified by:
identifier
in interfaceControlledVocabulary
- Returns:
- the ISO/OGC identifier for this constant, or
null
if none.
-
toSQL
Returns the name used in SQL statements. This is"ASC"
or"DESC"
.- Returns:
- name used in SQL statements.
-
names
Returns the programmatic name of this constant together with its identifier and SQL name.- Specified by:
names
in interfaceControlledVocabulary
- Returns:
- all names of this constant. This array is never null and never empty.
-
family
Returns all constants defined by this enumeration type. Invoking this method is equivalent to invokingvalues()
, except that this method can be invoked on an instance of theControlledVocabulary
interface (i.e. the enumeration type does not need to be known at compile-time).- Specified by:
family
in interfaceControlledVocabulary
- Returns:
- all values for this enumeration.
-