Package org.apache.calcite.plan.volcano

Class VolcanoRuleCall

java.lang.Object

org.apache.calcite.plan.RelOptRuleCall

org.apache.calcite.plan.volcano.VolcanoRuleCall

public class VolcanoRuleCall
extends RelOptRuleCall

VolcanoRuleCall implements the RelOptRuleCall interface for VolcanoPlanner.

Field Summary

Fields

Modifier and Type	Field	Description
protected final VolcanoPlanner	volcanoPlanner

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

id, LOGGER, nodeInputs, operand0, rels, rule

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VolcanoRuleCall(VolcanoPlanner planner, RelOptRuleOperand operand, RelNode[] rels, Map<RelNode,List<RelNode>> nodeInputs)	Creates a rule call, internal, with array to hold bindings.

Method Summary

Modifier and Type	Method	Description
protected void	onMatch()	Called when all operands have matched.
void	transformTo(RelNode rel, Map<RelNode,RelNode> equiv, RelHintsPropagator handler)	Registers that a rule has produced an equivalent relational expression.

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

builder, getChildRels, getMetadataQuery, getOperand0, getParents, getPlanner, getRelList, getRels, getRule, isRuleExcluded, rel, setChildRels, transformTo, transformTo, transformTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

volcanoPlanner

protected final VolcanoPlanner volcanoPlanner

Constructor Details

VolcanoRuleCall

protected VolcanoRuleCall(VolcanoPlanner planner,
 RelOptRuleOperand operand,
 RelNode[] rels,
 Map<RelNode,List<RelNode>> nodeInputs)

Creates a rule call, internal, with array to hold bindings.

Parameters:

planner - Planner

operand - First operand of the rule

rels - Array which will hold the matched relational expressions

nodeInputs - For each node which matched with matchAnyChildren = true, a list of the node's inputs

Method Details

transformTo

public void transformTo(RelNode rel,
 Map<RelNode,RelNode> equiv,
 RelHintsPropagator handler)

Description copied from class: RelOptRuleCall

Registers that a rule has produced an equivalent relational expression.

Called by the rule whenever it finds a match. The implementation of this method guarantees that the original relational expression (that is, this.rels[0]) has its traits propagated to the new relational expression (rel) and its unregistered children. Any trait not specifically set in the RelTraitSet returned by rel.getTraits() will be copied from this.rels[0].getTraitSet().

The hints of the root relational expression of the rule call(this.rels[0]) are copied to the new relational expression(rel) with specified handler handler.

Specified by:

transformTo in class RelOptRuleCall

Parameters:

rel - Relational expression equivalent to the root relational expression of the rule call, call.rels(0)

equiv - Map of other equivalences

handler - Handler to customize the relational expression that registers into the planner, the first parameter is the root relational expression and the second parameter is the new relational expression

onMatch

protected void onMatch()

Called when all operands have matched.