org.apache.calcite.rex

Class RexTableInputRef

java.lang.Object

org.apache.calcite.rex.RexNode

org.apache.calcite.rex.RexVariable

org.apache.calcite.rex.RexSlot

org.apache.calcite.rex.RexInputRef

org.apache.calcite.rex.RexTableInputRef

public class RexTableInputRef
extends RexInputRef

Variable which references a column of a table occurrence in a relational plan.

This object is used by BuiltInMetadata.ExpressionLineage and BuiltInMetadata.AllPredicates.

Given a relational expression, its purpose is to be able to reference uniquely the provenance of a given expression. For that, it uses a unique table reference (contained in a RexTableInputRef.RelTableRef) and an column index within the table.

For example, A.#0.$3 + 2 column $3 in the 0 occurrence of table A in the plan.

Note that this kind of RexNode is an auxiliary data structure with a very specific purpose and should not be used in relational expressions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RexTableInputRef.RelTableRef Identifies uniquely a table by its qualified name and its entity number (occurrence)

Nested classes/interfaces inherited from class org.apache.calcite.rex.RexSlot

RexSlot.SelfPopulatingList

Field Summary

Fields

Modifier and Type	Field and Description
private RexTableInputRef.RelTableRef	tableRef

Fields inherited from class org.apache.calcite.rex.RexSlot

index

Fields inherited from class org.apache.calcite.rex.RexVariable

name, type

Fields inherited from class org.apache.calcite.rex.RexNode

digest

Constructor Summary

Constructors

Modifier	Constructor and Description
private	RexTableInputRef(RexTableInputRef.RelTableRef tableRef, int index, RelDataType type)

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(RexBiVisitor<R,P> visitor, P arg) Accepts a visitor with a payload, dispatching to the right overloaded RexBiVisitor.visitInputRef(RexInputRef, Object) visitXxx} method.
<R> R	accept(RexVisitor<R> visitor) Accepts a visitor, dispatching to the right overloaded visitXxx method.
boolean	equals(Object obj)
int	getIdentifier()
SqlKind	getKind() Returns the kind of node this is.
List<String>	getQualifiedName()
RexTableInputRef.RelTableRef	getTableRef()
int	hashCode()
static RexTableInputRef	of(RexTableInputRef.RelTableRef tableRef, int index, RelDataType type)
static RexTableInputRef	of(RexTableInputRef.RelTableRef tableRef, RexInputRef ref)

Methods inherited from class org.apache.calcite.rex.RexInputRef

createName, of, of, of2

Methods inherited from class org.apache.calcite.rex.RexSlot

getIndex

Methods inherited from class org.apache.calcite.rex.RexVariable

getName, getType

Methods inherited from class org.apache.calcite.rex.RexNode

isA, isA, isAlwaysFalse, isAlwaysTrue, toString

Methods inherited from class java.lang.Object

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

Field Detail

tableRef

private final RexTableInputRef.RelTableRef tableRef

Constructor Detail

RexTableInputRef

private RexTableInputRef(RexTableInputRef.RelTableRef tableRef,
                         int index,
                         RelDataType type)

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class RexInputRef

hashCode

public int hashCode()

Overrides:

hashCode in class RexInputRef

getTableRef

public RexTableInputRef.RelTableRef getTableRef()

getQualifiedName

public List<String> getQualifiedName()

getIdentifier

public int getIdentifier()

of

public static RexTableInputRef of(RexTableInputRef.RelTableRef tableRef,
                                  int index,
                                  RelDataType type)

of

public static RexTableInputRef of(RexTableInputRef.RelTableRef tableRef,
                                  RexInputRef ref)

accept

public <R> R accept(RexVisitor<R> visitor)

Description copied from class: RexNode

Accepts a visitor, dispatching to the right overloaded visitXxx method.

Also see RexUtil.apply(RexVisitor, java.util.List, RexNode), which applies a visitor to several expressions simultaneously.

Overrides:

accept in class RexInputRef

accept

public <R,P> R accept(RexBiVisitor<R,P> visitor,
                      P arg)

Description copied from class: RexNode

Accepts a visitor with a payload, dispatching to the right overloaded RexBiVisitor.visitInputRef(RexInputRef, Object) visitXxx} method.

Overrides:

accept in class RexInputRef

getKind

public SqlKind getKind()

Description copied from class: RexNode

Returns the kind of node this is.

Overrides:

getKind in class RexInputRef

Returns:

Node kind, never null