Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.hibernate.dialect.function
Class StandardSQLFunction  view StandardSQLFunction download StandardSQLFunction.java

java.lang.Object
  extended byorg.hibernate.dialect.function.StandardSQLFunction
All Implemented Interfaces:
SQLFunction

public class StandardSQLFunction
extends java.lang.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.


Field Summary
private  java.lang.String name
           
private  org.hibernate.type.Type returnType
           
 
Constructor Summary
StandardSQLFunction(java.lang.String name)
           
StandardSQLFunction(java.lang.String name, org.hibernate.type.Type typeValue)
           
 
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
 java.lang.String toString()
          Convert this Object to a human-readable String.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

returnType

private org.hibernate.type.Type returnType

name

private java.lang.String name
Constructor Detail

StandardSQLFunction

public StandardSQLFunction(java.lang.String name)

StandardSQLFunction

public StandardSQLFunction(java.lang.String name,
                           org.hibernate.type.Type typeValue)
Method Detail

getReturnType

public org.hibernate.type.Type getReturnType(org.hibernate.type.Type columnType,
                                             org.hibernate.engine.Mapping mapping)
Description copied from interface: SQLFunction
The function return type

Specified by:
getReturnType in interface SQLFunction

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 java.lang.String render(java.util.List args,
                               org.hibernate.engine.SessionFactoryImplementor factory)
Description copied from interface: SQLFunction
Render the function call as SQL

Specified by:
render in interface SQLFunction

toString

public java.lang.String toString()
Description copied from class: java.lang.Object
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() 55 and such.

It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).