org.hibernate.dialect.function
Class StandardSQLFunction

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

All Implemented Interfaces:

SQLFunction

public class StandardSQLFunction

extends Object

implements SQLFunction

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.

Author:

David Channon

Constructor Summary

StandardSQLFunction(String name)

StandardSQLFunction(String name, Type typeValue)

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
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StandardSQLFunction

public StandardSQLFunction(String name)

StandardSQLFunction

public StandardSQLFunction(String name,
                           Type typeValue)

Method Detail

getReturnType

public Type getReturnType(Type columnType,
                          Mapping mapping)

Description copied from interface: SQLFunction

The function return type

Specified by:

getReturnType in interface SQLFunction

Parameters:

columnType - the type of the first argument

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)

Description copied from interface: SQLFunction

Render the function call as SQL

Specified by:

render in interface SQLFunction

toString

public String toString()