org.apache.calcite.rel.logical

Class LogicalFilter

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.SingleRel

org.apache.calcite.rel.core.Filter

org.apache.calcite.rel.logical.LogicalFilter

All Implemented Interfaces:

Cloneable, RelOptNode, Hintable, RelNode

public final class LogicalFilter
extends Filter

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

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.Filter

condition, 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
LogicalFilter(RelInput input) Creates a LogicalFilter by parsing serialized output.
LogicalFilter(RelOptCluster cluster, RelNode child, RexNode condition) Deprecated.
LogicalFilter(RelOptCluster cluster, RelTraitSet traitSet, List<RelHint> hints, RelNode child, RexNode condition, com.google.common.collect.ImmutableSet<CorrelationId> variablesSet) Creates a LogicalFilter.
LogicalFilter(RelOptCluster cluster, RelTraitSet traitSet, RelNode child, RexNode condition) Deprecated.
LogicalFilter(RelOptCluster cluster, RelTraitSet traitSet, RelNode child, RexNode condition, com.google.common.collect.ImmutableSet<CorrelationId> variablesSet) Creates a LogicalFilter.

Method Summary

Modifier and Type	Method and Description
RelNode	accept(RelShuttle shuttle) Accepts a visit from a shuttle.
LogicalFilter	copy(RelTraitSet traitSet, RelNode input, RexNode condition)
static LogicalFilter	create(RelNode input, RexNode condition) Creates a LogicalFilter.
static LogicalFilter	create(RelNode input, RexNode condition, com.google.common.collect.ImmutableSet<CorrelationId> variablesSet) Creates a LogicalFilter.
boolean	deepEquals(@Nullable Object obj) Equality check for RelNode digest.
int	deepHashCode() Compute hash code for RelNode digest.
RelWriter	explainTerms(RelWriter pw) Describes the inputs and attributes of this relational expression.
Set<CorrelationId>	getVariablesSet() Returns the variables that are set in this relational expression but also used and therefore not available to parents of this relational expression.
RelNode	withHints(List<RelHint> hintList) Returns a new relational expression with the specified hints hintList.

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

accept, computeSelfCost, containsOver, copy, deepEquals0, deepHashCode0, estimateFilteredRows, estimateFilteredRows, estimateRowCount, getCondition, getHints, 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, collectVariablesUsed, equals, explain, getCluster, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getRelDigest, getRelTypeName, getRowType, getTable, getTraitSet, 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

LogicalFilter

public LogicalFilter(RelOptCluster cluster,
                     RelTraitSet traitSet,
                     List<RelHint> hints,
                     RelNode child,
                     RexNode condition,
                     com.google.common.collect.ImmutableSet<CorrelationId> variablesSet)

Creates a LogicalFilter.

Use create(org.apache.calcite.rel.RelNode, org.apache.calcite.rex.RexNode) unless you know what you're doing.

Parameters:

cluster - Cluster that this relational expression belongs to

child - Input relational expression

condition - Boolean expression which determines whether a row is allowed to pass

variablesSet - Correlation variables set by this relational expression to be used by nested expressions

LogicalFilter

public LogicalFilter(RelOptCluster cluster,
                     RelTraitSet traitSet,
                     RelNode child,
                     RexNode condition,
                     com.google.common.collect.ImmutableSet<CorrelationId> variablesSet)

Creates a LogicalFilter.

Use create(org.apache.calcite.rel.RelNode, org.apache.calcite.rex.RexNode) unless you know what you're doing.

Parameters:

cluster - Cluster that this relational expression belongs to

child - Input relational expression

condition - Boolean expression which determines whether a row is allowed to pass

variablesSet - Correlation variables set by this relational expression to be used by nested expressions

LogicalFilter

@Deprecated
public LogicalFilter(RelOptCluster cluster,
                                 RelTraitSet traitSet,
                                 RelNode child,
                                 RexNode condition)

Deprecated.

LogicalFilter

@Deprecated
public LogicalFilter(RelOptCluster cluster,
                                 RelNode child,
                                 RexNode condition)

Deprecated.

LogicalFilter

public LogicalFilter(RelInput input)

Creates a LogicalFilter by parsing serialized output.

Method Detail

create

public static LogicalFilter create(RelNode input,
                                   RexNode condition)

Creates a LogicalFilter.

create

public static LogicalFilter create(RelNode input,
                                   RexNode condition,
                                   com.google.common.collect.ImmutableSet<CorrelationId> variablesSet)

Creates a LogicalFilter.

getVariablesSet

public Set<CorrelationId> getVariablesSet()

Description copied from interface: RelNode

Returns the variables that are set in this relational expression but also used and therefore not available to parents of this relational expression.

Note: only Correlate should set variables.

Specified by:

getVariablesSet in interface RelNode

Overrides:

getVariablesSet in class AbstractRelNode

Returns:

Names of variables which are set in this relational expression

copy

public LogicalFilter copy(RelTraitSet traitSet,
                          RelNode input,
                          RexNode condition)

Specified by:

copy in class Filter

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

explainTerms

public RelWriter explainTerms(RelWriter pw)

Description copied from class: AbstractRelNode

Describes the inputs and attributes of this relational expression. Each node should call super.explainTerms, then call the RelWriter.input(String, RelNode) and RelWriter.item(String, Object) methods for each input and attribute.

Overrides:

explainTerms in class Filter

Parameters:

pw - Plan writer

Returns:

Plan writer for fluent-explain pattern

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)

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