org.apache.calcite.rel

Class RelFieldCollation

java.lang.Object

org.apache.calcite.rel.RelFieldCollation

public class RelFieldCollation
extends Object

Definition of the ordering of one field of a RelNode whose output is to be sorted.

See Also:

RelCollation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RelFieldCollation.Direction Direction that a field is ordered in.
static class	RelFieldCollation.NullDirection Ordering of nulls.

Field Summary

Fields

Modifier and Type	Field and Description
RelFieldCollation.Direction	direction Direction of sorting.
RelFieldCollation.NullDirection	nullDirection Direction of sorting of nulls.

Constructor Summary

Constructors

Constructor and Description
RelFieldCollation(int fieldIndex) Creates an ascending field collation.
RelFieldCollation(int fieldIndex, RelFieldCollation.Direction direction) Creates a field collation with unspecified null direction.
RelFieldCollation(int fieldIndex, RelFieldCollation.Direction direction, RelFieldCollation.NullDirection nullDirection) Creates a field collation.

Method Summary

Modifier and Type	Method and Description
static int	compare(@Nullable Comparable c1, @Nullable Comparable c2, int nullComparison) Utility method that compares values taking into account null direction.
RelFieldCollation	copy(int target) Deprecated.
boolean	equals(@Nullable Object o)
RelFieldCollation.Direction	getDirection()
int	getFieldIndex()
int	hashCode()
RelFieldCollation	shift(int offset) Returns a copy of this RelFieldCollation with the field index shifted offset to the right.
String	shortString()
String	toString()
RelFieldCollation	withDirection(RelFieldCollation.Direction direction) Creates a copy of this RelFieldCollation with a different direction.
RelFieldCollation	withFieldIndex(int fieldIndex) Creates a copy of this RelFieldCollation against a different field.
RelFieldCollation	withNullDirection(RelFieldCollation.NullDirection nullDirection) Creates a copy of this RelFieldCollation with a different null direction.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

direction

public final RelFieldCollation.Direction direction

Direction of sorting.

nullDirection

public final RelFieldCollation.NullDirection nullDirection

Direction of sorting of nulls.

Constructor Detail

RelFieldCollation

public RelFieldCollation(int fieldIndex)

Creates an ascending field collation.

RelFieldCollation

public RelFieldCollation(int fieldIndex,
                         RelFieldCollation.Direction direction)

Creates a field collation with unspecified null direction.

RelFieldCollation

public RelFieldCollation(int fieldIndex,
                         RelFieldCollation.Direction direction,
                         RelFieldCollation.NullDirection nullDirection)

Creates a field collation.

Method Detail

compare

public static int compare(@Nullable Comparable c1,
                          @Nullable Comparable c2,
                          int nullComparison)

Utility method that compares values taking into account null direction.

withFieldIndex

public RelFieldCollation withFieldIndex(int fieldIndex)

Creates a copy of this RelFieldCollation against a different field.

copy

@Deprecated
public RelFieldCollation copy(int target)

Deprecated.

withDirection

public RelFieldCollation withDirection(RelFieldCollation.Direction direction)

Creates a copy of this RelFieldCollation with a different direction.

withNullDirection

public RelFieldCollation withNullDirection(RelFieldCollation.NullDirection nullDirection)

Creates a copy of this RelFieldCollation with a different null direction.

shift

public RelFieldCollation shift(int offset)

Returns a copy of this RelFieldCollation with the field index shifted offset to the right.

equals

public boolean equals(@Nullable Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getFieldIndex

public int getFieldIndex()

getDirection

public RelFieldCollation.Direction getDirection()

toString

public String toString()

Overrides:

toString in class Object

shortString

public String shortString()