Package org.hibernate.query.sqm.tree.domain

Class SqmFunctionRoot<E>

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.domain.AbstractSqmPath<T>

org.hibernate.query.sqm.tree.domain.AbstractSqmFrom<E,E>

org.hibernate.query.sqm.tree.from.SqmRoot<E>

org.hibernate.query.sqm.tree.domain.SqmFunctionRoot<E>

All Implemented Interfaces:

Expression<E>, FetchParent<E,E>, From<E,E>, Path<E>, Root<E>, Selection<E>, TupleElement<E>, Serializable, JpaCriteriaNode, JpaExpression<E>, JpaFetchParent<E,E>, JpaFrom<E,E>, JpaFunctionFrom<E,E>, JpaFunctionRoot<E>, JpaPath<E>, JpaRoot<E>, JpaSelection<E>, JpaTupleElement<E>, SemanticPathPart, SqmPath<E>, SqmExpression<E>, SqmFrom<E,E>, SqmSelectableNode<E>, SqmExpressibleAccessor<E>, SqmNode, SqmTypedNode<E>, SqmVisitableNode

@Incubating
public class SqmFunctionRoot<E>
extends SqmRoot<E>
implements JpaFunctionRoot<E>

See Also:

• Serialized Form

Field Summary

Fields inherited from interface org.hibernate.query.sqm.tree.SqmNode

log

Constructor Summary

Constructors

Modifier	Constructor	Description
	SqmFunctionRoot(SqmSetReturningFunction<E> function, String alias)
protected	SqmFunctionRoot(NavigablePath navigablePath, SqmSetReturningFunction<E> function, SqmPathSource<E> pathSource, String alias)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
SqmFunctionRoot<E>	copy(SqmCopyContext context)
SqmCorrelatedRoot<E>	createCorrelation()
String	getEntityName()
SqmSetReturningFunction<E>	getFunction()	The function for this from node.
EntityDomainType<E>	getModel()
SqmPathSource<?>	getResolvedModel()	Get this path's actual resolved model, i.e.
SqmPath<Long>	index()	The expression referring to an iteration variable, indexing the rows produced by the function.
<S extends E> SqmTreatedFrom<E,E,S>	treatAs(Class<S> treatJavaType)	Support for JPA's explicit (TREAT) down-casting.
<S extends E> SqmTreatedRoot	treatAs(Class<S> treatJavaType, String alias)
<S extends E> SqmTreatedRoot	treatAs(Class<S> treatJavaType, String alias, boolean fetch)
<S extends E> SqmTreatedFrom<E,E,S>	treatAs(EntityDomainType<S> treatTarget)	Support for JPA's explicit (TREAT) down-casting.
<S extends E> SqmTreatedRoot	treatAs(EntityDomainType<S> treatTarget, String alias)
<S extends E> SqmTreatedRoot	treatAs(EntityDomainType<S> treatTarget, String alias, boolean fetch)

Methods inherited from class org.hibernate.query.sqm.tree.from.SqmRoot

addOrderedJoin, addSqmJoin, containsOnlyInnerJoins, copyTo, findRoot, getLhs, getManagedType, getOrderedJoins, isAllowJoins, toString

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmFrom

addTreat, alias, appendHqlString, copyTo, crossJoin, crossJoin, fetch, fetch, fetch, fetch, fetch, fetch, findTreat, getCorrelationParent, getExplicitAlias, getFetches, getJoins, getParentPath, getSqmJoins, getSqmTreats, hasImplicitlySelectableJoin, hasJoins, isCorrelated, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinArray, joinArray, joinArray, joinArray, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinCollection, joinCollection, joinLateral, joinLateral, joinLateral, joinLateral, joinList, joinList, joinMap, joinMap, joinSet, joinSet, removeLeftFetchJoins, resolvePathPart, setExplicitAlias, visitSqmJoins

Methods inherited from class org.hibernate.query.sqm.tree.domain.AbstractSqmPath

copyTo, get, get, get, get, get, getExpressible, getNavigablePath, getNavigablePathCopy, getNodeType, getReferencedPathSource, getReusablePath, getReusablePaths, getTreatedPath, registerReusablePath, resolvePath, resolvePath, type, visitReusablePaths

Methods inherited from class org.hibernate.query.sqm.tree.expression.AbstractSqmExpression

applyInferableType, as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, equalTo, equalTo, getJavaTypeDescriptor, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder, notEqualTo, notEqualTo

Methods inherited from class org.hibernate.query.sqm.tree.jpa.AbstractJpaSelection

getSelectionItems, isCompoundSelection

Methods inherited from class org.hibernate.query.sqm.tree.jpa.AbstractJpaTupleElement

copyTo, getAlias, setAlias, setExpressibleType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jakarta.persistence.criteria.From

getJoins, isCorrelated

Methods inherited from interface org.hibernate.query.criteria.JpaFetchParent

fetch, fetch, fetch, fetch, fetch, fetch, getFetches

Methods inherited from interface org.hibernate.query.criteria.JpaFrom

crossJoin, crossJoin, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinArray, joinArray, joinArray, joinArray, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinArrayCollection, joinLateral, joinLateral, joinLateral, joinLateral, joinLateral

Methods inherited from interface org.hibernate.query.criteria.JpaPath

