Class TruncFunction

java.lang.Object

org.hibernate.query.sqm.function.AbstractSqmFunctionDescriptor

org.hibernate.dialect.function.TruncFunction

All Implemented Interfaces:

SqmFunctionDescriptor

Direct Known Subclasses:

PostgreSQLTruncFunction, SqlServerConvertTruncFunction, SybaseTruncFunction

@SPI({USE,IMPLEMENT})
public class TruncFunction
extends AbstractSqmFunctionDescriptor

Subclassable descriptor for numeric and datetime truncation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TruncFunction.DatetimeTrunc
protected static final class	TruncFunction.TruncArgumentsValidator	Argument validators exposed to TruncFunction subclasses.
protected static final class	TruncFunction.TruncRenderingSupport	Rendering state exposed to TruncFunction subclasses.

Field Summary

Fields

Modifier and Type	Field	Description
protected final TruncFunction.TruncRenderingSupport	datetimeRenderingSupport
protected final TruncFunction.TruncRenderingSupport	numericRenderingSupport

Constructor Summary

Constructors

Constructor	Description
TruncFunction(String truncPattern, String twoArgTruncPattern, TruncFunction.DatetimeTrunc datetimeTrunc, String toDateFunction, SqlAstNodeRenderingMode argumentRenderingMode, TypeConfiguration typeConfiguration)
TruncFunction(String truncPattern, String twoArgTruncPattern, TruncFunction.DatetimeTrunc datetimeTrunc, String toDateFunction, TypeConfiguration typeConfiguration)

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class AbstractSqmFunctionDescriptor

generateAggregateSqmExpression, generateOrderedSetAggregateSqmExpression, generateSqmAggregateFunctionExpression, generateSqmExpression, generateSqmOrderedSetAggregateFunctionExpression, generateSqmWindowFunctionExpression, 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 SqmFunctionDescriptor

alwaysIncludesParentheses, generateSqmExpression, generateSqmExpression, getFunctionKind, isPredicate

Field Details

numericRenderingSupport

protected final TruncFunction.TruncRenderingSupport numericRenderingSupport

datetimeRenderingSupport

protected final TruncFunction.TruncRenderingSupport datetimeRenderingSupport

Constructor Details

TruncFunction

@SPI(IMPLEMENT)
public TruncFunction(String truncPattern,
 String twoArgTruncPattern,
 TruncFunction.DatetimeTrunc datetimeTrunc,
 String toDateFunction,
 TypeConfiguration typeConfiguration)

TruncFunction

@SPI(IMPLEMENT)
public TruncFunction(String truncPattern,
 String twoArgTruncPattern,
 TruncFunction.DatetimeTrunc datetimeTrunc,
 String toDateFunction,
 SqlAstNodeRenderingMode argumentRenderingMode,
 TypeConfiguration typeConfiguration)

Method Details

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