Class AbstractSqmSelfRenderingFunctionDescriptor

java.lang.Object

org.hibernate.query.sqm.function.AbstractSqmFunctionDescriptor

org.hibernate.query.sqm.function.AbstractSqmSelfRenderingFunctionDescriptor

All Implemented Interfaces:

FunctionRenderer, SqmFunctionDescriptor

Direct Known Subclasses:

AbstractArrayContainsFunction, AbstractArrayFillFunction, AbstractArrayGetFunction, AbstractArrayIncludesFunction, AbstractArrayIntersectsFunction, AbstractArrayPositionFunction, AbstractArrayPositionsFunction, AbstractArrayRemoveFunction, AbstractArrayReverseFunction, AbstractArraySortFunction, AbstractArrayTrimFunction, AbstractJsonArrayAppendFunction, AbstractJsonArrayInsertFunction, AbstractJsonInsertFunction, AbstractJsonMergepatchFunction, AbstractJsonRemoveFunction, AbstractJsonReplaceFunction, AbstractJsonSetFunction, AbstractRegexpLikeFunction, ArrayAggFunction, ArrayConcatElementFunction, ArrayConcatFunction, ArrayConstructorFunction, ArrayRemoveIndexUnnestFunction, ArrayReplaceUnnestFunction, ArraySetUnnestFunction, ArraySliceUnnestFunction, ArrayToStringFunction, AvgFunction, CaseLeastGreatestEmulation, CastFunction, CastingConcatFunction, ChrLiteralEmulation, ConcatPipeFunction, CountFunction, CurrentFunction, DB2PositionFunction, DB2SubstringFunction, EveryAnyEmulation, HypotheticalSetFunction, InverseDistributionFunction, JsonArrayAggFunction, JsonArrayFunction, JsonExistsFunction, JsonObjectAggFunction, JsonObjectFunction, JsonQueryFunction, JsonValueFunction, LengthFunction, ListaggFunction, ListaggGroupConcatEmulation, ListaggStringAggEmulation, MinMaxCaseEveryAnyEmulation, NamedSqmFunctionDescriptor, OracleArrayAggEmulation, OracleArrayLengthFunction, OracleTruncFunction, OrdinalFunction, PatternBasedSqmFunctionDescriptor, PostgreSQLMinMaxFunction, SpannerConcatFunction, SpannerPostgreSQLArrayRemoveIndexFunction, SpannerPostgreSQLArrayReplaceFunction, SpannerTruncFunction, SqlColumn, SqlFunction, SQLServerEveryAnyEmulation, StringFunction, TimestampaddFunction, TimestampdiffFunction, TrimFunction, XmlAggFunction, XmlConcatFunction, XmlElementFunction, XmlExistsFunction, XmlForestFunction, XmlPiFunction, XmlQueryFunction

@SPI({USE,IMPLEMENT})
public abstract class AbstractSqmSelfRenderingFunctionDescriptor
extends AbstractSqmFunctionDescriptor
implements FunctionRenderer

Base descriptor for functions which directly render their SQL AST form.

Subclasses implement FunctionRenderer.render(SqlAppender, List, SqlAstTranslator) and may override the focused SQM generation hooks when normal, aggregate, ordered-set aggregate, or window invocation requires a specialized node.

Constructor Summary

Constructors

Constructor	Description
AbstractSqmSelfRenderingFunctionDescriptor(String name, FunctionKind functionKind, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, FunctionArgumentTypeResolver argumentTypeResolver)
AbstractSqmSelfRenderingFunctionDescriptor(String name, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, FunctionArgumentTypeResolver argumentTypeResolver)

Method Summary

Modifier and Type	Method	Description
static boolean	filterClauseSupported(SqlAstTranslator<?> translator)
<T> SelfRenderingSqmAggregateFunction<T>	generateSqmAggregateFunctionExpression(List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, ReturnableType<T> impliedResultType, QueryEngine queryEngine)	Return an SQM node or subtree representing an invocation of this aggregate function with the given arguments.
protected <T> SelfRenderingSqmFunction<T>	generateSqmFunctionExpression(List<? extends SqmTypedNode<?>> arguments, ReturnableType<T> impliedResultType, QueryEngine queryEngine)	Return an SQM node or subtree representing an invocation of this function with the given arguments.
<T> SelfRenderingSqmOrderedSetAggregateFunction<T>	generateSqmOrderedSetAggregateFunctionExpression(List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, SqmOrderByClause withinGroupClause, ReturnableType<T> impliedResultType, QueryEngine queryEngine)	Return an SQM node or subtree representing an invocation of this ordered set-aggregate function with the given arguments.
protected <T> SelfRenderingSqmWindowFunction<T>	generateSqmWindowFunctionExpression(List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, Boolean respectNulls, Boolean fromFirst, ReturnableType<T> impliedResultType, QueryEngine queryEngine)	Return an SQM node or subtree representing an invocation of this window function with the given arguments.
FunctionKind	getFunctionKind()	What sort of function is this?
void	render(SqlAppender sqlAppender, List<? extends SqlAstNode> sqlAstArguments, ReturnableType<?> returnType, SqlAstTranslator<?> walker)

