Package org.hibernate.dialect.function

Class CurrentFunction

java.lang.Object

org.hibernate.query.sqm.function.AbstractSqmFunctionDescriptor

org.hibernate.query.sqm.function.AbstractSqmSelfRenderingFunctionDescriptor

org.hibernate.dialect.function.CurrentFunction

All Implemented Interfaces:

FunctionRenderingSupport, SqmFunctionDescriptor

public class CurrentFunction
extends AbstractSqmSelfRenderingFunctionDescriptor

A "function" with no parameters that returns the current date, time, or timestamp. For example, current_date.

Constructor Summary

Constructors

Constructor	Description
CurrentFunction(String name, String sql, BasicType<?> type)

Method Summary

Modifier and Type	Method	Description
boolean	alwaysIncludesParentheses()	Will a call to the described function always include parentheses?
String	getArgumentListSignature()
void	render(SqlAppender sqlAppender, List<? extends SqlAstNode> arguments, SqlAstTranslator<?> walker)

Methods inherited from class org.hibernate.query.sqm.function.AbstractSqmSelfRenderingFunctionDescriptor

generateSqmAggregateFunctionExpression, generateSqmFunctionExpression, generateSqmOrderedSetAggregateFunctionExpression, generateSqmWindowFunctionExpression, getFunctionKind

Methods inherited from class org.hibernate.query.sqm.function.AbstractSqmFunctionDescriptor

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.query.sqm.function.FunctionRenderingSupport

render, render, render

Methods inherited from interface org.hibernate.query.sqm.function.SqmFunctionDescriptor

generateSqmExpression, generateSqmExpression

Constructor Detail

CurrentFunction

public CurrentFunction(String name,
                       String sql,
                       BasicType<?> type)

Method Detail

render

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

getArgumentListSignature

public String getArgumentListSignature()

Overrides:

getArgumentListSignature in class AbstractSqmFunctionDescriptor

alwaysIncludesParentheses

public boolean alwaysIncludesParentheses()

Description copied from interface: SqmFunctionDescriptor

Will a call to the described function always include parentheses?

SqmFunctionTemplate is generally used for rendering of a function. However there are cases where Hibernate needs to consume a fragment and decide if a token represents a function name. In cases where the token is followed by an open-paren we can safely assume the token is a function name. However, if the next token is not an open-paren, the token can still represent a function provided that the function has a "no paren" form in the case of no arguments. E.g. Many databases do not require parentheses on functions like `current_timestamp`, etc. This method helps account for those cases.

Note that the most common case, by far, is that a function will always include the parentheses - therefore this return is defined as true by default. see Template#isFunction