org.apache.calcite.sql

Class SqlBasicCall

java.lang.Object

org.apache.calcite.sql.SqlNode

org.apache.calcite.sql.SqlCall

org.apache.calcite.sql.SqlBasicCall

All Implemented Interfaces:

Cloneable

public class SqlBasicCall
extends SqlCall

Implementation of SqlCall that keeps its operands in an array.

Field Summary

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

EMPTY_ARRAY, pos

Constructor Summary

Constructors

Constructor and Description
SqlBasicCall(SqlOperator operator, List<? extends SqlNode> operandList, SqlParserPos pos) Creates a SqlBasicCall.
SqlBasicCall(SqlOperator operator, List<? extends SqlNode> operandList, SqlParserPos pos, @Nullable SqlLiteral functionQualifier) Creates a SqlBasicCall with an optional function qualifier.
SqlBasicCall(SqlOperator operator, @Nullable SqlNode[] operands, SqlParserPos pos) Deprecated.
SqlBasicCall(SqlOperator operator, @Nullable SqlNode[] operands, SqlParserPos pos, @Nullable SqlLiteral functionQualifier) Deprecated.

Method Summary

Modifier and Type	Method and Description
SqlNode	clone(SqlParserPos pos) Clones a SqlNode with a different position.
@Nullable SqlLiteral	getFunctionQuantifier()
SqlKind	getKind() Returns the type of node this is, or SqlKind.OTHER if it's nothing special.
List<SqlNode>	getOperandList() Returns the list of operands.
SqlOperator	getOperator()
<S extends SqlNode> S	operand(int i) Returns i-th operand (0-based).
int	operandCount()
void	setOperand(int i, @Nullable SqlNode operand) Changes the value of an operand.
void	setOperator(SqlOperator operator) Sets the operator (or function) that is being called.
SqlCall	withExpanded(boolean expanded) Sets whether this call is expanded.

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

accept, equalsDeep, findValidOptions, getCallSignature, getMonotonicity, isCountStar, isExpanded, unparse, validate

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlBasicCall

@Deprecated
public SqlBasicCall(SqlOperator operator,
                                @Nullable SqlNode[] operands,
                                SqlParserPos pos)

Deprecated.

SqlBasicCall

public SqlBasicCall(SqlOperator operator,
                    List<? extends SqlNode> operandList,
                    SqlParserPos pos)

Creates a SqlBasicCall.

It is not expanded; call withExpanded(true) to expand.

SqlBasicCall

@Deprecated
public SqlBasicCall(SqlOperator operator,
                                @Nullable SqlNode[] operands,
                                SqlParserPos pos,
                                @Nullable SqlLiteral functionQualifier)

Deprecated.

SqlBasicCall

public SqlBasicCall(SqlOperator operator,
                    List<? extends SqlNode> operandList,
                    SqlParserPos pos,
                    @Nullable SqlLiteral functionQualifier)

Creates a SqlBasicCall with an optional function qualifier.

It is not expanded; call withExpanded(true) to expand.

Method Detail

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

withExpanded

public SqlCall withExpanded(boolean expanded)

Sets whether this call is expanded.

See Also:

SqlCall.isExpanded()

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

setOperator

public void setOperator(SqlOperator operator)

Sets the operator (or function) that is being called.

This method is used by the validator to set a more refined version of the same operator (for instance, a version where overloading has been resolved); use with care.

getOperator

public SqlOperator getOperator()

Specified by:

getOperator in class SqlCall

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

operand

public <S extends SqlNode> S operand(int i)

Description copied from class: SqlCall

Returns i-th operand (0-based).

Note: the result might be null, so the proper signature would be <S extends @Nullable SqlNode>, however, it would trigger to many changes to the current codebase.

Overrides:

operand in class SqlCall

Type Parameters:

S - type of the result

Parameters:

i - operand index (0-based)

Returns:

i-th operand (0-based), the result might be null

operandCount

public int operandCount()

Overrides:

operandCount in class SqlCall

getFunctionQuantifier

public @Nullable SqlLiteral getFunctionQuantifier()

Overrides:

getFunctionQuantifier in class SqlCall

clone

public SqlNode clone(SqlParserPos pos)

Description copied from class: SqlNode

Clones a SqlNode with a different position.

Overrides:

clone in class SqlCall