org.apache.calcite.sql.validate

Class SqlUserDefinedTableMacro

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.validate.SqlUserDefinedTableMacro

public class SqlUserDefinedTableMacro
extends SqlFunction

User-defined table macro.

Created by the validator, after resolving a function call to a function defined in a Calcite schema.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SqlUserDefinedTableMacro.NonLiteralException Thrown when a non-literal occurs in an argument to a user-defined table macro.

Field Summary

Fields

Modifier and Type	Field and Description
private TableMacro	tableMacro

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor and Description
SqlUserDefinedTableMacro(SqlIdentifier opName, SqlReturnTypeInference returnTypeInference, SqlOperandTypeInference operandTypeInference, SqlOperandTypeChecker operandTypeChecker, List<RelDataType> paramTypes, TableMacro tableMacro)

Method Summary

Modifier and Type	Method and Description
private static Object	coerce(Object o, RelDataType type)
static List<Object>	convertArguments(RelDataTypeFactory typeFactory, List<SqlNode> operandList, Function function, SqlIdentifier opName, boolean failOnNonLiteral) Converts arguments from SqlNode to java object format.
List<String>	getParamNames() Returns a list of parameter names.
TranslatableTable	getTable(RelDataTypeFactory typeFactory, List<SqlNode> operandList) Returns the table in this UDF, or null if there is no table.
private static Object	getValue(SqlNode right)

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

deriveType, getFunctionType, getNameAsId, getParamTypes, getSqlIdentifier, getSyntax, isQuantifierAllowed, unparse, validateCall, validateQuantifier

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

acceptCall, acceptCall, adjustType, allowsFraming, argumentMustBeScalar, checkOperandCount, checkOperandTypes, constructArgNameList, constructArgTypeList, constructOperandList, createCall, createCall, createCall, createCall, equals, getAllowedSignatures, getAllowedSignatures, getKind, getLeftPrec, getMonotonicity, getMonotonicity, getName, getOperandCountRange, getOperandTypeChecker, getOperandTypeInference, getReturnTypeInference, getRightPrec, getSignatureTemplate, hashCode, inferReturnType, inferReturnType, isAggregator, isDeterministic, isDynamicFunction, isGroup, isGroupAuxiliary, isName, leftPrec, preValidateCall, requiresDecimalExpansion, requiresOrder, requiresOver, rewriteCall, rightPrec, toString, unparseListClause, unparseListClause, validateOperands, validRexOperands

Methods inherited from class java.lang.Object

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

Field Detail

tableMacro

private final TableMacro tableMacro

Constructor Detail

SqlUserDefinedTableMacro

public SqlUserDefinedTableMacro(SqlIdentifier opName,
                                SqlReturnTypeInference returnTypeInference,
                                SqlOperandTypeInference operandTypeInference,
                                SqlOperandTypeChecker operandTypeChecker,
                                List<RelDataType> paramTypes,
                                TableMacro tableMacro)

Method Detail

getParamNames

public List<String> getParamNames()

Description copied from class: SqlFunction

Returns a list of parameter names.

The default implementation returns [arg0, arg1, ..., argN].

Overrides:

getParamNames in class SqlFunction

getTable

public TranslatableTable getTable(RelDataTypeFactory typeFactory,
                                  List<SqlNode> operandList)

Returns the table in this UDF, or null if there is no table.

convertArguments

public static List<Object> convertArguments(RelDataTypeFactory typeFactory,
                                            List<SqlNode> operandList,
                                            Function function,
                                            SqlIdentifier opName,
                                            boolean failOnNonLiteral)

Converts arguments from SqlNode to java object format.

Parameters:

typeFactory - type factory used to convert the arguments

operandList - input arguments

function - target function to get parameter types from

opName - name of the operator to use in error message

failOnNonLiteral - true when conversion should fail on non-literal

Returns:

converted list of arguments

getValue

private static Object getValue(SqlNode right)
                        throws SqlUserDefinedTableMacro.NonLiteralException

Throws:

SqlUserDefinedTableMacro.NonLiteralException

coerce

private static Object coerce(Object o,
                             RelDataType type)