org.apache.calcite.rel.convert

Class ConverterImpl

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.SingleRel

org.apache.calcite.rel.convert.ConverterImpl

All Implemented Interfaces:

Cloneable, RelOptNode, Converter, RelNode

Direct Known Subclasses:

AbstractConverter, EnumerableBindable, EnumerableInterpretable, InterpretableConverter, JdbcToEnumerableConverter, NoneConverter

public abstract class ConverterImpl
extends SingleRel
implements Converter

Abstract implementation of Converter.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.rel.RelNode

RelNode.Context

Field Summary

Fields

Modifier and Type	Field and Description
protected RelTraitSet	inTraits
protected @Nullable RelTraitDef	traitDef

Fields inherited from class org.apache.calcite.rel.SingleRel

input

Fields inherited from class org.apache.calcite.rel.AbstractRelNode

digest, id, rowType, traitSet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConverterImpl(RelOptCluster cluster, @Nullable RelTraitDef traitDef, RelTraitSet traits, RelNode child) Creates a ConverterImpl.

Method Summary

Modifier and Type	Method and Description
protected Error	cannotImplement() Deprecated.
@Nullable RelOptCost	computeSelfCost(RelOptPlanner planner, RelMetadataQuery mq) Returns the cost of this plan (not including children).
RelTraitSet	getInputTraits() Returns the trait of the input relational expression.
@Nullable RelTraitDef	getTraitDef() Returns the definition of trait which this converter works on.

Methods inherited from class org.apache.calcite.rel.SingleRel

childrenAccept, deriveRowType, estimateRowCount, explainTerms, getInput, getInputs, replaceInput

Methods inherited from class org.apache.calcite.rel.AbstractRelNode

accept, accept, collectVariablesSet, collectVariablesUsed, copy, deepEquals, deepHashCode, equals, explain, getCluster, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getRelDigest, getRelTypeName, getRowType, getTable, getTraitSet, getVariablesSet, hashCode, isEnforcer, isValid, metadata, onRegister, recomputeDigest, register, sole, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.rel.convert.Converter

getInput

Methods inherited from interface org.apache.calcite.rel.RelNode

accept, accept, childrenAccept, collectVariablesSet, collectVariablesUsed, copy, deepEquals, deepHashCode, estimateRowCount, explain, explain, fieldIsNullable, getConvention, getCorrelVariable, getDigest, getExpectedInputRowType, getInput, getInputs, getRelDigest, getRelTypeName, getRowType, getTable, getVariablesSet, isEnforcer, isValid, metadata, onRegister, recomputeDigest, register, replaceInput

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

getCluster, getDescription, getId, getTraitSet

Field Detail

inTraits

protected RelTraitSet inTraits

traitDef

protected final @Nullable RelTraitDef traitDef

Constructor Detail

ConverterImpl

protected ConverterImpl(RelOptCluster cluster,
                        @Nullable RelTraitDef traitDef,
                        RelTraitSet traits,
                        RelNode child)

Creates a ConverterImpl.

Parameters:

cluster - planner's cluster

traitDef - the RelTraitDef this converter converts

traits - the output traits of this converter

child - child rel (provides input traits)

Method Detail

computeSelfCost

public @Nullable RelOptCost computeSelfCost(RelOptPlanner planner,
                                            RelMetadataQuery mq)

Description copied from interface: RelNode

Returns the cost of this plan (not including children). The base implementation throws an error; derived classes should override.

NOTE jvs 29-Mar-2006: Don't call this method directly. Instead, use RelMetadataQuery.getNonCumulativeCost(org.apache.calcite.rel.RelNode), which gives plugins a chance to override the rel's default ideas about cost.

Specified by:

computeSelfCost in interface RelNode

Overrides:

computeSelfCost in class AbstractRelNode

Parameters:

planner - Planner for cost calculation

mq - Metadata query

Returns:

Cost of this plan (not including children)

cannotImplement

@Deprecated
protected Error cannotImplement()

Deprecated.

getInputTraits

public RelTraitSet getInputTraits()

Description copied from interface: Converter

Returns the trait of the input relational expression.

Specified by:

getInputTraits in interface Converter

Returns:

input trait

getTraitDef

public @Nullable RelTraitDef getTraitDef()

Description copied from interface: Converter

Returns the definition of trait which this converter works on.

The input relational expression (matched by the rule) must possess this trait and have the value given by Converter.getInputTraits(), and the traits of the output of this converter given by RelOptNode.getTraitSet() will have one trait altered and the other orthogonal traits will be the same.

Specified by:

getTraitDef in interface Converter

Returns:

trait which this converter modifies