org.apache.calcite.rel.core

Enum JoinRelType

java.lang.Object

java.lang.Enum<JoinRelType>

org.apache.calcite.rel.core.JoinRelType

All Implemented Interfaces:

Serializable, Comparable<JoinRelType>

public enum JoinRelType
extends Enum<JoinRelType>

Enumeration of join types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FULL
INNER
LEFT
RIGHT

Method Summary

Methods

Modifier and Type	Method and Description
JoinRelType	cancelNullsOnLeft() Returns a join type similar to this but that does not generate nulls on the left.
JoinRelType	cancelNullsOnRight() Returns a join type similar to this but that does not generate nulls on the right.
boolean	generatesNullsOn(int i) Returns whether this join type generates nulls on side #i.
boolean	generatesNullsOnLeft() Returns whether a join of this type may generate NULL values on the left-hand side.
boolean	generatesNullsOnRight() Returns whether a join of this type may generate NULL values on the right-hand side.
JoinRelType	swap() Swaps left to right, and vice versa.
static JoinRelType	valueOf(String name) Returns the enum constant of this type with the specified name.
static JoinRelType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INNER

public static final JoinRelType INNER

LEFT

public static final JoinRelType LEFT

RIGHT

public static final JoinRelType RIGHT

FULL

public static final JoinRelType FULL

Method Detail

values

public static JoinRelType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JoinRelType c : JoinRelType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JoinRelType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

generatesNullsOnRight

public boolean generatesNullsOnRight()

Returns whether a join of this type may generate NULL values on the right-hand side.

generatesNullsOnLeft

public boolean generatesNullsOnLeft()

Returns whether a join of this type may generate NULL values on the left-hand side.

swap

public JoinRelType swap()

Swaps left to right, and vice versa.

generatesNullsOn

public boolean generatesNullsOn(int i)

Returns whether this join type generates nulls on side #i.

cancelNullsOnLeft

public JoinRelType cancelNullsOnLeft()

Returns a join type similar to this but that does not generate nulls on the left.

cancelNullsOnRight

public JoinRelType cancelNullsOnRight()

Returns a join type similar to this but that does not generate nulls on the right.