public class

StandardSQLFunction

extends Object
implements SQLFunction
java.lang.Object
   ↳ org.hibernate.dialect.function.StandardSQLFunction
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Provides a standard implementation that supports the majority of the HQL functions that are translated to SQL. The Dialect and its sub-classes use this class to provide details required for processing of the associated function.

Summary

Public Constructors
StandardSQLFunction(String name)
Construct a standard SQL function definition with a variable return type; the actual return type will depend on the types to which the function is applied.
StandardSQLFunction(String name, Type registeredType)
Construct a standard SQL function definition with a static return type.
Public Methods
String getName()
Function name accessor
Type getReturnType(Type firstArgumentType, Mapping mapping)
The return type of the function.
Type getType()
Function static return type accessor.
boolean hasArguments()
Does this function have any arguments?
boolean hasParenthesesIfNoArguments()
If there are no arguments, are parentheses required?
String render(Type firstArgumentType, List arguments, SessionFactoryImplementor sessionFactory)
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 StandardSQLFunction (String name)

Construct a standard SQL function definition with a variable return type; the actual return type will depend on the types to which the function is applied.

Using this form, the return type is considered non-static and assumed to be the type of the first argument.

Parameters
name The name of the function.

public StandardSQLFunction (String name, Type registeredType)

Construct a standard SQL function definition with a static return type.

Parameters
name The name of the function.
registeredType The static return type.

Public Methods

public String getName ()

Function name accessor

Returns
  • The function name.

public Type getReturnType (Type firstArgumentType, 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
firstArgumentType The type of the first argument
mapping The mapping source.
Returns
  • The type to be expected as a return.

public Type getType ()

Function static return type accessor.

Returns
  • The static function return type; or null if return type is not static.

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 firstArgumentType, List arguments, SessionFactoryImplementor sessionFactory)

Render the function call as SQL fragment.

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

Parameters
firstArgumentType The type of the first argument
arguments The function arguments
sessionFactory The SessionFactory
Returns
  • The rendered function call

public String toString ()