org.hibernate.dialect.function
Class VarArgsSQLFunction

java.lang.Object
  org.hibernate.dialect.function.VarArgsSQLFunction

All Implemented Interfaces:

SQLFunction

public class VarArgsSQLFunction

extends Object

implements SQLFunction

Support for slightly more general templating than StandardSQLFunction, with an unlimited number of arguments.

Author:

Gavin King

Constructor Summary

VarArgsSQLFunction(String begin, String sep, String end)

VarArgsSQLFunction(Type type, String begin, String sep, String end)

Method Summary

Type	getReturnType(Type columnType, Mapping mapping) The function return type
boolean	hasArguments() Does this function have any arguments?
boolean	hasParenthesesIfNoArguments() If there are no arguments, are parens required?
String	render(List args, SessionFactoryImplementor factory) Render the function call as SQL

Methods inherited from class java.lang.Object

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

Constructor Detail

VarArgsSQLFunction

public VarArgsSQLFunction(Type type,
                          String begin,
                          String sep,
                          String end)

VarArgsSQLFunction

public VarArgsSQLFunction(String begin,
                          String sep,
                          String end)

Method Detail

getReturnType

public Type getReturnType(Type columnType,
                          Mapping mapping)
                   throws QueryException

Description copied from interface: SQLFunction

The function return type

Specified by:

getReturnType in interface SQLFunction

Parameters:

columnType - the type of the first argument

Throws:

QueryException

hasArguments

public boolean hasArguments()

Description copied from interface: SQLFunction

Does this function have any arguments?

Specified by:

hasArguments in interface SQLFunction

hasParenthesesIfNoArguments

public boolean hasParenthesesIfNoArguments()

Description copied from interface: SQLFunction

If there are no arguments, are parens required?

Specified by:

hasParenthesesIfNoArguments in interface SQLFunction

render

public String render(List args,
                     SessionFactoryImplementor factory)
              throws QueryException

Description copied from interface: SQLFunction

Render the function call as SQL

Specified by:

render in interface SQLFunction

Throws:

QueryException