org.apache.calcite.sql

Class SqlJoin

java.lang.Object

org.apache.calcite.sql.SqlNode

org.apache.calcite.sql.SqlCall

org.apache.calcite.sql.SqlJoin

All Implemented Interfaces:

Cloneable

public class SqlJoin
extends SqlCall

Parse tree node representing a JOIN clause.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqlJoin.SqlJoinOperator SqlJoinOperator describes the syntax of the SQL JOIN operator.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) SqlNode	condition
(package private) SqlLiteral	conditionType Value must be a SqlLiteral, one of the integer codes for JoinConditionType.
(package private) SqlLiteral	joinType Value must be a SqlLiteral, one of the integer codes for JoinType.
(package private) SqlNode	left
(package private) SqlLiteral	natural Operand says whether this is a natural join.
static SqlJoin.SqlJoinOperator	OPERATOR
(package private) SqlNode	right

Fields inherited from class org.apache.calcite.sql.SqlNode

EMPTY_ARRAY, pos

Constructor Summary

Constructors

Constructor and Description
SqlJoin(SqlParserPos pos, SqlNode left, SqlLiteral natural, SqlLiteral joinType, SqlNode right, SqlLiteral conditionType, SqlNode condition)

Method Summary

Modifier and Type	Method and Description
SqlNode	getCondition()
JoinConditionType	getConditionType() Returns a JoinConditionType, never null.
SqlLiteral	getConditionTypeNode()
JoinType	getJoinType() Returns a JoinType, never null.
SqlLiteral	getJoinTypeNode()
SqlKind	getKind() Returns the type of node this is, or SqlKind.OTHER if it's nothing special.
SqlNode	getLeft()
List<SqlNode>	getOperandList()
SqlOperator	getOperator()
SqlNode	getRight()
boolean	isNatural()
SqlLiteral	isNaturalNode()
void	setLeft(SqlNode left)
void	setOperand(int i, SqlNode operand) Changes the value of an operand.
void	setRight(SqlNode right)

Methods inherited from class org.apache.calcite.sql.SqlCall

accept, clone, equalsDeep, findValidOptions, getCallSignature, getFunctionQuantifier, getMonotonicity, isCountStar, isExpanded, operand, operandCount, unparse, validate

Methods inherited from class org.apache.calcite.sql.SqlNode

clone, clone, cloneArray, equalDeep, equalDeep, equalsDeep, getParserPosition, isA, toSqlString, toSqlString, toString, validateExpr

Methods inherited from class java.lang.Object

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

Field Detail

OPERATOR

public static final SqlJoin.SqlJoinOperator OPERATOR

left

SqlNode left

natural

SqlLiteral natural

Operand says whether this is a natural join. Must be constant TRUE or FALSE.

joinType

SqlLiteral joinType

Value must be a SqlLiteral, one of the integer codes for JoinType.

right

SqlNode right

conditionType

SqlLiteral conditionType

Value must be a SqlLiteral, one of the integer codes for JoinConditionType.

condition

SqlNode condition

Constructor Detail

SqlJoin

public SqlJoin(SqlParserPos pos,
               SqlNode left,
               SqlLiteral natural,
               SqlLiteral joinType,
               SqlNode right,
               SqlLiteral conditionType,
               SqlNode condition)

Method Detail

getOperator

public SqlOperator getOperator()

Specified by:

getOperator in class SqlCall

getKind

public SqlKind getKind()

Description copied from class: SqlNode

Returns the type of node this is, or SqlKind.OTHER if it's nothing special.

Overrides:

getKind in class SqlCall

Returns:

a SqlKind value, never null

See Also:

SqlNode.isA(java.util.Set<org.apache.calcite.sql.SqlKind>)

getOperandList

public List<SqlNode> getOperandList()

Specified by:

getOperandList in class SqlCall

setOperand

public void setOperand(int i,
                       SqlNode operand)

Description copied from class: SqlCall

Changes the value of an operand. Allows some rewrite by SqlValidator; use sparingly.

Overrides:

setOperand in class SqlCall

Parameters:

i - Operand index

operand - Operand value

getCondition

public final SqlNode getCondition()

getConditionType

public final JoinConditionType getConditionType()

Returns a JoinConditionType, never null.

getConditionTypeNode

public SqlLiteral getConditionTypeNode()

getJoinType

public final JoinType getJoinType()

Returns a JoinType, never null.

getJoinTypeNode

public SqlLiteral getJoinTypeNode()

getLeft

public final SqlNode getLeft()

setLeft

public void setLeft(SqlNode left)

isNatural

public final boolean isNatural()

isNaturalNode

public final SqlLiteral isNaturalNode()

getRight

public final SqlNode getRight()

setRight

public void setRight(SqlNode right)