Package org.apache.calcite.sql.type

Class FamilyOperandTypeChecker

java.lang.Object

org.apache.calcite.sql.type.FamilyOperandTypeChecker

All Implemented Interfaces:

ImplicitCastOperandTypeChecker, SqlOperandTypeChecker, SqlSingleOperandTypeChecker

Direct Known Subclasses:

OperandMetadataImpl

public class FamilyOperandTypeChecker
extends Object
implements SqlSingleOperandTypeChecker, ImplicitCastOperandTypeChecker

Operand type-checking strategy which checks operands for inclusion in type families.

Subclasses that check a single operand should override checkSingleOperandType(SqlCallBinding, SqlNode, int, SqlTypeFamily, boolean).

Subclasses that check multiple operands should override either checkSingleOperandType(SqlCallBinding, SqlNode, int, SqlTypeFamily, boolean), or *both* checkOperandTypes(SqlCallBinding, boolean) and checkOperandTypesWithoutTypeCoercion(SqlCallBinding, boolean).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.sql.type.SqlOperandTypeChecker

SqlOperandTypeChecker.Consistency

Field Summary

Fields

Modifier and Type	Field	Description
protected final com.google.common.collect.ImmutableList<SqlTypeFamily>	families
protected final Predicate<Integer>	optional

Method Summary

Modifier and Type	Method	Description
boolean	checkOperandTypes(SqlCallBinding callBinding, boolean throwOnFailure)	Checks the types of all operands to an operator call.
boolean	checkOperandTypesWithoutTypeCoercion(SqlCallBinding callBinding, boolean throwOnFailure)	Checks the types of an operator's all operands, but without type coercion.
boolean	checkSingleOperandType(SqlCallBinding callBinding, SqlNode node, int iFormalOperand, boolean throwOnFailure)	Checks the type of a single operand against a particular ordinal position within a formal operator signature.
protected boolean	checkSingleOperandType(SqlCallBinding callBinding, SqlNode operand, int iFormalOperand, SqlTypeFamily family, boolean throwOnFailure)	Helper function used by checkSingleOperandType(SqlCallBinding, SqlNode, int, boolean), checkOperandTypesWithoutTypeCoercion(SqlCallBinding, boolean), and checkOperandTypes(SqlCallBinding, boolean).
String	getAllowedSignatures(SqlOperator op, String opName)	Returns a string describing the allowed formal signatures of a call, e.g.
SqlOperandCountRange	getOperandCountRange()	Returns the range of operand counts allowed in a call.
SqlTypeFamily	getOperandSqlTypeFamily(int iFormalOperand)	Get the operand SqlTypeFamily of formal index iFormalOperand.
boolean	isOptional(int i)	Returns whether the ith operand is optional.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.calcite.sql.type.SqlOperandTypeChecker

and, getConsistency, isFixedParameters, or, typeInference, withGenerator

Methods inherited from interface org.apache.calcite.sql.type.SqlSingleOperandTypeChecker

and, or

Field Details

families

protected final com.google.common.collect.ImmutableList<SqlTypeFamily> families

optional

protected final Predicate<Integer> optional

Method Details

isOptional

public boolean isOptional(int i)

Description copied from interface: SqlOperandTypeChecker

Returns whether the ith operand is optional.

Specified by:

isOptional in interface SqlOperandTypeChecker

checkSingleOperandType

public boolean checkSingleOperandType(SqlCallBinding callBinding,
 SqlNode node,
 int iFormalOperand,
 boolean throwOnFailure)

Description copied from interface: SqlSingleOperandTypeChecker

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.

Caution that we could not(shouldn't) implement implicit type coercion for this checker, implicit type coercion has side effect(modify the AST), if this single operand checker is subsumed in a composite rule(OR or AND), we can not make any side effect if we can not make sure that all the single operands type check are passed(with type coercion). But there is an exception: only if the call has just one operand, for this case, use SqlOperandTypeChecker.checkOperandTypes(org.apache.calcite.sql.SqlCallBinding, boolean) instead.

Specified by:

checkSingleOperandType in interface SqlSingleOperandTypeChecker

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 check

node - the actual operand to be checked

iFormalOperand - the 0-based formal operand ordinal

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

Returns:

whether check succeeded

checkSingleOperandType

protected boolean checkSingleOperandType(SqlCallBinding callBinding,
 SqlNode operand,
 int iFormalOperand,
 SqlTypeFamily family,
 boolean throwOnFailure)

Helper function used by checkSingleOperandType(SqlCallBinding, SqlNode, int, boolean), checkOperandTypesWithoutTypeCoercion(SqlCallBinding, boolean), and checkOperandTypes(SqlCallBinding, boolean).

checkOperandTypes

public boolean checkOperandTypes(SqlCallBinding callBinding,
 boolean throwOnFailure)

Description copied from interface: SqlOperandTypeChecker

Checks the types of all operands to an operator call.

Specified by:

checkOperandTypes in interface SqlOperandTypeChecker

Specified by:

checkOperandTypes in interface SqlSingleOperandTypeChecker

Parameters:

callBinding - description of the call to be checked

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

Returns:

whether check succeeded

checkOperandTypesWithoutTypeCoercion

public boolean checkOperandTypesWithoutTypeCoercion(SqlCallBinding callBinding,
 boolean throwOnFailure)

Description copied from interface: ImplicitCastOperandTypeChecker

Checks the types of an operator's all operands, but without type coercion. This is mainly used as a pre-check when this checker is included as one of the rules in CompositeOperandTypeChecker and the composite predicate is `OR`.

Specified by:

checkOperandTypesWithoutTypeCoercion in interface ImplicitCastOperandTypeChecker

Parameters:

callBinding - description of the call to be checked

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

Returns:

whether check succeeded

getOperandSqlTypeFamily

public SqlTypeFamily getOperandSqlTypeFamily(int iFormalOperand)

Description copied from interface: ImplicitCastOperandTypeChecker

Get the operand SqlTypeFamily of formal index iFormalOperand. This is mainly used to get the operand SqlTypeFamily when this checker is included as one of the rules in CompositeOperandTypeChecker and the composite predicate is `SEQUENCE`.

Specified by:

getOperandSqlTypeFamily in interface ImplicitCastOperandTypeChecker

Parameters:

iFormalOperand - the formal operand index.

Returns:

SqlTypeFamily of the operand.

getOperandCountRange

public SqlOperandCountRange getOperandCountRange()

Description copied from interface: SqlOperandTypeChecker

Returns the range of operand counts allowed in a call.

Specified by:

getOperandCountRange in interface SqlOperandTypeChecker

Specified by:

getOperandCountRange in interface SqlSingleOperandTypeChecker

getAllowedSignatures

public String getAllowedSignatures(SqlOperator op,
 String opName)

Description copied from interface: SqlOperandTypeChecker

Returns a string describing the allowed formal signatures of a call, e.g. "SUBSTR(VARCHAR, INTEGER, INTEGER)".

Specified by:

getAllowedSignatures in interface SqlOperandTypeChecker

Parameters:

op - the operator being checked

opName - name to use for the operator in case of aliasing

Returns:

generated string