org.eigenbase.rel
Enum RelFieldCollation.Direction

java.lang.Object
  java.lang.Enum<RelFieldCollation.Direction>
      org.eigenbase.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

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.

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

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

Method Summary

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're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, 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.

StrictlyAscending

public static final RelFieldCollation.Direction StrictlyAscending

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.

StrictlyDescending

public static final RelFieldCollation.Direction StrictlyDescending

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.

Method Detail

values

public static final RelFieldCollation.Direction[] values()

Returns an array containing the constants of this enum type, in the order they're 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're 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