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

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

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

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

org.hibernate.query.sqm.tree.domain.SqmCorrelatedRoot<T>

All Implemented Interfaces:

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

public class SqmCorrelatedRoot<T>
extends SqmRoot<T>
implements SqmPathWrapper<T,T>, SqmCorrelation<T,T>

Author:

Steve Ebersole

See Also:

• Serialized Form

Field Summary

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

log

Constructor Summary

Constructors

Constructor	Description
SqmCorrelatedRoot(SqmRoot<T> correlationParent)

Method Summary

Modifier and Type	Method	Description
<X> X	accept(SemanticQueryWalker<X> walker)	Accept the walker per visitation
JpaSelection<T>	alias(String name)	Assigns an alias to the selection item.
SqmCorrelatedRoot<T>	copy(SqmCopyContext context)
SqmRoot<T>	getCorrelatedRoot()
SqmRoot<T>	getCorrelationParent()	Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).
String	getExplicitAlias()	Retrieve the explicit alias, if one.
SqmPath<T>	getWrappedPath()	Access the wrapped SqmPath.
boolean	isCorrelated()	Whether the From object has been obtained as a result of correlation (use of a Subquery correlate method).
void	setExplicitAlias(String explicitAlias)	Set the explicit alias for this path

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

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

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

addTreat, appendHqlString, copyTo, crossJoin, crossJoin, fetch, fetch, fetch, fetch, fetch, fetch, findTreat, getFetches, getJoins, getParentPath, getSqmJoins, getSqmTreats, hasJoins, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinLateral, joinLateral, joinList, joinList, joinMap, joinMap, joinSet, joinSet, removeLeftFetchJoins, resolvePathPart, visitSqmJoins

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

copyTo, get, get, get, get, getExpressible, getNavigablePath, getNavigablePathCopy, getNodeType, getReferencedPathSource, getResolvedModel, 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, equalTo, equalTo, getJavaTypeDescriptor, in, in, in, in, internalApplyInferableType, isNotNull, isNull, nodeBuilder

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

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, joinLateral, joinLateral

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

getParentPath

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

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, visitSubSelectableNodes

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

addSqmJoin, getReferencedPathSource, getSqmJoins, getSqmTreats, hasJoins, hasTreats, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet, treatAs, treatAs, treatAs, treatAs, visitSqmJoins

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

asLoggableText, nodeBuilder

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

applyInferableType, findRoot, get, get, get, get, getJavaTypeDescriptor, getLhs, getNavigablePath, getNodeType, getResolvedModel, getReusablePath, getReusablePaths, registerReusablePath, resolveAlias, resolveIndexedAccess, resolvePathPart, 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

appendHqlString, toHqlString

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Constructor Details

SqmCorrelatedRoot

public SqmCorrelatedRoot(SqmRoot<T> correlationParent)

Method Details

copy

public SqmCorrelatedRoot<T> copy(SqmCopyContext context)

Specified by:

copy in interface SqmExpression<T>

Specified by:

copy in interface SqmFrom<T,T>

Specified by:

copy in interface SqmNode

Specified by:

copy in interface SqmPath<T>

Specified by:

copy in interface SqmSelectableNode<T>

Specified by:

copy in interface SqmTypedNode<T>

Overrides:

copy in class SqmRoot<T>

getCorrelationParent

public SqmRoot<T> getCorrelationParent()

Description copied from interface: From

Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).

Specified by:

getCorrelationParent in interface From<T,T>

Specified by:

getCorrelationParent in interface JpaFrom<T,T>

Specified by:

getCorrelationParent in interface SqmFrom<T,T>

Overrides:

getCorrelationParent in class AbstractSqmFrom<T,T>

Returns:

the parent of the correlated From object

getWrappedPath

public SqmPath<T> getWrappedPath()

Description copied from interface: SqmPathWrapper

Access the wrapped SqmPath.

Specified by:

getWrappedPath in interface SqmPathWrapper<T,T>

getExplicitAlias

public String getExplicitAlias()

Description copied from interface: SqmPath

Retrieve the explicit alias, if one. May return null

Specified by:

getExplicitAlias in interface SqmPath<T>

Overrides:

getExplicitAlias in class AbstractSqmFrom<T,T>

setExplicitAlias

public void setExplicitAlias(String explicitAlias)

Description copied from interface: SqmPath

Set the explicit alias for this path

Specified by:

setExplicitAlias in interface SqmPath<T>

Overrides:

setExplicitAlias in class AbstractSqmFrom<T,T>

alias

public JpaSelection<T> alias(String name)

Description copied from interface: Selection

Assigns an alias to the selection item. Once assigned, an alias cannot be changed or reassigned. Returns the same selection item.

Specified by:

alias in interface JpaSelection<T>

Specified by:

alias in interface Selection<T>

Overrides:

alias in class AbstractSqmFrom<T,T>

Parameters:

name - alias

Returns:

selection item

isCorrelated

public boolean isCorrelated()

Description copied from interface: From

Whether the From object has been obtained as a result of correlation (use of a Subquery correlate method).

Specified by:

isCorrelated in interface From<T,T>

Overrides:

isCorrelated in class AbstractSqmFrom<T,T>

Returns:

boolean indicating whether the object has been obtained through correlation

getCorrelatedRoot

public SqmRoot<T> getCorrelatedRoot()

Specified by:

getCorrelatedRoot in interface SqmCorrelation<T,T>

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<T>