org.apache.calcite.adapter.enumerable

Enum EnumerableConvention

java.lang.Object

java.lang.Enum<EnumerableConvention>

org.apache.calcite.adapter.enumerable.EnumerableConvention

All Implemented Interfaces:

Serializable, Comparable<EnumerableConvention>, Convention, RelTrait

public enum EnumerableConvention
extends Enum<EnumerableConvention>
implements Convention

Family of calling conventions that return results as an Enumerable.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.plan.Convention

Convention.Impl

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static double	COST_MULTIPLIER Cost of an enumerable node versus implementing an equivalent node in a "typical" calling convention.

Fields inherited from interface org.apache.calcite.plan.Convention

NONE

Method Summary

Methods

Modifier and Type	Method and Description
Class	getInterface()
String	getName()
RelTraitDef	getTraitDef() Returns the RelTraitDef that defines this RelTrait.
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 succinct name for this trait.
static EnumerableConvention	valueOf(String name) Returns the enum constant of this type with the specified name.
static EnumerableConvention[]	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, valueOf

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.calcite.plan.RelTrait

equals, hashCode

Enum Constant Detail

INSTANCE

public static final EnumerableConvention INSTANCE

Field Detail

COST_MULTIPLIER

public static final double COST_MULTIPLIER

Cost of an enumerable node versus implementing an equivalent node in a "typical" calling convention.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static EnumerableConvention 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

toString

public String toString()

Description copied from interface: RelTrait

Returns a succinct name for this trait. The planner may use this String to describe the trait.

Specified by:

toString in interface RelTrait

Overrides:

toString in class Enum<EnumerableConvention>

getInterface

public Class getInterface()

Specified by:

getInterface in interface Convention

getName

public String getName()

Specified by:

getName in interface Convention

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

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

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