Package org.apache.druid.frame.key

Enum KeyOrder

java.lang.Object

java.lang.Enum<KeyOrder>

org.apache.druid.frame.key.KeyOrder

All Implemented Interfaces:

Serializable, Comparable<KeyOrder>

public enum KeyOrder
extends Enum<KeyOrder>

Ordering associated with a KeyColumn.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASCENDING	Ordered ascending.
DESCENDING	Ordered descending.
NONE	Not ordered.

Method Summary

Modifier and Type	Method	Description
boolean	sortable()
static KeyOrder	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KeyOrder[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final KeyOrder NONE

Not ordered. Possible if the key is used only for non-sorting purposes, such as hashing without sorting.

ASCENDING

public static final KeyOrder ASCENDING

Ordered ascending. Note that sortable key order does not necessarily mean that we are using range-based partitioning. We may be using hash-based partitioning along with each partition internally being sorted by a key.

DESCENDING

public static final KeyOrder DESCENDING

Ordered descending. Note that sortable key order does not necessarily mean that we are using range-based partitioning. We may be using hash-based partitioning along with each partition internally being sorted by a key.

Method Detail

values

public static KeyOrder[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KeyOrder c : KeyOrder.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeyOrder valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

sortable

public boolean sortable()