org.apache.calcite.rel.convert

Class ConverterRule

java.lang.Object

org.apache.calcite.plan.RelOptRule

org.apache.calcite.plan.RelRule<ConverterRule.Config>

org.apache.calcite.rel.convert.ConverterRule

Direct Known Subclasses:

Bindables.BindableAggregateRule, Bindables.BindableFilterRule, Bindables.BindableJoinRule, Bindables.BindableMatchRule, Bindables.BindableProjectRule, Bindables.BindableSetOpRule, Bindables.BindableSortRule, Bindables.BindableValuesRule, Bindables.BindableWindowRule, EnumerableBindable.EnumerableToBindableConverterRule, EnumerableCorrelateRule, EnumerableInterpreterRule, EnumerableMatchRule, EnumerableRepeatUnionRule, EnumerableTableFunctionScanRule, EnumerableTableModifyRule, EnumerableTableScanRule, EnumerableTableSpoolRule, EnumerableValuesRule, JdbcRules.JdbcAggregateRule, JdbcRules.JdbcFilterRule, JdbcRules.JdbcIntersectRule, JdbcRules.JdbcJoinRule, JdbcRules.JdbcMinusRule, JdbcRules.JdbcProjectRule, JdbcRules.JdbcSortRule, JdbcRules.JdbcTableModificationRule, JdbcRules.JdbcUnionRule, JdbcRules.JdbcValuesRule, JdbcToEnumerableConverterRule, NoneToBindableConverterRule

@Value.Enclosing
public abstract class ConverterRule
extends RelRule<ConverterRule.Config>

Abstract base class for a rule which converts from one calling convention to another without changing semantics.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ConverterRule.Config Rule configuration.

Nested classes/interfaces inherited from class org.apache.calcite.plan.RelRule

RelRule.Done, RelRule.MatchHandler<R extends RelOptRule>, RelRule.OperandBuilder, RelRule.OperandDetailBuilder<R extends RelNode>, RelRule.OperandTransform

Nested classes/interfaces inherited from class org.apache.calcite.plan.RelOptRule

RelOptRule.ConverterRelOptRuleOperand

Field Summary

Fields

Modifier and Type	Field and Description
protected Convention	out

Fields inherited from class org.apache.calcite.plan.RelRule

config

Fields inherited from class org.apache.calcite.plan.RelOptRule

description, operands, relBuilderFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConverterRule(Class<? extends RelNode> clazz, RelTrait in, RelTrait out, String descriptionPrefix) Deprecated. Use ConverterRule(Config)
protected	ConverterRule(Class<R> clazz, Predicate<? super R> predicate, RelTrait in, RelTrait out, RelBuilderFactory relBuilderFactory, String descriptionPrefix) Deprecated. Use ConverterRule(Config)
protected	ConverterRule(Class<R> clazz, com.google.common.base.Predicate<? super R> predicate, RelTrait in, RelTrait out, RelBuilderFactory relBuilderFactory, String description) Deprecated.
protected	ConverterRule(Class<R> clazz, com.google.common.base.Predicate<? super R> predicate, RelTrait in, RelTrait out, String descriptionPrefix) Deprecated.
protected	ConverterRule(ConverterRule.Config config) Creates a ConverterRule.

Method Summary

Modifier and Type	Method and Description
abstract @Nullable RelNode	convert(RelNode rel) Converts a relational expression to the target trait(s) of this rule.
RelTrait	getInTrait()
Convention	getOutConvention() Returns the convention of the result of firing this rule, null if not known.
RelTrait	getOutTrait() Returns the trait which will be modified as a result of firing this rule, or null if the rule is not a converter rule.
RelTraitDef	getTraitDef()
boolean	isGuaranteed() Returns true if this rule can convert any relational expression of the input convention.
void	onMatch(RelOptRuleCall call) Receives notification about a rule match.

Methods inherited from class org.apache.calcite.plan.RelOptRule

any, convert, convert, convertList, convertOperand, convertOperand, equals, equals, getOperand, getOperands, hashCode, matches, none, operand, operand, operand, operand, operand, operandJ, operandJ, some, toString, unordered

Methods inherited from class java.lang.Object

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

Field Detail

out

protected final Convention out

Constructor Detail

ConverterRule

protected ConverterRule(ConverterRule.Config config)

Creates a ConverterRule.

ConverterRule

@Deprecated
protected ConverterRule(Class<? extends RelNode> clazz,
                                    RelTrait in,
                                    RelTrait out,
                                    String descriptionPrefix)

Deprecated. Use ConverterRule(Config)

Creates a ConverterRule.

Parameters:

clazz - Type of relational expression to consider converting

in - Trait of relational expression to consider converting

out - Trait which is converted to

descriptionPrefix - Description prefix of rule

ConverterRule

@Deprecated
protected ConverterRule(Class<R> clazz,
                                    com.google.common.base.Predicate<? super R> predicate,
                                    RelTrait in,
                                    RelTrait out,
                                    String descriptionPrefix)

Deprecated.

ConverterRule

@Deprecated
protected ConverterRule(Class<R> clazz,
                                    Predicate<? super R> predicate,
                                    RelTrait in,
                                    RelTrait out,
                                    RelBuilderFactory relBuilderFactory,
                                    String descriptionPrefix)

Deprecated. Use ConverterRule(Config)

Creates a ConverterRule with a predicate.

Parameters:

clazz - Type of relational expression to consider converting

predicate - Predicate on the relational expression

in - Trait of relational expression to consider converting

out - Trait which is converted to

relBuilderFactory - Builder for relational expressions

descriptionPrefix - Description prefix of rule

ConverterRule

@Deprecated
protected ConverterRule(Class<R> clazz,
                                    com.google.common.base.Predicate<? super R> predicate,
                                    RelTrait in,
                                    RelTrait out,
                                    RelBuilderFactory relBuilderFactory,
                                    String description)

Deprecated.

Method Detail

getOutConvention

public Convention getOutConvention()

Description copied from class: RelOptRule

Returns the convention of the result of firing this rule, null if not known.

Overrides:

getOutConvention in class RelOptRule

Returns:

Convention of the result of firing this rule, null if not known

getOutTrait

public RelTrait getOutTrait()

Description copied from class: RelOptRule

Returns the trait which will be modified as a result of firing this rule, or null if the rule is not a converter rule.

Overrides:

getOutTrait in class RelOptRule

Returns:

Trait which will be modified as a result of firing this rule, or null if the rule is not a converter rule

getInTrait

public RelTrait getInTrait()

getTraitDef

public RelTraitDef getTraitDef()

convert

public abstract @Nullable RelNode convert(RelNode rel)

Converts a relational expression to the target trait(s) of this rule.

Returns null if conversion is not possible.

isGuaranteed

public boolean isGuaranteed()

Returns true if this rule can convert any relational expression of the input convention.

The union-to-java converter, for example, is not guaranteed, because it only works on unions.

Returns:

true if this rule can convert any relational expression

onMatch

public void onMatch(RelOptRuleCall call)

Description copied from class: RelOptRule

Receives notification about a rule match. At the time that this method is called, call.rels holds the set of relational expressions which match the operands to the rule; call.rels[0] is the root expression.

Typically a rule would check that the nodes are valid matches, creates a new expression, then calls back RelOptRuleCall.transformTo(org.apache.calcite.rel.RelNode, java.util.Map<org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode>, org.apache.calcite.plan.RelHintsPropagator) to register the expression.

Specified by:

onMatch in class RelOptRule

Parameters:

call - Rule call

See Also:

RelOptRule.matches(RelOptRuleCall)