Class AbstractSqmFunctionDescriptor

java.lang.Object

org.hibernate.query.sqm.function.AbstractSqmFunctionDescriptor

All Implemented Interfaces:

SqmFunctionDescriptor

Direct Known Subclasses:

AbstractSqmSelfRenderingFunctionDescriptor, CastStrEmulation, CoalesceIfnullEmulation, DateTruncEmulation, ExtractFunction, FormatFunction, InsertSubstringOverlayEmulation, JdbcEscapeFunctionDescriptor, LocatePositionEmulation, LpadRpadPadEmulation, MultipatternSqmFunctionDescriptor, NvlCoalesceEmulation, OrderByFragmentFunction, PostgreSQLTruncRoundFunction, TruncFunction

@SPI({USE,IMPLEMENT})
public abstract class AbstractSqmFunctionDescriptor
extends Object
implements SqmFunctionDescriptor

Base descriptor for custom SQM function generation.

Subclasses implement generateSqmFunctionExpression(List, ReturnableType, QueryEngine) and may override the aggregate, ordered-set aggregate, or window generation hooks. Prefer AbstractSqmSelfRenderingFunctionDescriptor when the function directly renders its SQL representation.

Constructor Summary

Constructors

Constructor	Description
AbstractSqmFunctionDescriptor(String name)
AbstractSqmFunctionDescriptor(String name, ArgumentsValidator argumentsValidator)
AbstractSqmFunctionDescriptor(String name, ArgumentsValidator argumentsValidator, FunctionArgumentTypeResolver argumentTypeResolver)
AbstractSqmFunctionDescriptor(String name, ArgumentsValidator argumentsValidator, FunctionReturnTypeResolver returnTypeResolver, FunctionArgumentTypeResolver argumentTypeResolver)

Method Summary

Modifier and Type	Method	Description
final <T> SelfRenderingSqmFunction<T>	generateAggregateSqmExpression(List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, ReturnableType<T> impliedResultType, QueryEngine queryEngine)	Like SqmFunctionDescriptor.generateSqmExpression(List, ReturnableType, QueryEngine), but also accepts a filter predicate.
final <T> SelfRenderingSqmFunction<T>	generateOrderedSetAggregateSqmExpression(List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, SqmOrderByClause withinGroupClause, ReturnableType<T> impliedResultType, QueryEngine queryEngine)	Like SqmFunctionDescriptor.generateSqmExpression(List, ReturnableType, QueryEngine), but also accepts a filter predicate and an order by clause.
protected <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.
final <T> SelfRenderingSqmFunction<T>	generateSqmExpression(List<? extends SqmTypedNode<?>> arguments, ReturnableType<T> impliedResultType, QueryEngine queryEngine)	Instantiate this template with the given arguments and expected return type.
protected abstract <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.
protected <T> SelfRenderingSqmAggregateFunction<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.
final <T> SelfRenderingSqmFunction<T>	generateWindowSqmExpression(List<? extends SqmTypedNode<?>> arguments, SqmPredicate filter, Boolean respectNulls, Boolean fromFirst, ReturnableType<T> impliedResultType, QueryEngine queryEngine)	Like SqmFunctionDescriptor.generateSqmExpression(List, ReturnableType, QueryEngine) but also accepts a filter predicate.
String	getArgumentListSignature()
ArgumentsValidator	getArgumentsValidator()	The object responsible for validating arguments of the function.
FunctionArgumentTypeResolver	getArgumentTypeResolver()
String	getName()
String	getReturnSignature()
FunctionReturnTypeResolver	getReturnTypeResolver()
String	getSignature(String name)	Used only for pretty-printing the function signature in the LOG.

Methods inherited from class Object

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

Methods inherited from interface SqmFunctionDescriptor

alwaysIncludesParentheses, generateSqmExpression, generateSqmExpression, getFunctionKind, isPredicate

Constructor Details

AbstractSqmFunctionDescriptor

@SPI(IMPLEMENT)
public AbstractSqmFunctionDescriptor(String name)