getParentPath

Methods inherited from interface org.hibernate.query.criteria.JpaRoot

getManagedType

Methods inherited from interface org.hibernate.query.criteria.JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface org.hibernate.query.criteria.JpaTupleElement

getJavaType, getJavaTypeName, isEnum

Methods inherited from interface jakarta.persistence.criteria.Selection

isCompoundSelection

Methods inherited from interface org.hibernate.query.sqm.tree.expression.SqmExpression

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, cast, castAs, equalTo, equalTo, in, in, in, in, isNotNull, isNull, notEqualTo, notEqualTo, visitSubSelectableNodes

Methods inherited from interface org.hibernate.query.sqm.tree.from.SqmFrom

getReferencedPathSource, hasTreats

Methods inherited from interface org.hibernate.query.sqm.tree.SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface org.hibernate.query.sqm.tree.domain.SqmPath

applyInferableType, get, get, get, get, get, getJavaTypeDescriptor, getNavigablePath, getNodeType, getReusablePath, getReusablePaths, registerReusablePath, resolveAlias, resolveIndexedAccess, type, visitReusablePaths

Methods inherited from interface org.hibernate.query.sqm.tree.select.SqmSelectableNode

getTupleLength

Methods inherited from interface org.hibernate.query.sqm.tree.SqmTypedNode

getExpressible, getNodeJavaType

Methods inherited from interface org.hibernate.query.sqm.tree.SqmVisitableNode

toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Constructor Details

SqmFunctionRoot

public SqmFunctionRoot(SqmSetReturningFunction<E> function,
 String alias)

SqmFunctionRoot

protected SqmFunctionRoot(NavigablePath navigablePath,
 SqmSetReturningFunction<E> function,
 SqmPathSource<E> pathSource,
 String alias)

Method Details

copy

public SqmFunctionRoot<E> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<E>

Specified by:

copy in interface SqmFrom<E,E>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmPath<E>

Specified by:

copy in interface SqmSelectableNode<E>

Specified by:

copy in interface SqmTypedNode<E>

Overrides:

copy in class SqmRoot<E>

getFunction

public SqmSetReturningFunction<E> getFunction()

Description copied from interface: JpaFunctionFrom

The function for this from node.

Specified by:

getFunction in interface JpaFunctionFrom<E,E>

index

public SqmPath<Long> index()

Description copied from interface: JpaFunctionFrom

The expression referring to an iteration variable, indexing the rows produced by the function. This is the equivalent of the SQL with ordinality clause.

Specified by:

index in interface JpaFunctionFrom<E,E>

accept

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

Description copied from interface: SqmVisitableNode

Accept the walker per visitation

Specified by:

accept in interface SqmVisitableNode

Overrides:

accept in class SqmRoot<E>

getModel

public EntityDomainType<E> getModel()

Specified by:

getModel in interface JpaRoot<E>

Specified by:

getModel in interface Path<E>

Specified by:

getModel in interface Root<E>

Overrides:

getModel in class SqmRoot<E>

getEntityName

public String getEntityName()

Overrides:

getEntityName in class SqmRoot<E>

getResolvedModel

public SqmPathSource<?> getResolvedModel()

Description copied from interface: SqmPath

Get this path's actual resolved model, i.e. the concrete type for generic attributes.

Specified by:

getResolvedModel in interface SqmPath<E>

Overrides:

getResolvedModel in class AbstractSqmPath<E>

createCorrelation

public SqmCorrelatedRoot<E> createCorrelation()

Overrides:

createCorrelation in class SqmRoot<E>

treatAs

public <S extends E> SqmTreatedFrom<E,E,S> treatAs(Class<S> treatJavaType)
                                            throws PathException

Description copied from interface: JpaPath

Support for JPA's explicit (TREAT) down-casting.

Specified by:

treatAs in interface JpaFrom<E,E>

Specified by:

treatAs in interface JpaPath<E>

Specified by:

treatAs in interface SqmFrom<E,E>

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class SqmRoot<E>

Throws:

PathException

treatAs

public <S extends E> SqmTreatedFrom<E,E,S> treatAs(EntityDomainType<S> treatTarget)
                                            throws PathException

Description copied from interface: JpaPath

Support for JPA's explicit (TREAT) down-casting.

Specified by:

treatAs in interface JpaFrom<E,E>

Specified by:

treatAs in interface JpaPath<E>

Specified by:

treatAs in interface SqmFrom<E,E>

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class SqmRoot<E>

Throws:

PathException

treatAs

public <S extends E> SqmTreatedRoot treatAs(Class<S> treatJavaType,
 String alias)

Specified by:

treatAs in interface SqmFrom<E,E>

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class SqmRoot<E>

treatAs

public <S extends E> SqmTreatedRoot treatAs(EntityDomainType<S> treatTarget,
 String alias)

Specified by:

treatAs in interface SqmFrom<E,E>

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class SqmRoot<E>

treatAs

public <S extends E> SqmTreatedRoot treatAs(Class<S> treatJavaType,
 String alias,
 boolean fetch)

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class SqmRoot<E>

treatAs

public <S extends E> SqmTreatedRoot treatAs(EntityDomainType<S> treatTarget,
 String alias,
 boolean fetch)

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class SqmRoot<E>