public class

SQLFunctionTemplate

extends Object
implements SQLFunction
java.lang.Object
   ↳ org.hibernate.dialect.function.SQLFunctionTemplate

Class Overview

Represents HQL functions that can have different representations in different SQL dialects. E.g. in HQL we can define function concat(?1, ?2) to concatenate two strings p1 and p2. Target SQL function will be dialect-specific, e.g. (?1 || ?2) for Oracle, concat(?1, ?2) for MySql, (?1 + ?2) for MS SQL. Each dialect will define a template as a string (exactly like above) marking function parameters with '?' followed by parameter's index (first index is 1).

Summary

Public Constructors
SQLFunctionTemplate(Type type, String template)
SQLFunctionTemplate(Type type, String template, boolean hasParenthesesIfNoArgs)
Public Methods
Type getReturnType(Type argumentType, Mapping mapping)
The return type of the function.
boolean hasArguments()
Does this function have any arguments?
boolean hasParenthesesIfNoArguments()
If there are no arguments, are parentheses required?
String render(Type argumentType, List args, SessionFactoryImplementor factory)
Render the function call as SQL fragment.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.hibernate.dialect.function.SQLFunction

Public Constructors

public SQLFunctionTemplate (Type type, String template)

public SQLFunctionTemplate (Type type, String template, boolean hasParenthesesIfNoArgs)

Public Methods

public Type getReturnType (Type argumentType, Mapping mapping)

The return type of the function. May be either a concrete type which is preset, or variable depending upon the type of the first function argument.

Note, the 'firstArgumentType' parameter should match the one passed into render(Type, List, SessionFactoryImplementor)

Parameters
argumentType The type of the first argument
mapping The mapping source.
Returns
  • The type to be expected as a return.
Throws
QueryException

public boolean hasArguments ()

Does this function have any arguments?

Returns
  • True if the function expects to have parameters; false otherwise.

public boolean hasParenthesesIfNoArguments ()

If there are no arguments, are parentheses required?

Returns
  • True if a no-arg call of this function requires parentheses.

public String render (Type argumentType, List args, SessionFactoryImplementor factory)

Render the function call as SQL fragment.

Note, the 'firstArgumentType' parameter should match the one passed into getReturnType(Type, Mapping)

Parameters
argumentType The type of the first argument
args The function arguments
factory The SessionFactory
Returns
  • The rendered function call

public String toString ()