Package org.apache.calcite.sql.fun

Class SqlTrimFunction

java.lang.Object

org.apache.calcite.sql.SqlOperator

org.apache.calcite.sql.SqlFunction

org.apache.calcite.sql.fun.SqlTrimFunction

public class SqlTrimFunction
extends SqlFunction

Definition of the "TRIM" builtin SQL function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SqlTrimFunction.Flag	Defines the enumerated values "LEADING", "TRAILING", "BOTH".

Field Summary

Fields

Modifier and Type	Field	Description
protected static final SqlTrimFunction	INSTANCE

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

kind, MDX_PRECEDENCE, NL

Constructor Summary

Constructors

Constructor	Description
SqlTrimFunction(String name, SqlKind kind, SqlReturnTypeInference returnTypeInference, SqlSingleOperandTypeChecker operandTypeChecker)

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.
SqlCall	createCall(@Nullable SqlLiteral functionQualifier, SqlParserPos pos, @Nullable SqlNode... operands)	Creates a call to this operator with an array of operands.
String	getSignatureTemplate(int operandsCount)	Returns a template describing how the operator signature is to be built.
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.SqlFunction

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

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

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

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

protected static final SqlTrimFunction INSTANCE

Constructor Details

SqlTrimFunction

public SqlTrimFunction(String name,
 SqlKind kind,
 SqlReturnTypeInference returnTypeInference,
 SqlSingleOperandTypeChecker operandTypeChecker)

Method Details

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 SqlFunction

getSignatureTemplate

public String getSignatureTemplate(int operandsCount)

Description copied from class: SqlOperator

Returns a template describing how the operator signature is to be built. E.g for the binary + operator the template looks like "{1} {0} {2}" {0} is the operator, subsequent numbers are operands.

Overrides:

getSignatureTemplate in class SqlOperator

Parameters:

operandsCount - is used with functions that can take a variable number of operands

Returns:

signature template, or null to indicate that a default template will suffice

createCall

public SqlCall createCall(@Nullable SqlLiteral functionQualifier,
 SqlParserPos pos,
 @Nullable SqlNode... operands)

Description copied from class: SqlOperator

Creates a call to this operator with an array of operands.

The position of the resulting call is the union of the pos and the positions of all of the operands.

Overrides:

createCall in class SqlOperator

Parameters:

functionQualifier - Function qualifier (e.g. "DISTINCT"), or null

pos - Parser position of the identifier of the call

operands - Array of operands

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