org.apache.calcite.rel.core

Class JoinInfo

java.lang.Object

org.apache.calcite.rel.core.JoinInfo

public abstract class JoinInfo
extends Object

An analyzed join condition.

It is useful for the many algorithms that care whether a join is an equi-join.

You can create one using of(org.apache.calcite.rel.RelNode, org.apache.calcite.rel.RelNode, org.apache.calcite.rex.RexNode), or call Join.analyzeCondition(); many kinds of join cache their join info, especially those that are equi-joins and sub-class EquiJoin.

See Also:

Join.analyzeCondition()

Field Summary

Fields

Modifier and Type	Field and Description
ImmutableIntList	leftKeys
ImmutableIntList	rightKeys

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JoinInfo(ImmutableIntList leftKeys, ImmutableIntList rightKeys) Creates a JoinInfo.

Method Summary

Methods

Modifier and Type	Method and Description
RexNode	getEquiCondition(RelNode left, RelNode right, RexBuilder rexBuilder)
abstract RexNode	getRemaining(RexBuilder rexBuilder)
abstract boolean	isEqui() Returns whether this is an equi-join.
List<ImmutableIntList>	keys()
ImmutableBitSet	leftSet()
static JoinInfo	of(ImmutableIntList leftKeys, ImmutableIntList rightKeys) Creates an equi-join.
static JoinInfo	of(RelNode left, RelNode right, RexNode condition) Creates a JoinInfo by analyzing a condition.
List<IntPair>	pairs() Returns a list of (left, right) key ordinals.
ImmutableBitSet	rightSet()

Methods inherited from class java.lang.Object

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

Field Detail

leftKeys

public final ImmutableIntList leftKeys

rightKeys

public final ImmutableIntList rightKeys

Constructor Detail

JoinInfo

protected JoinInfo(ImmutableIntList leftKeys,
        ImmutableIntList rightKeys)

Creates a JoinInfo.

Method Detail

of

public static JoinInfo of(RelNode left,
          RelNode right,
          RexNode condition)

Creates a JoinInfo by analyzing a condition.

of

public static JoinInfo of(ImmutableIntList leftKeys,
          ImmutableIntList rightKeys)

Creates an equi-join.

isEqui

public abstract boolean isEqui()

Returns whether this is an equi-join.

pairs

public List<IntPair> pairs()

Returns a list of (left, right) key ordinals.

leftSet

public ImmutableBitSet leftSet()

rightSet

public ImmutableBitSet rightSet()

getRemaining

public abstract RexNode getRemaining(RexBuilder rexBuilder)

getEquiCondition

public RexNode getEquiCondition(RelNode left,
                       RelNode right,
                       RexBuilder rexBuilder)

keys

public List<ImmutableIntList> keys()