Module org.opengis.geoapi

Package org.opengis.filter

Enum Class SortOrder

Object

Enum<SortOrder>

SortOrder

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 java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASCENDING	Indicates that an ascending sort, in the collation sequence of the underlying data store, is performed.
DESCENDING	Indicates that a descending sort, in the collation sequence of the filter expression processor, is performed.

Method Summary

Modifier and Type	Method	Description
SortOrder[]	family()	Returns all constants defined by this enumeration type.
Optional<String>	identifier()	Returns the UML identifier for this enumeration constant.
String[]	names()	Returns the programmatic name of this constant together with its identifier and SQL name.
String	toSQL()	Returns the name used in SQL statements.
static SortOrder	valueOf(String name)	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 java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opengis.util.ControlledVocabulary

name, ordinal

Enum Constant Details

ASCENDING

@UML(identifier="ascending",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SortOrder ASCENDING

Indicates that an ascending sort, in the collation sequence of the underlying data store, is performed. This is the SortProperty default value.

DESCENDING

@UML(identifier="descending",
     obligation=CONDITIONAL,
     specification=ISO_19143)
public static final SortOrder DESCENDING

Indicates that a descending sort, in the collation sequence of the filter expression processor, is performed.

Method Details

values

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

identifier

public Optional<String> identifier()

Returns the UML identifier for this enumeration constant.

Specified by:

identifier in interface ControlledVocabulary

Returns:

the ISO/OGC identifier for this constant.

toSQL

public String toSQL()

Returns the name used in SQL statements. This is "ASC" or "DESC".

Returns:

name used in SQL statements.

names

public String[] names()

Returns the programmatic name of this constant together with its identifier and SQL name.

Specified by:

names in interface ControlledVocabulary

Returns:

all names of this constant. This array is never null and never empty.

family

public SortOrder[] family()

Returns all constants defined by this enumeration type. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the ControlledVocabulary interface (i.e. the enumeration type does not need to be known at compile-time).

Specified by:

family in interface ControlledVocabulary

Returns:

all values for this enumeration.