AbstractSqmFunctionDescriptor

@SPI(IMPLEMENT)
public AbstractSqmFunctionDescriptor(String name,
 @Nullable
 ArgumentsValidator argumentsValidator)

AbstractSqmFunctionDescriptor

@SPI(IMPLEMENT)
public AbstractSqmFunctionDescriptor(String name,
 @Nullable
 ArgumentsValidator argumentsValidator,
 @Nullable
 FunctionArgumentTypeResolver argumentTypeResolver)

AbstractSqmFunctionDescriptor

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

Method Details

getName

public String getName()

getSignature

public String getSignature(String name)

Description copied from interface: SqmFunctionDescriptor

Used only for pretty-printing the function signature in the LOG.

Specified by:

getSignature in interface SqmFunctionDescriptor

Parameters:

name - the function name

Returns:

the signature of the function

getArgumentsValidator

public ArgumentsValidator getArgumentsValidator()

Description copied from interface: SqmFunctionDescriptor

The object responsible for validating arguments of the function.

Specified by:

getArgumentsValidator in interface SqmFunctionDescriptor

Returns:

an instance of ArgumentsValidator

getReturnTypeResolver

public FunctionReturnTypeResolver getReturnTypeResolver()

getArgumentTypeResolver

public FunctionArgumentTypeResolver getArgumentTypeResolver()

getReturnSignature

public String getReturnSignature()

getArgumentListSignature

public String getArgumentListSignature()

generateSqmExpression

public final <T> SelfRenderingSqmFunction<T> generateSqmExpression(List<? extends SqmTypedNode<?>> arguments,
 @Nullable
 ReturnableType<T> impliedResultType,
 QueryEngine queryEngine)

Description copied from interface: SqmFunctionDescriptor

Instantiate this template with the given arguments and expected return type. This produces a tree of SQM nodes representing a tree of function invocations. This allows a single HQL function to be defined in terms of other predefined (database independent) HQL functions, simplifying the task of writing HQL functions which are portable between databases.

Specified by:

generateSqmExpression in interface SqmFunctionDescriptor

generateAggregateSqmExpression

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

Description copied from interface: SqmFunctionDescriptor

Like SqmFunctionDescriptor.generateSqmExpression(List, ReturnableType, QueryEngine), but also accepts a filter predicate.

This method is intended for aggregate functions.

Specified by:

generateAggregateSqmExpression in interface SqmFunctionDescriptor

generateOrderedSetAggregateSqmExpression

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

Description copied from interface: SqmFunctionDescriptor

Like SqmFunctionDescriptor.generateSqmExpression(List, ReturnableType, QueryEngine), but also accepts a filter predicate and an order by clause.

This method is intended for ordered set aggregate functions.

Specified by:

generateOrderedSetAggregateSqmExpression in interface SqmFunctionDescriptor

generateWindowSqmExpression

public final <T> SelfRenderingSqmFunction<T> generateWindowSqmExpression(List<? extends SqmTypedNode<?>> arguments,
 SqmPredicate filter,
 @Nullable
 Boolean respectNulls,
 @Nullable
 Boolean fromFirst,
 @Nullable
 ReturnableType<T> impliedResultType,
 QueryEngine queryEngine)

Description copied from interface: SqmFunctionDescriptor

Like SqmFunctionDescriptor.generateSqmExpression(List, ReturnableType, QueryEngine) but also accepts a filter predicate.

This method is intended for window functions.

Specified by:

generateWindowSqmExpression in interface SqmFunctionDescriptor

generateSqmFunctionExpression

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

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.

Parameters:

arguments - the arguments of the function invocation

impliedResultType - the function return type as inferred from its usage

generateSqmAggregateFunctionExpression

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

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.

Parameters:

arguments - the arguments of the function invocation

impliedResultType - the function return type as inferred from its usage

generateSqmOrderedSetAggregateFunctionExpression

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

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.

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)

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.

Parameters:

arguments - the arguments of the function invocation

impliedResultType - the function return type as inferred from its usage