Package org.apache.calcite.rel

Class RelFieldCollation

java.lang.Object

org.apache.calcite.rel.RelFieldCollation

public class RelFieldCollation
extends java.lang.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	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	Description
RelFieldCollation.Direction	direction	Direction of sorting.
private int	fieldIndex	0-based index of field being sorted.
RelFieldCollation.NullDirection	nullDirection	Direction of sorting of nulls.

Constructor Summary

Constructors

Constructor	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	Description
static int	compare(java.lang.Comparable c1, java.lang.Comparable c2, int nullComparison)	Utility method that compares values taking into account null direction.
RelFieldCollation	copy(int target)	Creates a copy of this RelFieldCollation against a different field.
boolean	equals(java.lang.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.
java.lang.String	shortString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

fieldIndex

private final int fieldIndex

0-based index of field being sorted.

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(java.lang.Comparable c1,
                          java.lang.Comparable c2,
                          int nullComparison)

Utility method that compares values taking into account null direction.

copy

public RelFieldCollation copy(int target)

Creates a copy of this RelFieldCollation against a different field.

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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getFieldIndex

public int getFieldIndex()

getDirection

public RelFieldCollation.Direction getDirection()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

shortString

public java.lang.String shortString()