org.apache.calcite.rel.core

Class SetOp

java.lang.Object

org.apache.calcite.rel.AbstractRelNode

org.apache.calcite.rel.core.SetOp

All Implemented Interfaces:

Cloneable, RelOptNode, RelNode

Direct Known Subclasses:

Intersect, Minus, Union

public abstract class SetOp
extends AbstractRelNode

SetOp is an abstract base for relational set operators such as UNION, MINUS (aka EXCEPT), and INTERSECT.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	all
protected com.google.common.collect.ImmutableList<RelNode>	inputs
SqlKind	kind

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

digest, id, rowType, traitSet

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SetOp(RelInput input) Creates a SetOp by parsing serialized output.
protected	SetOp(RelOptCluster cluster, RelTraitSet traits, List<RelNode> inputs, SqlKind kind, boolean all) Creates a SetOp.

Method Summary

Methods

Modifier and Type	Method and Description
SetOp	copy(RelTraitSet traitSet, List<RelNode> inputs) Creates a copy of this relational expression, perhaps changing traits and inputs.
abstract SetOp	copy(RelTraitSet traitSet, List<RelNode> inputs, boolean all)
protected RelDataType	deriveRowType()
RelWriter	explainTerms(RelWriter pw) Describes the inputs and attributes of this relational expression.
List<RelNode>	getInputs() Returns an array of this relational expression's inputs.
boolean	isHomogeneous(boolean compareNames) Returns whether all the inputs of this set operator have the same row type as its output row.
boolean	isKey(ImmutableBitSet columns) Returns whether the result of this relational expression is uniquely identified by this columns with the given ordinals.
void	replaceInput(int ordinalInParent, RelNode p) Replaces the ordinalInParentth input.

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

accept, accept, childrenAccept, collectVariablesSet, collectVariablesUsed, computeDigest, computeSelfCost, explain, getChildExps, getCluster, getCollationList, getConvention, getCorrelVariable, getDescription, getDigest, getExpectedInputRowType, getId, getInput, getQuery, getRelTypeName, getRows, getRowType, getTable, getTraitSet, getVariablesStopped, isDistinct, isValid, metadata, onRegister, recomputeDigest, register, sole, toString

Methods inherited from class java.lang.Object

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

Field Detail

inputs

protected com.google.common.collect.ImmutableList<RelNode> inputs

kind

public final SqlKind kind

all

public final boolean all

Constructor Detail

SetOp

protected SetOp(RelOptCluster cluster,
     RelTraitSet traits,
     List<RelNode> inputs,
     SqlKind kind,
     boolean all)

Creates a SetOp.

SetOp

protected SetOp(RelInput input)

Creates a SetOp by parsing serialized output.

Method Detail

copy

public abstract SetOp copy(RelTraitSet traitSet,
         List<RelNode> inputs,
         boolean all)

copy

public SetOp copy(RelTraitSet traitSet,
         List<RelNode> inputs)

Description copied from interface: RelNode

Creates a copy of this relational expression, perhaps changing traits and inputs.

Sub-classes with other important attributes are encouraged to create variants of this method with more parameters.

Specified by:

copy in interface RelNode

Overrides:

copy in class AbstractRelNode

Parameters:

traitSet - Trait set

inputs - Inputs

Returns:

Copy of this relational expression, substituting traits and inputs

replaceInput

public void replaceInput(int ordinalInParent,
                RelNode p)

Description copied from interface: RelNode

Replaces the ordinalInParent^th input. You must override this method if you override RelNode.getInputs().

Specified by:

replaceInput in interface RelNode

Overrides:

replaceInput in class AbstractRelNode

Parameters:

ordinalInParent - Position of the child input, 0 is the first

p - New node that should be put at position ordinalInParent

isKey

public boolean isKey(ImmutableBitSet columns)

Description copied from interface: RelNode

Returns whether the result of this relational expression is uniquely identified by this columns with the given ordinals.

For example, if this relational expression is a LogicalTableScan to T(A, B, C, D) whose key is (A, B), then isKey([0, 1]) yields true, and isKey([0]) and isKey([0, 2]) yields false.

Specified by:

isKey in interface RelNode

Overrides:

isKey in class AbstractRelNode

Parameters:

columns - Ordinals of key columns

Returns:

Whether the given columns are a key or a superset of a key

getInputs

public List<RelNode> getInputs()

Description copied from interface: RelNode

Returns an array of this relational expression's inputs. If there are no inputs, returns an empty list, not null.

Specified by:

getInputs in interface RelOptNode

Specified by:

getInputs in interface RelNode

Overrides:

getInputs in class AbstractRelNode

Returns:

Array of this relational expression's inputs

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 RelWriterImpl.input(String, RelNode) and RelWriterImpl.item(String, Object) methods for each input and attribute.

Overrides:

explainTerms in class AbstractRelNode

Parameters:

pw - Plan writer

Returns:

Plan writer for fluent-explain pattern

deriveRowType

protected RelDataType deriveRowType()

Overrides:

deriveRowType in class AbstractRelNode

isHomogeneous

public boolean isHomogeneous(boolean compareNames)

Returns whether all the inputs of this set operator have the same row type as its output row.

Parameters:

compareNames - Whether column names are important in the homogeneity comparison

Returns:

Whether all the inputs of this set operator have the same row type as its output row