Package org.apache.calcite.sql.fun

Class SqlItemOperator

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlSpecialOperator

org.apache.calcite.sql.fun.SqlItemOperator

public class SqlItemOperator
extends SqlSpecialOperator

The item operator [ ... ], used to access a given element of an array, map or struct. For example, myArray[3], "myMap['foo']", myStruct[2] or myStruct['fieldName'].

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.calcite.sql.SqlSpecialOperator

SqlSpecialOperator.ReduceResult, SqlSpecialOperator.TokenSequence

Field Summary

Fields

Modifier and Type	Field	Description
final int	offset
final boolean	safe

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor	Description
SqlItemOperator(String name, SqlSingleOperandTypeChecker operandTypeChecker, int offset, boolean safe)

Method Summary

Modifier and Type	Method	Description
boolean	checkOperandTypes(SqlCallBinding callBinding, boolean throwOnFailure)	Checks that the operand values in a SqlCall to this operator are valid.
String	getAllowedSignatures(String name)	Returns a string describing the expected operand types of a call, e.g.
SqlOperandCountRange	getOperandCountRange()	Returns a constraint on the number of operands expected by this operator.
SqlSingleOperandTypeChecker	getOperandTypeChecker()
RelDataType	inferReturnType(SqlOperatorBinding opBinding)	Infers the return type of an invocation of this operator; only called after the number and types of operands have already been validated.
SqlSpecialOperator.ReduceResult	reduceExpr(int ordinal, SqlSpecialOperator.TokenSequence list)	Reduces a list of operators and arguments according to the rules of precedence and associativity.
void	unparse(SqlWriter writer, SqlCall call, int leftPrec, int rightPrec)	Writes a SQL representation of a call to this operator to a writer, including parentheses if the operators on either side are of greater precedence.

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

getSyntax

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

acceptCall, acceptCall, adjustType, allowsFraming, argumentMustBeScalar, checkOperandCount, constructArgNameList, constructArgTypeList, constructOperandList, createCall, createCall, createCall, createCall, createCall, createCall, createCall, deriveOperandType, deriveType, equals, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getMonotonicity, getName, getNameAsId, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, getSqlCallFactory, getStrongPolicyInference, hashCode, inferReturnType, isAggregator, isDeterministic, isDynamicFunction, isGroup, isGroupAuxiliary, isName, isSymmetrical, leftPrec, not, preValidateCall, requiresDecimalExpansion, requiresOrder, requiresOver, reverse, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateCall, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

offset

public final int offset

safe

public final boolean safe

Constructor Details

SqlItemOperator

public SqlItemOperator(String name,
 SqlSingleOperandTypeChecker operandTypeChecker,
 int offset,
 boolean safe)

Method Details

reduceExpr

public SqlSpecialOperator.ReduceResult reduceExpr(int ordinal,
 SqlSpecialOperator.TokenSequence list)

Description copied from class: SqlSpecialOperator

Reduces a list of operators and arguments according to the rules of precedence and associativity. Returns the ordinal of the node which replaced the expression.

The default implementation throws UnsupportedOperationException.

Overrides:

reduceExpr in class SqlSpecialOperator

Parameters:

ordinal - indicating the ordinal of the current operator in the list on which a possible reduction can be made

list - List of alternating SqlParserUtil.ToTreeListItem and SqlNode

Returns:

ordinal of the node which replaced the expression

unparse

public void unparse(SqlWriter writer,
 SqlCall call,
 int leftPrec,
 int rightPrec)

Description copied from class: SqlOperator

Writes a SQL representation of a call to this operator to a writer, including parentheses if the operators on either side are of greater precedence.

The default implementation of this method delegates to SqlSyntax.unparse(org.apache.calcite.sql.SqlWriter, org.apache.calcite.sql.SqlOperator, org.apache.calcite.sql.SqlCall, int, int).

Overrides:

unparse in class SqlOperator

getOperandCountRange

public SqlOperandCountRange getOperandCountRange()

Description copied from class: SqlOperator

Returns a constraint on the number of operands expected by this operator. Subclasses may override this method; when they don't, the range is derived from the SqlOperandTypeChecker associated with this operator.

Overrides:

getOperandCountRange in class SqlOperator

Returns:

acceptable range

checkOperandTypes

public boolean checkOperandTypes(SqlCallBinding callBinding,
 boolean throwOnFailure)

Description copied from class: SqlOperator

Checks that the operand values in a SqlCall to this operator are valid. Subclasses must either override this method or supply an instance of SqlOperandTypeChecker to the constructor.

Overrides:

checkOperandTypes in class SqlOperator

Parameters:

callBinding - description of call

throwOnFailure - whether to throw an exception if check fails (otherwise returns false in that case)

Returns:

whether check succeeded

getOperandTypeChecker

public SqlSingleOperandTypeChecker getOperandTypeChecker()

Overrides:

getOperandTypeChecker in class SqlOperator

getAllowedSignatures

public String getAllowedSignatures(String name)

Description copied from class: SqlOperator

Returns a string describing the expected operand types of a call, e.g. "SUBSTRING(VARCHAR, INTEGER, INTEGER)" where the name (SUBSTRING in this example) can be replaced by a specified name.

Overrides:

getAllowedSignatures in class SqlOperator

inferReturnType

public RelDataType inferReturnType(SqlOperatorBinding opBinding)

Description copied from class: SqlOperator

Infers the return type of an invocation of this operator; only called after the number and types of operands have already been validated. Subclasses must either override this method or supply an instance of SqlReturnTypeInference to the constructor.

Overrides:

inferReturnType in class SqlOperator

Parameters:

opBinding - description of invocation (not necessarily a SqlCall)

Returns:

inferred return type