org.hibernate.dialect.function
Class AvgFunction

java.lang.Object
  extended by org.hibernate.dialect.function.AvgFunction
All Implemented Interfaces:
SQLFunction
Direct Known Subclasses:
AvgWithArgumentCastFunction

public class AvgFunction
extends Object
implements SQLFunction

The basic JPA spec compliant definition poAVG aggregation function.

Author:
Steve Ebersole

Constructor Summary
AvgFunction()
           
 
Method Summary
 Type getReturnType(Type columnType, Mapping mapping)
          The return type of the function.
 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 fragment.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AvgFunction

public AvgFunction()
Method Detail

getReturnType

public final Type getReturnType(Type columnType,
                                Mapping mapping)
                         throws QueryException
Description copied from interface: SQLFunction
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.

Specified by:
getReturnType in interface SQLFunction
Parameters:
columnType - the type of the first argument
mapping - The mapping source.
Returns:
The type to be expected as a return.
Throws:
QueryException - Indicates an issue resolving the return type.

hasArguments

public final boolean hasArguments()
Description copied from interface: SQLFunction
Does this function have any arguments?

Specified by:
hasArguments in interface SQLFunction
Returns:
True if the function expects to have parameters; false otherwise.

hasParenthesesIfNoArguments

public final boolean hasParenthesesIfNoArguments()
Description copied from interface: SQLFunction
If there are no arguments, are parens required?

Specified by:
hasParenthesesIfNoArguments in interface SQLFunction
Returns:
True if a no-arg call of this function requires parentheses.

render

public String render(List args,
                     SessionFactoryImplementor factory)
              throws QueryException
Description copied from interface: SQLFunction
Render the function call as SQL fragment.

Specified by:
render in interface SQLFunction
Parameters:
args - The function arguments
factory - The SessionFactory
Returns:
The rendered function call
Throws:
QueryException - Indicates a problem rendering the function call.

toString

public final String toString()
Overrides:
toString in class Object


Copyright © 2001-2010 Red Hat, Inc. All Rights Reserved.