SQLFunction

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> hibernate >> dialect >> [ function overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.hibernate.dialect.function.SQLFunction

SOURCE |

Download org.hibernate.dialect.function.SQLFunction

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.hibernate.dialect.function
Interface SQLFunction

All Known Implementing Classes:: CastFunction, CharIndexFunction, NoArgSQLFunction, NvlFunction, PositionSubstringFunction, SQLFunctionTemplate, StandardSQLFunction, VarArgsSQLFunction

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.

Method Summary

org.hibernate.type.Type getReturnType(org.hibernate.type.Type columnType, org.hibernate.engine.Mapping mapping)
          The function return type

boolean hasArguments()
          Does this function have any arguments?

boolean hasParenthesesIfNoArguments()
          If there are no arguments, are parens required?

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

Method Detail

getReturnType

public org.hibernate.type.Type getReturnType(org.hibernate.type.Type columnType,
                                             org.hibernate.engine.Mapping mapping)
                                      throws org.hibernate.QueryException

The function return type

hasArguments

public boolean hasArguments()

Does this function have any arguments?

hasParenthesesIfNoArguments

public boolean hasParenthesesIfNoArguments()

If there are no arguments, are parens required?

render

public java.lang.String render(java.util.List args,
                               org.hibernate.engine.SessionFactoryImplementor factory)
                        throws org.hibernate.QueryException

Render the function call as SQL