Package 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

Direct Known Subclasses:

SqlAsofJoin

public class SqlJoin
extends SqlCall

Parse tree node representing a JOIN clause.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final SqlJoin.SqlJoinOperator	OPERATOR

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

EMPTY_ARRAY, pos

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
final @Nullable SqlNode	getCondition()
final JoinConditionType	getConditionType()	Returns a JoinConditionType, never null.
SqlLiteral	getConditionTypeNode()
final 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.
final SqlNode	getLeft()
List<SqlNode>	getOperandList()	Returns the list of operands.
SqlOperator	getOperator()
final SqlNode	getRight()
final boolean	isNatural()
final SqlLiteral	isNaturalNode()
void	setLeft(SqlNode left)
void	setOperand(int i, @Nullable SqlNode operand)	Changes the value of an operand.
void	setRight(SqlNode right)
SqlString	toSqlString(UnaryOperator<SqlWriterConfig> transform)	Returns the SQL text of the tree of which this SqlNode is the root.

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, toList, toList, toSqlString, toSqlString, toString, unparseWithParentheses, validateExpr

Methods inherited from class java.lang.Object

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

Field Details

OPERATOR

public static final SqlJoin.SqlJoinOperator OPERATOR

Constructor Details

SqlJoin

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

Method Details

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()

Description copied from class: SqlCall

Returns the list of operands. The set and order of operands is call-specific.

Note: the proper type would be List<@Nullable SqlNode>, however, it would trigger too many changes to the current codebase.

Specified by:

getOperandList in class SqlCall

Returns:

the list of call operands, never null, the operands can be null

setOperand

public void setOperand(int i,
 @Nullable 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 @Nullable 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)

toSqlString

public SqlString toSqlString(UnaryOperator<SqlWriterConfig> transform)

Description copied from class: SqlNode

Returns the SQL text of the tree of which this SqlNode is the root.

Typical return values are:

• 'It''s a bird!'
• NULL
• 12.3
• DATE '1969-04-29'

Overrides:

toSqlString in class SqlNode

Parameters:

transform - Transform that sets desired writer configuration