Top Description Fields Constructors Methods
org.hibernate.query.criteria.internal.expression.function

public Class BasicFunctionExpression<X>

extends ExpressionImpl<X>
implements FunctionExpression<X>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.hibernate.query.criteria.internal.expression.function.FunctionExpression, javax.persistence.criteria.Expression, javax.persistence.criteria.Selection, javax.persistence.TupleElement
Known Direct Subclasses
org.hibernate.query.criteria.internal.expression.function.CastFunction, org.hibernate.query.criteria.internal.expression.function.CurrentDateFunction, org.hibernate.query.criteria.internal.expression.function.CurrentTimeFunction, org.hibernate.query.criteria.internal.expression.function.CurrentTimestampFunction, org.hibernate.query.criteria.internal.expression.function.LocateFunction, org.hibernate.query.criteria.internal.expression.function.ParameterizedFunctionExpression, org.hibernate.query.criteria.internal.expression.function.SubstringFunction, org.hibernate.query.criteria.internal.expression.function.TrimFunction
Imports
java.io.Serializable, org.hibernate.query.criteria.internal.CriteriaBuilderImpl, .ParameterRegistry, org.hibernate.query.criteria.internal.compile.RenderingContext, org.hibernate.query.criteria.internal.expression.ExpressionImpl
Models the basic concept of a SQL function.
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final String
functionName

Constructor Summary

AccessConstructor and Description
public
BasicFunctionExpression(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType, String functionName)

Method Summary

Modifier and TypeMethod and Description
public String
getFunctionName()

Implements org.hibernate.query.criteria.internal.expression.function.FunctionExpression.getFunctionName.

Retrieve the name of the function.
public boolean
isAggregation()

Implements org.hibernate.query.criteria.internal.expression.function.FunctionExpression.isAggregation.

Is this function a value aggregator (like a COUNT or MAX function e.g.)?
protected static int
properSize(int number)

public void
registerParameters(ParameterRegistry
The parameter registry with which to register.
registry)

Implements org.hibernate.query.criteria.internal.ParameterContainer.registerParameters.

Register any parameters contained within this query component with the given registry.
public String
render(RenderingContext renderingContext)

Implements org.hibernate.query.criteria.internal.Renderable.render.

Perform the rendering, returning the rendition
Inherited from org.hibernate.query.criteria.internal.expression.ExpressionImpl:
asasBigDecimalasBigIntegerasDoubleasFloatasIntegerasLongasStringininininisNotNullisNull

Field Detail

functionNameback to summary
private final String functionName

Constructor Detail

BasicFunctionExpressionback to summary
public BasicFunctionExpression(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType, String functionName)

Method Detail

getFunctionNameback to summary
public String getFunctionName()

Implements org.hibernate.query.criteria.internal.expression.function.FunctionExpression.getFunctionName.

Doc from org.hibernate.query.criteria.internal.expression.function.FunctionExpression.getFunctionName.

Retrieve the name of the function.

Returns:String

The function name.

isAggregationback to summary
public boolean isAggregation()

Implements org.hibernate.query.criteria.internal.expression.function.FunctionExpression.isAggregation.

Doc from org.hibernate.query.criteria.internal.expression.function.FunctionExpression.isAggregation.

Is this function a value aggregator (like a COUNT or MAX function e.g.)?

Returns:boolean

True if this functions does aggregation.

properSizeback to summary
protected static int properSize(int number)
registerParametersback to summary
public void registerParameters(ParameterRegistry registry)

Implements org.hibernate.query.criteria.internal.ParameterContainer.registerParameters.

Doc from org.hibernate.query.criteria.internal.ParameterContainer.registerParameters.

Register any parameters contained within this query component with the given registry.

Parameters
registry:ParameterRegistry

The parameter registry with which to register.

renderback to summary
public String render(RenderingContext renderingContext)

Implements org.hibernate.query.criteria.internal.Renderable.render.

Doc from org.hibernate.query.criteria.internal.Renderable.render.

Perform the rendering, returning the rendition