Package org.apache.calcite.interpreter

Enum BindableConvention

java.lang.Object

java.lang.Enum<BindableConvention>

org.apache.calcite.interpreter.BindableConvention

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BindableConvention>, Convention, RelTrait

public enum BindableConvention
extends java.lang.Enum<BindableConvention>
implements Convention

Calling convention that returns results as an Enumerable of object arrays.

The relational expression needs to implement ArrayBindable. Unlike EnumerableConvention, no code generation is required.

Nested Class Summary

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

Convention.Impl

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Field Summary

Fields

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

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

NONE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	BindableConvention()

Method Summary

Modifier and Type	Method	Description
boolean	canConvertConvention(Convention toConvention)	Returns whether we should convert from this convention to toConvention.
java.lang.Class	getInterface()
java.lang.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.
java.lang.String	toString()	Returns a succinct name for this trait.
boolean	useAbstractConvertersForConversion(RelTraitSet fromTraits, RelTraitSet toTraits)	Returns whether we should convert from this trait set to the other trait set.
static BindableConvention	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static BindableConvention[]	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

getClass, notify, notifyAll, wait, wait, wait

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

equals, hashCode

Enum Constant Detail

INSTANCE

public static final BindableConvention INSTANCE

Field Detail

COST_MULTIPLIER

public static final double COST_MULTIPLIER

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

See Also:

Constant Field Values

Constructor Detail

BindableConvention

private BindableConvention()

Method Detail

values

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

Returns:

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

valueOf

public static BindableConvention valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.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 java.lang.Enum<BindableConvention>

getInterface

public java.lang.Class getInterface()

Specified by:

getInterface in interface Convention

getName

public java.lang.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

canConvertConvention

public boolean canConvertConvention(Convention toConvention)

Description copied from interface: Convention

Returns whether we should convert from this convention to toConvention. Used by ConventionTraitDef.

Specified by:

canConvertConvention in interface Convention

Parameters:

toConvention - Desired convention to convert to

Returns:

Whether we should convert from this convention to toConvention

useAbstractConvertersForConversion

public boolean useAbstractConvertersForConversion(RelTraitSet fromTraits,
                                                  RelTraitSet toTraits)

Description copied from interface: Convention

Returns whether we should convert from this trait set to the other trait set.

The convention decides whether it wants to handle other trait conversions, e.g. collation, distribution, etc. For a given convention, we will only add abstract converters to handle the trait (convention, collation, distribution, etc.) conversions if this function returns true.

Specified by:

useAbstractConvertersForConversion in interface Convention

Parameters:

fromTraits - Traits of the RelNode that we are converting from

toTraits - Target traits

Returns:

Whether we should add converters