Summary: Methods | [Expand All]
public interface

SQLFunction

org.hibernate.dialect.function.SQLFunction
Known Indirect Subclasses

Class Overview

Provides support routines for the HQL functions as used in the various SQL Dialects Provides an interface for supporting various HQL functions that are translated to SQL. The Dialect and its sub-classes use this interface to provide details required for processing of the function.

Summary

Public Methods
abstract Type getReturnType(Type firstArgumentType, Mapping mapping)
The return type of the function.
abstract boolean hasArguments()
Does this function have any arguments?
abstract boolean hasParenthesesIfNoArguments()
If there are no arguments, are parentheses required?
abstract String render(Type firstArgumentType, List arguments, SessionFactoryImplementor factory)
Render the function call as SQL fragment.

Public Methods

public abstract 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.
Throws
QueryException Indicates an issue resolving the return type.

public abstract boolean hasArguments ()

Does this function have any arguments?

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

public abstract boolean hasParenthesesIfNoArguments ()

If there are no arguments, are parentheses required?

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

public abstract String render (Type firstArgumentType, List arguments, SessionFactoryImplementor factory)

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
factory The SessionFactory
Returns
  • The rendered function call
Throws
QueryException Indicates a problem rendering the function call.