org.apache.calcite.rel

Enum RelFieldCollation.Direction

java.lang.Object

java.lang.Enum<RelFieldCollation.Direction>

org.apache.calcite.rel.RelFieldCollation.Direction

All Implemented Interfaces:

Serializable, Comparable<RelFieldCollation.Direction>

Enclosing class:

RelFieldCollation

public static enum RelFieldCollation.Direction
extends Enum<RelFieldCollation.Direction>

Direction that a field is ordered in.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING Ascending direction: A value is always followed by a greater or equal value.
CLUSTERED Clustered direction: Values occur in no particular order, and the same value may occur in contiguous groups, but never occurs after that.
DESCENDING Descending direction: A value is always followed by a lesser or equal value.
STRICTLY_ASCENDING Strictly ascending direction: A value is always followed by a greater value.
STRICTLY_DESCENDING Strictly descending direction: A value is always followed by a lesser value.

Field Summary

Fields

Modifier and Type	Field and Description
String	shortString

Method Summary

Modifier and Type	Method and Description
RelFieldCollation.NullDirection	defaultNullDirection() Returns the null direction if not specified.
boolean	isDescending() Returns whether this is DESCENDING or STRICTLY_DESCENDING.
SqlMonotonicity	monotonicity() Converts the direction to a SqlMonotonicity.
static RelFieldCollation.Direction	of(SqlMonotonicity monotonicity) Converts a SqlMonotonicity to a direction.
static RelFieldCollation.Direction	valueOf(String name) Returns the enum constant of this type with the specified name.
static RelFieldCollation.Direction[]	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

ASCENDING

public static final RelFieldCollation.Direction ASCENDING

Ascending direction: A value is always followed by a greater or equal value.

STRICTLY_ASCENDING

public static final RelFieldCollation.Direction STRICTLY_ASCENDING

Strictly ascending direction: A value is always followed by a greater value.

DESCENDING

public static final RelFieldCollation.Direction DESCENDING

Descending direction: A value is always followed by a lesser or equal value.

STRICTLY_DESCENDING

public static final RelFieldCollation.Direction STRICTLY_DESCENDING

Strictly descending direction: A value is always followed by a lesser value.

CLUSTERED

public static final RelFieldCollation.Direction CLUSTERED

Clustered direction: Values occur in no particular order, and the same value may occur in contiguous groups, but never occurs after that. This sort order tends to occur when values are ordered according to a hash-key.

Field Detail

shortString

public final String shortString

Method Detail

values

public static RelFieldCollation.Direction[] 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 (RelFieldCollation.Direction c : RelFieldCollation.Direction.values())
    System.out.println(c);

Returns:

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

valueOf

public static RelFieldCollation.Direction 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

monotonicity

public SqlMonotonicity monotonicity()

Converts the direction to a SqlMonotonicity.

of

public static RelFieldCollation.Direction of(SqlMonotonicity monotonicity)

Converts a SqlMonotonicity to a direction.

defaultNullDirection

public RelFieldCollation.NullDirection defaultNullDirection()

Returns the null direction if not specified. Consistent with Oracle, NULLS are sorted as if they were positive infinity.

isDescending

public boolean isDescending()

Returns whether this is DESCENDING or STRICTLY_DESCENDING.