Class SqmFunction<T>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

org.hibernate.query.sqm.tree.jpa.AbstractJpaTupleElement<T>

org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection<T>

org.hibernate.query.sqm.tree.expression.AbstractSqmExpression<T>

org.hibernate.query.sqm.tree.expression.SqmFunction<T>

All Implemented Interfaces:

Expression<T>, Selection<T>, TupleElement<T>, Serializable, JpaCriteriaNode, JpaExpression<T>, JpaFunction<T>, JpaSelection<T>, JpaTupleElement<T>, SemanticPathPart, SqmExpression<T>, SqmSelectableNode<T>, SqmCacheable, SqmExpressibleAccessor<T>, SqmNode, SqmTypedNode<T>, SqmVisitableNode

Direct Known Subclasses:

SelfRenderingSqmFunction

public abstract class SqmFunction<T>
extends AbstractSqmExpression<T>
implements JpaFunction<T>, SemanticPathPart

A SQM function

See Also:

• Serialized Form

Field Summary

Fields inherited from interface SqmNode

LOG

Constructor Summary

Constructors

Constructor	Description
SqmFunction(String functionName, SqmFunctionDescriptor functionDescriptor, @Nullable SqmBindableType<T> type, List<? extends SqmTypedNode<?>> arguments, NodeBuilder criteriaBuilder)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
void	appendHqlString(StringBuilder hql, SqmRenderContext context)
int	cacheHashCode()
abstract Expression	convertToSqlAst(SqmToSqlAstConverter walker)
boolean	equals(@Nullable Object other)
List<? extends SqmTypedNode<?>>	getArguments()
SqmFunctionDescriptor	getFunctionDescriptor()
String	getFunctionName()	Retrieve the name of the function.
int	hashCode()
boolean	isCompatible(Object other)
SqmPath<?>	resolveIndexedAccess(SqmExpression<?> selector, boolean isTerminal, SqmCreationState creationState)
SemanticPathPart	resolvePathPart(String name, boolean isTerminal, SqmCreationState creationState)

Methods inherited from class AbstractSqmExpression

applyInferableType, as, cast, equalTo, equalTo, getJavaTypeDescriptor, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder, notEqualTo, notEqualTo

Methods inherited from class AbstractJpaSelection

alias, getSelectionItems, isCompoundSelection

Methods inherited from class AbstractJpaTupleElement

copyTo, getAlias, getNodeType, setAlias, setExpressibleType

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeDescriptor, getJavaTypeName, isEnum

Methods inherited from interface Selection

isCompoundSelection

Methods inherited from interface SqmExpression

asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, castAs, copy, getNodeType, visitSubSelectableNodes

Methods inherited from interface SqmNode

asLoggableText

Methods inherited from interface SqmSelectableNode

getTupleLength

Methods inherited from interface SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface SqmVisitableNode

toHqlString

Methods inherited from interface TupleElement

getAlias

Constructor Details

SqmFunction

public SqmFunction(String functionName,
 SqmFunctionDescriptor functionDescriptor,
 @Nullable SqmBindableType<T> type,
 List<? extends SqmTypedNode<?>> arguments,
 NodeBuilder criteriaBuilder)

Method Details

getFunctionDescriptor

public SqmFunctionDescriptor getFunctionDescriptor()

getFunctionName

public String getFunctionName()

Description copied from interface: JpaFunction

Retrieve the name of the function.

Specified by:

getFunctionName in interface JpaFunction<T>

Returns:

The function name.

getArguments

public List<? extends SqmTypedNode<?>> getArguments()

convertToSqlAst

public abstract Expression convertToSqlAst(SqmToSqlAstConverter walker)

accept

public <X> X accept(SemanticQueryWalker<X> walker)

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

appendHqlString

public void appendHqlString(StringBuilder hql,
 SqmRenderContext context)

Specified by:

appendHqlString in interface SqmVisitableNode

resolvePathPart

public SemanticPathPart resolvePathPart(String name,
 boolean isTerminal,
 SqmCreationState creationState)

Specified by:

resolvePathPart in interface SemanticPathPart

resolveIndexedAccess

public SqmPath<?> resolveIndexedAccess(SqmExpression<?> selector,
 boolean isTerminal,
 SqmCreationState creationState)

Specified by:

resolveIndexedAccess in interface SemanticPathPart

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isCompatible

public boolean isCompatible(Object other)

Specified by:

isCompatible in interface SqmCacheable

cacheHashCode

public int cacheHashCode()

Specified by:

cacheHashCode in interface SqmCacheable