Package org.hibernate.query.sqm.function

Class AbstractSqmSetReturningFunctionDescriptor

java.lang.Object

org.hibernate.query.sqm.function.AbstractSqmSetReturningFunctionDescriptor

All Implemented Interfaces:

SqmSetReturningFunctionDescriptor

Direct Known Subclasses:

AbstractSqmSelfRenderingSetReturningFunctionDescriptor

@Incubating
public abstract class AbstractSqmSetReturningFunctionDescriptor
extends Object
implements SqmSetReturningFunctionDescriptor

Since:

7.0

Constructor Summary

Constructors

Constructor	Description
AbstractSqmSetReturningFunctionDescriptor(String name, @Nullable ArgumentsValidator argumentsValidator, SetReturningFunctionTypeResolver typeResolver)
AbstractSqmSetReturningFunctionDescriptor(String name, @Nullable ArgumentsValidator argumentsValidator, SetReturningFunctionTypeResolver typeResolver, @Nullable FunctionArgumentTypeResolver argumentTypeResolver)
AbstractSqmSetReturningFunctionDescriptor(String name, SetReturningFunctionTypeResolver typeResolver)

Method Summary

Modifier and Type	Method	Description
final <T> SelfRenderingSqmSetReturningFunction<T>	generateSqmExpression(List<? extends SqmTypedNode<?>> arguments, QueryEngine queryEngine)	Instantiate this template with the given arguments and.
protected abstract <T> SelfRenderingSqmSetReturningFunction<T>	generateSqmSetReturningFunctionExpression(List<? extends SqmTypedNode<?>> arguments, QueryEngine queryEngine)	Return an SQM node or subtree representing an invocation of this function with the given arguments.
String	getArgumentListSignature()
ArgumentsValidator	getArgumentsValidator()	The object responsible for validating arguments of the function.
FunctionArgumentTypeResolver	getArgumentTypeResolver()
String	getName()
SetReturningFunctionTypeResolver	getSetReturningTypeResolver()
String	getSignature(String name)	Used only for pretty-printing the function signature in the log.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractSqmSetReturningFunctionDescriptor

public AbstractSqmSetReturningFunctionDescriptor(String name,
 SetReturningFunctionTypeResolver typeResolver)

AbstractSqmSetReturningFunctionDescriptor

public AbstractSqmSetReturningFunctionDescriptor(String name,
 @Nullable ArgumentsValidator argumentsValidator,
 SetReturningFunctionTypeResolver typeResolver)

AbstractSqmSetReturningFunctionDescriptor

public AbstractSqmSetReturningFunctionDescriptor(String name,
 @Nullable ArgumentsValidator argumentsValidator,
 SetReturningFunctionTypeResolver typeResolver,
 @Nullable FunctionArgumentTypeResolver argumentTypeResolver)

Method Details

getName

public String getName()

getSignature

public String getSignature(String name)

Description copied from interface: SqmSetReturningFunctionDescriptor

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

Specified by:

getSignature in interface SqmSetReturningFunctionDescriptor

Parameters:

name - the function name

Returns:

the signature of the function

getArgumentsValidator

public ArgumentsValidator getArgumentsValidator()

Description copied from interface: SqmSetReturningFunctionDescriptor

The object responsible for validating arguments of the function.

Specified by:

getArgumentsValidator in interface SqmSetReturningFunctionDescriptor

Returns:

an instance of ArgumentsValidator

getSetReturningTypeResolver

public SetReturningFunctionTypeResolver getSetReturningTypeResolver()

getArgumentTypeResolver

public FunctionArgumentTypeResolver getArgumentTypeResolver()

getArgumentListSignature

public String getArgumentListSignature()

generateSqmExpression

public final <T>
SelfRenderingSqmSetReturningFunction<T> generateSqmExpression(List<? extends SqmTypedNode<?>> arguments,
 QueryEngine queryEngine)

Description copied from interface: SqmSetReturningFunctionDescriptor

Instantiate this template with the given arguments and. 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 SqmSetReturningFunctionDescriptor

generateSqmSetReturningFunctionExpression

protected abstract <T>
SelfRenderingSqmSetReturningFunction<T> generateSqmSetReturningFunctionExpression(List<? extends SqmTypedNode<?>> arguments,
 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