Methods inherited from class AbstractSqmFunctionDescriptor

generateAggregateSqmExpression, generateOrderedSetAggregateSqmExpression, generateSqmExpression, generateWindowSqmExpression, getArgumentListSignature, getArgumentsValidator, getArgumentTypeResolver, getName, getReturnSignature, getReturnTypeResolver, getSignature

Methods inherited from class Object

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

Methods inherited from interface FunctionRenderer

render, render, render, render

Methods inherited from interface SqmFunctionDescriptor

alwaysIncludesParentheses, generateSqmExpression, generateSqmExpression, isPredicate

Constructor Details

AbstractSqmSelfRenderingFunctionDescriptor

@SPI(IMPLEMENT)
public AbstractSqmSelfRenderingFunctionDescriptor(String name,
 @Nullable
 ArgumentsValidator argumentsValidator,
 @Nullable
 FunctionReturnTypeResolver returnTypeResolver,
 @Nullable
 FunctionArgumentTypeResolver argumentTypeResolver)

AbstractSqmSelfRenderingFunctionDescriptor

@SPI(IMPLEMENT)
public AbstractSqmSelfRenderingFunctionDescriptor(String name,
 FunctionKind functionKind,
 @Nullable
 ArgumentsValidator argumentsValidator,
 @Nullable
 FunctionReturnTypeResolver returnTypeResolver,
 @Nullable
 FunctionArgumentTypeResolver argumentTypeResolver)

Method Details

render

public void render(SqlAppender sqlAppender,
 List<? extends SqlAstNode> sqlAstArguments,
 ReturnableType<?> returnType,
 SqlAstTranslator<?> walker)

Specified by:

render in interface FunctionRenderer

getFunctionKind

public FunctionKind getFunctionKind()

Description copied from interface: SqmFunctionDescriptor

What sort of function is this?

Specified by:

getFunctionKind in interface SqmFunctionDescriptor

Returns:

FunctionKind.NORMAL by default

generateSqmFunctionExpression

protected <T> SelfRenderingSqmFunction<T> generateSqmFunctionExpression(List<? extends SqmTypedNode<?>> arguments,
 @Nullable
 ReturnableType<T> impliedResultType,
 QueryEngine queryEngine)

Description copied from class: AbstractSqmFunctionDescriptor

Return an SQM node or subtree representing an invocation of this function with the given arguments. This method may be overridden in the case of function descriptors that wish to customize creation of the node.

Specified by:

generateSqmFunctionExpression in class AbstractSqmFunctionDescriptor

Parameters:

arguments - the arguments of the function invocation

impliedResultType - the function return type as inferred from its usage

generateSqmAggregateFunctionExpression

public <T> SelfRenderingSqmAggregateFunction<T> generateSqmAggregateFunctionExpression(List<? extends SqmTypedNode<?>> arguments,
 SqmPredicate filter,
 @Nullable
 ReturnableType<T> impliedResultType,
 QueryEngine queryEngine)

Description copied from class: AbstractSqmFunctionDescriptor

Return an SQM node or subtree representing an invocation of this aggregate function with the given arguments. This method may be overridden in the case of function descriptors that wish to customize creation of the node.

Overrides:

generateSqmAggregateFunctionExpression in class AbstractSqmFunctionDescriptor

Parameters:

arguments - the arguments of the function invocation

impliedResultType - the function return type as inferred from its usage

generateSqmOrderedSetAggregateFunctionExpression

public <T>
SelfRenderingSqmOrderedSetAggregateFunction<T> generateSqmOrderedSetAggregateFunctionExpression(List<? extends SqmTypedNode<?>> arguments,
 SqmPredicate filter,
 SqmOrderByClause withinGroupClause,
 @Nullable
 ReturnableType<T> impliedResultType,
 QueryEngine queryEngine)

Description copied from class: AbstractSqmFunctionDescriptor

Return an SQM node or subtree representing an invocation of this ordered set-aggregate function with the given arguments. This method may be overridden in the case of function descriptors that wish to customize creation of the node.

Overrides:

generateSqmOrderedSetAggregateFunctionExpression in class AbstractSqmFunctionDescriptor

Parameters:

arguments - the arguments of the function invocation

impliedResultType - the function return type as inferred from its usage

generateSqmWindowFunctionExpression

protected <T> SelfRenderingSqmWindowFunction<T> generateSqmWindowFunctionExpression(List<? extends SqmTypedNode<?>> arguments,
 SqmPredicate filter,
 @Nullable
 Boolean respectNulls,
 @Nullable
 Boolean fromFirst,
 @Nullable
 ReturnableType<T> impliedResultType,
 QueryEngine queryEngine)

Description copied from class: AbstractSqmFunctionDescriptor

Return an SQM node or subtree representing an invocation of this window function with the given arguments. This method may be overridden in the case of function descriptors that wish to customize creation of the node.

Overrides:

generateSqmWindowFunctionExpression in class AbstractSqmFunctionDescriptor

Parameters:

arguments - the arguments of the function invocation

impliedResultType - the function return type as inferred from its usage

filterClauseSupported

public static boolean filterClauseSupported(SqlAstTranslator<?> translator)