Package org.apache.calcite.rel.convert

Class TraitMatchingRule

java.lang.Object

org.apache.calcite.plan.RelOptRule

org.apache.calcite.rel.convert.TraitMatchingRule

public class TraitMatchingRule
extends RelOptRule

TraitMatchingRule adapts a converter rule, restricting it to fire only when its input already matches the expected output trait. This can be used with HepPlanner in cases where alternate implementations are available and it is desirable to minimize converters.

Field Summary

Fields

Modifier and Type	Field	Description
private ConverterRule	converter

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

description, operands, relBuilderFactory

Constructor Summary

Constructors

Constructor	Description
TraitMatchingRule(ConverterRule converterRule)	Deprecated.
TraitMatchingRule(ConverterRule converterRule, RelBuilderFactory relBuilderFactory)	Creates a TraitMatchingRule.

Method Summary

Modifier and Type	Method	Description
Convention	getOutConvention()	Returns the convention of the result of firing this rule, null if not known.
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, getOutTrait, 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

converter

private final ConverterRule converter

Constructor Detail

TraitMatchingRule

@Deprecated
public TraitMatchingRule(ConverterRule converterRule)

Deprecated.

TraitMatchingRule

public TraitMatchingRule(ConverterRule converterRule,
                         RelBuilderFactory relBuilderFactory)

Creates a TraitMatchingRule.

Parameters:

converterRule - Rule to be restricted; rule must take a single operand expecting a single input

relBuilderFactory - Builder for relational expressions

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

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>) to register the expression.

Specified by:

onMatch in class RelOptRule

Parameters:

call - Rule call

See Also:

RelOptRule.matches(RelOptRuleCall)