org.apache.calcite.rel.logical

Class LogicalProject

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.SingleRel

org.apache.calcite.rel.core.Project

org.apache.calcite.rel.logical.LogicalProject

All Implemented Interfaces:

Cloneable, RelOptNode, Hintable, RelNode

public final class LogicalProject
extends Project

Sub-class of Project not targeted at any particular engine or calling convention.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.calcite.rel.core.Project

Project.Flags

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

RelNode.Context

Field Summary

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

exps, hints

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
LogicalProject(RelInput input) Creates a LogicalProject by parsing serialized output.
LogicalProject(RelOptCluster cluster, RelNode input, List<RexNode> projects, @Nullable List<? extends String> fieldNames, int flags) Deprecated.
LogicalProject(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelNode input, List<? extends RexNode> projects, RelDataType rowType) Creates a LogicalProject.
LogicalProject(RelOptCluster cluster, RelTraitSet traitSet, RelNode input, List<? extends RexNode> projects, RelDataType rowType) Deprecated.
LogicalProject(RelOptCluster cluster, RelTraitSet traitSet, RelNode input, List<? extends RexNode> projects, RelDataType rowType, int flags) Deprecated.

Method Summary

Modifier and Type	Method and Description
RelNode	accept(RelShuttle shuttle) Accepts a visit from a shuttle.
LogicalProject	copy(RelTraitSet traitSet, RelNode input, List<RexNode> projects, RelDataType rowType) Copies a project.
static LogicalProject	create(RelNode input, List<RelHint> hints, List<? extends RexNode> projects, @Nullable List<? extends String> fieldNames) Creates a LogicalProject.
static LogicalProject	create(RelNode input, List<RelHint> hints, List<? extends RexNode> projects, RelDataType rowType) Creates a LogicalProject, specifying row type rather than field names.
boolean	deepEquals(@Nullable Object obj) Equality check for RelNode digest.
int	deepHashCode() Compute hash code for RelNode digest.
RelNode	withHints(List<RelHint> hintList) Returns a new relational expression with the specified hints hintList.

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

accept, computeSelfCost, containsOver, copy, copy, deepEquals0, deepHashCode0, explainTerms, getFlags, getHints, getMapping, getMapping, getNamedProjects, getPartialMapping, getPermutation, getPermutation, getProjects, isBoxed, isMapping, isValid

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

childrenAccept, deriveRowType, estimateRowCount, getInput, getInputs, replaceInput

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

collectVariablesSet, collectVariablesUsed, 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

LogicalProject

public LogicalProject(RelOptCluster cluster,
                      RelTraitSet traitSet,
                      List<RelHint> hints,
                      RelNode input,
                      List<? extends RexNode> projects,
                      RelDataType rowType)

Creates a LogicalProject.

Use create(org.apache.calcite.rel.RelNode, java.util.List<org.apache.calcite.rel.hint.RelHint>, java.util.List<? extends org.apache.calcite.rex.RexNode>, java.util.List<? extends java.lang.String>) unless you know what you're doing.

Parameters:

cluster - Cluster this relational expression belongs to

traitSet - Traits of this relational expression

hints - Hints of this relational expression

input - Input relational expression

projects - List of expressions for the input columns

rowType - Output row type

LogicalProject

@Deprecated
public LogicalProject(RelOptCluster cluster,
                                  RelTraitSet traitSet,
                                  RelNode input,
                                  List<? extends RexNode> projects,
                                  RelDataType rowType)

Deprecated.

LogicalProject

@Deprecated
public LogicalProject(RelOptCluster cluster,
                                  RelTraitSet traitSet,
                                  RelNode input,
                                  List<? extends RexNode> projects,
                                  RelDataType rowType,
                                  int flags)

Deprecated.

LogicalProject

@Deprecated
public LogicalProject(RelOptCluster cluster,
                                  RelNode input,
                                  List<RexNode> projects,
                                  @Nullable List<? extends String> fieldNames,
                                  int flags)

Deprecated.

LogicalProject

public LogicalProject(RelInput input)

Creates a LogicalProject by parsing serialized output.

Method Detail

create

public static LogicalProject create(RelNode input,
                                    List<RelHint> hints,
                                    List<? extends RexNode> projects,
                                    @Nullable List<? extends String> fieldNames)

Creates a LogicalProject.

create

public static LogicalProject create(RelNode input,
                                    List<RelHint> hints,
                                    List<? extends RexNode> projects,
                                    RelDataType rowType)

Creates a LogicalProject, specifying row type rather than field names.

copy

public LogicalProject copy(RelTraitSet traitSet,
                           RelNode input,
                           List<RexNode> projects,
                           RelDataType rowType)

Description copied from class: Project

Copies a project.

Specified by:

copy in class Project

Parameters:

traitSet - Traits

input - Input

projects - Project expressions

rowType - Output row type

Returns:

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

See Also:

Project.copy(RelTraitSet, List)

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

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

deepEquals

public boolean deepEquals(@Nullable Object obj)

Description copied from class: AbstractRelNode

Equality check for RelNode digest.

By default this method collects digest attributes from AbstractRelNode.explainTerms(RelWriter), then compares each attribute pair. This should work well for most cases. If this method is a performance bottleneck for your project, or the default behavior can't handle your scenario properly, you can choose to override this method and AbstractRelNode.deepHashCode(). See LogicalJoin as an example.

Specified by:

deepEquals in interface RelNode

Overrides:

deepEquals in class AbstractRelNode

Returns:

Whether the 2 RelNodes are equivalent or have the same digest.

See Also:

AbstractRelNode.deepHashCode()

deepHashCode

public int deepHashCode()

Description copied from class: AbstractRelNode

Compute hash code for RelNode digest.

Specified by:

deepHashCode in interface RelNode

Overrides:

deepHashCode in class AbstractRelNode

See Also:

RelNode.deepEquals(Object)