org.apache.calcite.rel.logical

Class LogicalCalc

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.SingleRel

org.apache.calcite.rel.core.Calc

org.apache.calcite.rel.logical.LogicalCalc

All Implemented Interfaces:

Cloneable, RelOptNode, Hintable, RelNode

public final class LogicalCalc
extends Calc

A relational expression which computes project expressions and also filters.

This relational expression combines the functionality of LogicalProject and LogicalFilter. It should be created in the later stages of optimization, by merging consecutive LogicalProject and LogicalFilter nodes together.

The following rules relate to LogicalCalc:

• FilterToCalcRule creates this from a LogicalFilter
• ProjectToCalcRule creates this from a LogicalProject
• FilterCalcMergeRule merges this with a LogicalFilter
• ProjectCalcMergeRule merges this with a LogicalProject
• CalcMergeRule merges two LogicalCalcs

Nested Class Summary

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

RelNode.Context

Field Summary

Fields inherited from class org.apache.calcite.rel.core.Calc

hints, program

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

Constructor and Description
LogicalCalc(RelInput input) Creates a LogicalCalc by parsing serialized output.
LogicalCalc(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelNode child, RexProgram program) Creates a LogicalCalc.
LogicalCalc(RelOptCluster cluster, RelTraitSet traitSet, RelNode child, RexProgram program) Deprecated.
LogicalCalc(RelOptCluster cluster, RelTraitSet traitSet, RelNode child, RexProgram program, List<RelCollation> collationList) Deprecated.

Method Summary

Modifier and Type	Method and Description
RelNode	accept(RelShuttle shuttle) Accepts a visit from a shuttle.
void	collectVariablesUsed(Set<CorrelationId> variableSet) Collects variables known to be used by this expression or its descendants.
LogicalCalc	copy(RelTraitSet traitSet, RelNode child, RexProgram program) Creates a copy of this Calc.
static LogicalCalc	create(RelNode input, RexProgram program)
RelNode	withHints(List<RelHint> hintList) Returns a new relational expression with the specified hints hintList.

Methods inherited from class org.apache.calcite.rel.core.Calc

accept, computeSelfCost, containsOver, copy, copy, estimateRowCount, explainTerms, getHints, getProgram, isValid

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

childrenAccept, deriveRowType, getInput, getInputs, replaceInput

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

collectVariablesSet, deepEquals, deepHashCode, equals, explain, getCluster, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getRelDigest, getRelTypeName, getRowType, getTable, getTraitSet, getVariablesSet, hashCode, isEnforcer, 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.hint.Hintable

attachHints

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

explain, fieldIsNullable

Constructor Detail

LogicalCalc

public LogicalCalc(RelOptCluster cluster,
                   RelTraitSet traitSet,
                   List<RelHint> hints,
                   RelNode child,
                   RexProgram program)

Creates a LogicalCalc.

LogicalCalc

@Deprecated
public LogicalCalc(RelOptCluster cluster,
                               RelTraitSet traitSet,
                               RelNode child,
                               RexProgram program)

Deprecated.

LogicalCalc

public LogicalCalc(RelInput input)

Creates a LogicalCalc by parsing serialized output.

LogicalCalc

@Deprecated
public LogicalCalc(RelOptCluster cluster,
                               RelTraitSet traitSet,
                               RelNode child,
                               RexProgram program,
                               List<RelCollation> collationList)

Deprecated.

Method Detail

create

public static LogicalCalc create(RelNode input,
                                 RexProgram program)

copy

public LogicalCalc copy(RelTraitSet traitSet,
                        RelNode child,
                        RexProgram program)

Description copied from class: Calc

Creates a copy of this Calc.

Specified by:

copy in class Calc

Parameters:

traitSet - Traits

child - Input relation

program - Calc program

Returns:

New Calc if any parameter differs from the value of this Calc, or just this if all the parameters are the same

See Also:

Calc.copy(org.apache.calcite.plan.RelTraitSet, java.util.List)

collectVariablesUsed

public void collectVariablesUsed(Set<CorrelationId> variableSet)

Description copied from interface: RelNode

Collects variables known to be used by this expression or its descendants. By default, no such information is available and must be derived by analyzing sub-expressions, but some optimizer implementations may insert special expressions which remember such information.

Specified by:

collectVariablesUsed in interface RelNode

Overrides:

collectVariablesUsed in class AbstractRelNode

Parameters:

variableSet - receives variables used

withHints

public RelNode withHints(List<RelHint> hintList)

Description copied from interface: Hintable

Returns a new relational expression with the specified hints hintList.

This method should be overridden by every logical node that supports hint. It is only for internal use during decorrelation.

Sub-class should return a new copy of the relational expression.

The default implementation returns the relational expression directly only because not every kind of relational expression supports hints.

Returns:

Relational expression with set up hints

accept

public RelNode accept(RelShuttle shuttle)

Description copied from interface: RelNode

Accepts a visit from a shuttle.

Specified by:

accept in interface RelNode

Overrides:

accept in class AbstractRelNode

Parameters:

shuttle - Shuttle

Returns:

A copy of this node incorporating changes made by the shuttle to this node's children