Class SqmFunctionRoot<E>

java.lang.Object

org.hibernate.query.sqm.tree.AbstractSqmNode

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

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

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

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

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>, SqmCacheable, 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 SqmNode

LOG

Constructor Summary

Constructors

Modifier	Constructor	Description
	SqmFunctionRoot(SqmSetReturningFunction<E> function, @Nullable String alias)
protected	SqmFunctionRoot(NavigablePath navigablePath, SqmSetReturningFunction<E> function, SqmPathSource<E> pathSource, @Nullable 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()
boolean	deepEquals(SqmFrom<?,?> object)
String	getEntityName()
SqmSetReturningFunction<E>	getFunction()	The function for this from node.
SqmEntityDomainType<E>	getModel()
SqmPathSource<E>	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.
boolean	isDeepCompatible(SqmFrom<?,?> object)
<S extends E> SqmTreatedFrom<E,E,S>	treatAs(EntityDomainType<S> treatTarget, @Nullable String alias, boolean fetch)

Methods inherited from class SqmRoot

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

Methods inherited from class AbstractSqmFrom

addTreat, alias, appendHqlString, copyTo, crossJoin, crossJoin, fetch, fetch, fetch, fetch, fetch, fetch, findTreat, getCorrelationParent, getExplicitAlias, getFetches, getJoins, getNumberOfJoins, getParentPath, getSqmJoins, getSqmTreats, hasImplicitlySelectableJoin, hasJoins, id, 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 AbstractSqmPath

cacheHashCode, copyTo, equals, get, get, get, get, get, getExpressible, getJavaTypeDescriptor, getNavigablePath, getNavigablePathCopy, getNodeJavaType, getNodeType, getReferencedPathSource, getReusablePath, getReusablePaths, getTreatedPath, hashCode, isCompatible, registerReusablePath, resolvePath, resolvePath, type, visitReusablePaths

Methods inherited from class AbstractSqmExpression

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

Methods inherited from class AbstractJpaSelection

getSelectionItems, isCompoundSelection

Methods inherited from class AbstractJpaTupleElement

copyTo, getAlias, setAlias, setExpressibleType

Methods inherited from class Object

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

Methods inherited from interface From

getJoins, isCorrelated

Methods inherited from interface JpaFetchParent

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

Methods inherited from interface JpaFrom

crossJoin, crossJoin, id, 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, treatAs, treatAs

Methods inherited from interface JpaPath

getParentPath

Methods inherited from interface JpaRoot

getManagedType

Methods inherited from interface JpaSelection

alias, getCompoundSelectionItems, getSelectionItems

Methods inherited from interface JpaTupleElement

getJavaType, getJavaTypeName, isEnum

Methods inherited from interface Selection

isCompoundSelection

Methods inherited from interface SqmCacheable

cacheHashCode, isCompatible

Methods inherited from interface 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 SqmFrom

getReferencedPathSource, hasTreats, resolveAlias

Methods inherited from interface SqmNode

asLoggableText, nodeBuilder

Methods inherited from interface SqmPath

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

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

SqmFunctionRoot

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

SqmFunctionRoot

protected SqmFunctionRoot(NavigablePath navigablePath,
 SqmSetReturningFunction<E> function,
 SqmPathSource<E> pathSource,
 @Nullable 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 SqmEntityDomainType<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<E> 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(EntityDomainType<S> treatTarget,
 @Nullable String alias,
 boolean fetch)

Specified by:

treatAs in interface SqmPath<E>

Overrides:

treatAs in class SqmRoot<E>

deepEquals

public boolean deepEquals(SqmFrom<?,?> object)

Specified by:

deepEquals in interface SqmFrom<E,E>

Overrides:

deepEquals in class SqmRoot<E>

isDeepCompatible

public boolean isDeepCompatible(SqmFrom<?,?> object)

Specified by:

isDeepCompatible in interface SqmFrom<E,E>

Overrides:

isDeepCompatible in class SqmRoot<E>