org.apache.calcite.rel.rules

Class CoerceInputsRule

java.lang.Object

org.apache.calcite.plan.RelOptRule

org.apache.calcite.rel.rules.CoerceInputsRule

public class CoerceInputsRule
extends RelOptRule

CoerceInputsRule pre-casts inputs to a particular type. This can be used to assist operator implementations which impose requirements on their input types.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	coerceNames
private Class	consumerRelClass

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

description, operands, relBuilderFactory

Constructor Summary

Constructors

Constructor and Description
CoerceInputsRule(Class<? extends RelNode> consumerRelClass, boolean coerceNames) Deprecated.
CoerceInputsRule(Class<? extends RelNode> consumerRelClass, boolean coerceNames, RelBuilderFactory relBuilderFactory) Creates a CoerceInputsRule.

Method Summary

Modifier and Type	Method and 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, equals, equals, getOperand, getOperands, getOutTrait, hashCode, matches, none, operand, operand, operand, operand, operand, some, toString, unordered

Methods inherited from class java.lang.Object

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

Field Detail

consumerRelClass

private final Class consumerRelClass

coerceNames

private final boolean coerceNames

Constructor Detail

CoerceInputsRule

@Deprecated
public CoerceInputsRule(Class<? extends RelNode> consumerRelClass,
                                    boolean coerceNames)

Deprecated.

CoerceInputsRule

public CoerceInputsRule(Class<? extends RelNode> consumerRelClass,
                        boolean coerceNames,
                        RelBuilderFactory relBuilderFactory)

Creates a CoerceInputsRule.

Parameters:

consumerRelClass - Class of RelNode that will consume the inputs

coerceNames - If true, coerce names and types; if false, coerce type only

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)