Top Description Fields Constructors Methods
org.hibernate.query.sqm.tree.expression

public abstract Class SqmFunction<T>

extends AbstractSqmExpression<T>
implements JpaFunction<T>, SemanticPathPart
Class Inheritance
All Implemented Interfaces
org.hibernate.query.hql.spi.SemanticPathPart, org.hibernate.query.criteria.JpaFunction, org.hibernate.query.criteria.JpaExpression, jakarta.persistence.criteria.Expression, jakarta.persistence.criteria.Selection, jakarta.persistence.TupleElement, org.hibernate.query.criteria.JpaSelection, org.hibernate.query.criteria.JpaTupleElement, org.hibernate.query.criteria.JpaCriteriaNode, java.io.Serializable
Known Direct Subclasses
org.hibernate.query.sqm.function.SelfRenderingSqmFunction
Imports
java.util.List, org.hibernate.query.criteria.JpaFunction, org.hibernate.query.hql.spi.SemanticPathPart, .SqmCreationState, org.hibernate.query.sqm.NodeBuilder, .SemanticQueryWalker, .SqmExpressible, org.hibernate.query.sqm.function.SqmFunctionDescriptor, org.hibernate.query.sqm.sql.SqmToSqlAstConverter, org.hibernate.query.sqm.tree.SqmTypedNode, org.hibernate.query.sqm.tree.domain.SqmPath, org.hibernate.sql.ast.tree.expression.Expression
A SQM function
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final List<? extends SqmTypedNode<?>>
arguments

private final SqmFunctionDescriptor
functionDescriptor

private final String
functionName

Constructor Summary

AccessConstructor and Description
public
SqmFunction(String functionName, SqmFunctionDescriptor functionDescriptor, SqmExpressible<T> type, List<? extends SqmTypedNode<?>> arguments, NodeBuilder criteriaBuilder)

Method Summary

Modifier and TypeMethod and Description
public <X> X
accept(SemanticQueryWalker<X> walker)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Accept the walker per visitation
public void
appendHqlString(StringBuilder sb)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.appendHqlString.

public abstract Expression
convertToSqlAst(SqmToSqlAstConverter walker)

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

public SqmFunctionDescriptor
getFunctionDescriptor()

public String
getFunctionName()

Implements org.hibernate.query.criteria.JpaFunction.getFunctionName.

Retrieve the name of the function.
public SqmPath<?>
resolveIndexedAccess(SqmExpression<?> selector, boolean isTerminal, SqmCreationState creationState)

Implements org.hibernate.query.hql.spi.SemanticPathPart.resolveIndexedAccess.

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

Implements org.hibernate.query.hql.spi.SemanticPathPart.resolvePathPart.

Inherited from org.hibernate.query.sqm.tree.expression.AbstractSqmExpression:
aliasapplyInferableTypeasasBigDecimalasBigIntegerasDoubleasFloatasIntegerasLongasStringequalToequalTogetJavaTypeDescriptorinininininternalApplyInferableTypeisNotNullisNullnodeBuilder

Field Detail

argumentsback to summary
private final List<? extends SqmTypedNode<?>> arguments
functionDescriptorback to summary
private final SqmFunctionDescriptor functionDescriptor
functionNameback to summary
private final String functionName

Constructor Detail

SqmFunctionback to summary
public SqmFunction(String functionName, SqmFunctionDescriptor functionDescriptor, SqmExpressible<T> type, List<? extends SqmTypedNode<?>> arguments, NodeBuilder criteriaBuilder)

Method Detail

acceptback to summary
public <X> X accept(SemanticQueryWalker<X> walker)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Doc from org.hibernate.query.sqm.tree.SqmVisitableNode.accept.

Accept the walker per visitation

Annotations
@Override
appendHqlStringback to summary
public void appendHqlString(StringBuilder sb)

Implements org.hibernate.query.sqm.tree.SqmVisitableNode.appendHqlString.

Annotations
@Override
convertToSqlAstback to summary
public abstract Expression convertToSqlAst(SqmToSqlAstConverter walker)
getArgumentsback to summary
public List<? extends SqmTypedNode<?>> getArguments()
getFunctionDescriptorback to summary
public SqmFunctionDescriptor getFunctionDescriptor()
getFunctionNameback to summary
public String getFunctionName()

Implements org.hibernate.query.criteria.JpaFunction.getFunctionName.

Doc from org.hibernate.query.criteria.JpaFunction.getFunctionName.

Retrieve the name of the function.

Returns:String

The function name.

Annotations
@Override
resolveIndexedAccessback to summary
public SqmPath<?> resolveIndexedAccess(SqmExpression<?> selector, boolean isTerminal, SqmCreationState creationState)

Implements org.hibernate.query.hql.spi.SemanticPathPart.resolveIndexedAccess.

Annotations
@Override
resolvePathPartback to summary
public SemanticPathPart resolvePathPart(String name, boolean isTerminal, SqmCreationState creationState)

Implements org.hibernate.query.hql.spi.SemanticPathPart.resolvePathPart.

Annotations
@Override