FileDocCategorySizeDatePackage
SQLFunction.javaAPI DocHibernate 3.2.51879Wed Nov 08 09:56:52 GMT 2006org.hibernate.dialect.function

SQLFunction

public interface SQLFunction
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.
author
David Channon

Fields Summary
Constructors Summary
Methods Summary
public org.hibernate.type.TypegetReturnType(org.hibernate.type.Type columnType, org.hibernate.engine.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.

param
columnType the type of the first argument
param
mapping The mapping source.
return
The type to be expected as a return.
throws
org.hibernate.QueryException Indicates an issue resolving the return type.

public booleanhasArguments()
Does this function have any arguments?

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

public booleanhasParenthesesIfNoArguments()
If there are no arguments, are parens required?

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

public java.lang.Stringrender(java.util.List args, org.hibernate.engine.SessionFactoryImplementor factory)
Render the function call as SQL fragment.

param
args The function arguments
param
factory The SessionFactory
return
The rendered function call
throws
org.hibernate.QueryException Indicates a problem rendering the function call.