org.apache.calcite.rel

Class RelCollationImpl

java.lang.Object

org.apache.calcite.rel.RelCollationImpl

All Implemented Interfaces:

Comparable<RelMultipleTrait>, RelMultipleTrait, RelTrait, RelCollation

public class RelCollationImpl
extends Object
implements RelCollation

Simple implementation of RelCollation.

Field Summary

Fields

Modifier and Type	Field and Description
static RelCollation	EMPTY Deprecated.
static RelCollation	PRESERVE Deprecated.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RelCollationImpl(com.google.common.collect.ImmutableList<RelFieldCollation> fieldCollations)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(RelMultipleTrait o)
static List<RelCollation>	createSingleton(int fieldIndex) Deprecated.
static boolean	equal(List<RelCollation> collationList1, List<RelCollation> collationList2) Deprecated.
boolean	equals(Object obj) See note about equals() and hashCode().
List<RelFieldCollation>	getFieldCollations() Returns the ordinals and directions of the columns in this ordering.
RelTraitDef	getTraitDef() Returns the RelTraitDef that defines this RelTrait.
int	hashCode() See note about equals() and hashCode().
boolean	isTop() Returns whether this trait is satisfied by every instance of the trait (including itself).
static boolean	isValid(RelDataType rowType, List<RelCollation> collationList, boolean fail) Deprecated.
static RelCollation	of(List<RelFieldCollation> fieldCollations) Deprecated.
static RelCollation	of(RelFieldCollation... fieldCollations) Deprecated.
static List<Integer>	ordinals(RelCollation collation) Deprecated.
void	register(RelOptPlanner planner) Registers a trait instance with the planner.
boolean	satisfies(RelTrait trait) Returns whether this trait satisfies a given trait.
String	toString() Returns a string representation of this collation, suitably terse given that it will appear in plan traces.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

@Deprecated
public static final RelCollation EMPTY

Deprecated.

PRESERVE

@Deprecated
public static final RelCollation PRESERVE

Deprecated.

Constructor Detail

RelCollationImpl

protected RelCollationImpl(com.google.common.collect.ImmutableList<RelFieldCollation> fieldCollations)

Method Detail

of

@Deprecated
public static RelCollation of(RelFieldCollation... fieldCollations)

Deprecated.

of

@Deprecated
public static RelCollation of(List<RelFieldCollation> fieldCollations)

Deprecated.

getTraitDef

public RelTraitDef getTraitDef()

Description copied from interface: RelTrait

Returns the RelTraitDef that defines this RelTrait.

Specified by:

getTraitDef in interface RelTrait

Returns:

the RelTraitDef that defines this RelTrait

getFieldCollations

public List<RelFieldCollation> getFieldCollations()

Description copied from interface: RelCollation

Returns the ordinals and directions of the columns in this ordering.

Specified by:

getFieldCollations in interface RelCollation

hashCode

public int hashCode()

Description copied from interface: RelTrait

See note about equals() and hashCode().

Specified by:

hashCode in interface RelTrait

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Description copied from interface: RelTrait

See note about equals() and hashCode().

Specified by:

equals in interface RelTrait

Overrides:

equals in class Object

isTop

public boolean isTop()

Description copied from interface: RelMultipleTrait

Returns whether this trait is satisfied by every instance of the trait (including itself).

Specified by:

isTop in interface RelMultipleTrait

compareTo

public int compareTo(@Nonnull
            RelMultipleTrait o)

Specified by:

compareTo in interface Comparable<RelMultipleTrait>

register

public void register(RelOptPlanner planner)

Description copied from interface: RelTrait

Registers a trait instance with the planner.

This is an opportunity to add rules that relate to that trait. However, typical implementations will do nothing.

Specified by:

register in interface RelTrait

Parameters:

planner - Planner

satisfies

public boolean satisfies(RelTrait trait)

Description copied from interface: RelTrait

Returns whether this trait satisfies a given trait.

A trait satisfies another if it is the same or stricter. For example, ORDER BY x, y satisfies ORDER BY x.

A trait's satisfies relation must be a partial order (reflexive, anti-symmetric, transitive). Many traits cannot be "loosened"; their satisfies is an equivalence relation, where only X satisfies X.

If a trait has multiple values (see RelCompositeTrait) a collection (T0, T1, ...) satisfies T if any Ti satisfies T.

Specified by:

satisfies in interface RelTrait

Parameters:

trait - Given trait

Returns:

Whether this trait subsumes a given trait

toString

public String toString()

Returns a string representation of this collation, suitably terse given that it will appear in plan traces. Examples: "[]", "[2]", "[0 DESC, 1]", "[0 DESC, 1 ASC NULLS LAST]".

Specified by:

toString in interface RelTrait

Overrides:

toString in class Object

createSingleton

@Deprecated
public static List<RelCollation> createSingleton(int fieldIndex)

Deprecated.

isValid

@Deprecated
public static boolean isValid(RelDataType rowType,
                         List<RelCollation> collationList,
                         boolean fail)

Deprecated.

equal

@Deprecated
public static boolean equal(List<RelCollation> collationList1,
                       List<RelCollation> collationList2)

Deprecated.

ordinals

@Deprecated
public static List<Integer> ordinals(RelCollation collation)

Deprecated.