Package org.apache.calcite.sql.type
Interface SqlSingleOperandTypeChecker
-
- All Superinterfaces:
SqlOperandTypeChecker
- All Known Implementing Classes:
ComparableOperandTypeChecker
,CompositeSingleOperandTypeChecker
,FamilyOperandTypeChecker
,LiteralOperandTypeChecker
,OperandTypes.PeriodOperandTypeChecker
,SameOperandTypeChecker
,SameOperandTypeExceptLastOperandChecker
public interface SqlSingleOperandTypeChecker extends SqlOperandTypeChecker
SqlSingleOperandTypeChecker is an extension ofSqlOperandTypeChecker
for implementations which are capable of checking the type of a single operand in isolation. This isn't meaningful for all type-checking rules (e.g. SameOperandTypeChecker requires two operands to have matching types, so checking one in isolation is meaningless).
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.apache.calcite.sql.type.SqlOperandTypeChecker
SqlOperandTypeChecker.Consistency
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
checkSingleOperandType(SqlCallBinding callBinding, SqlNode operand, int iFormalOperand, boolean throwOnFailure)
Checks the type of a single operand against a particular ordinal position within a formal operator signature.-
Methods inherited from interface org.apache.calcite.sql.type.SqlOperandTypeChecker
checkOperandTypes, getAllowedSignatures, getConsistency, getOperandCountRange, isOptional
-
-
-
-
Method Detail
-
checkSingleOperandType
boolean checkSingleOperandType(SqlCallBinding callBinding, SqlNode operand, int iFormalOperand, boolean throwOnFailure)
Checks the type of a single operand against a particular ordinal position within a formal operator signature. Note that the actual ordinal position of the operand being checked may be different from the position of the formal operand.For example, when validating the actual call
C(X, Y, Z)
the strategy for validating the operand Z might involve checking its type against the formal signature OP(W). In this case,
iFormalOperand
would be zero, even though the position of Z within call C is two.- Parameters:
callBinding
- description of the call being checked; this is only provided for context when throwing an exception; the implementation should NOT examine the operands of the call as part of the checkoperand
- the actual operand to be checkediFormalOperand
- the 0-based formal operand ordinalthrowOnFailure
- whether to throw an exception if check fails (otherwise returns false in that case)- Returns:
- whether check succeeded
-
-