Top Fields Constructors Methods
org.hibernate.query.sqm.tree.from

public Class SqmRoot<E>

extends AbstractSqmFrom<E, E>
implements JpaRoot<E>
Class Inheritance
All Implemented Interfaces
org.hibernate.query.criteria.JpaRoot, jakarta.persistence.criteria.Root, jakarta.persistence.criteria.From, jakarta.persistence.criteria.FetchParent, jakarta.persistence.criteria.Path, jakarta.persistence.criteria.Expression, jakarta.persistence.criteria.Selection, jakarta.persistence.TupleElement, org.hibernate.query.criteria.JpaFrom, org.hibernate.query.criteria.JpaFetchParent, org.hibernate.query.criteria.JpaPath, org.hibernate.query.criteria.JpaExpression, 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.tree.domain.SqmCorrelatedRoot, org.hibernate.query.sqm.tree.domain.SqmCorrelatedRootJoin, org.hibernate.query.sqm.tree.domain.SqmCteRoot, org.hibernate.query.sqm.tree.domain.SqmDerivedRoot, org.hibernate.query.sqm.tree.domain.SqmTreatedRoot
Imports
java.util.ArrayList, .List, org.hibernate.Internal, org.hibernate.metamodel.model.domain.EntityDomainType, org.hibernate.spi.NavigablePath, org.hibernate.query.PathException, org.hibernate.query.criteria.JpaRoot, org.hibernate.query.sqm.NodeBuilder, .SemanticQueryWalker, .SqmPathSource, org.hibernate.query.sqm.tree.SqmCopyContext, .SqmJoinType, org.hibernate.query.sqm.tree.domain.AbstractSqmFrom, .SqmCorrelatedRoot, .SqmPath, .SqmTreatedRoot
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final boolean
allowJoins

private List<SqmJoin<?, ?>>
orderedJoins

Constructor Summary

AccessConstructor and Description
public
SqmRoot(EntityDomainType<E> entityType, String alias, boolean allowJoins, NodeBuilder nodeBuilder)

protected
SqmRoot(NavigablePath navigablePath, SqmPathSource<E> referencedNavigable, NodeBuilder nodeBuilder)

public
SqmRoot(NavigablePath navigablePath, EntityDomainType<E> entityType, String alias, NodeBuilder nodeBuilder)

protected
SqmRoot(NavigablePath navigablePath, SqmPathSource<E> referencedNavigable, String alias, boolean allowJoins, NodeBuilder nodeBuilder)

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
addOrderedJoin(SqmJoin<?, ?> join)

private void
addOrderedJoinTransitive(SqmJoin<?, ?> join)

public void
addSqmJoin(SqmJoin<E, ?> join)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmFrom.addSqmJoin.

Implements org.hibernate.query.sqm.tree.from.SqmFrom.addSqmJoin.

Add an associated join
public boolean
containsOnlyInnerJoins()

public SqmRoot<E>
copy(SqmCopyContext context)

Implements org.hibernate.query.sqm.tree.from.SqmFrom.copy, org.hibernate.query.sqm.tree.domain.SqmPath.copy, org.hibernate.query.sqm.tree.expression.SqmExpression.copy, org.hibernate.query.sqm.tree.select.SqmSelectableNode.copy, org.hibernate.query.sqm.tree.SqmNode.copy.

public void
copyTo(SqmRoot<E> target, SqmCopyContext context)

public SqmCorrelatedRoot<E>
createCorrelation()

Implements abstract org.hibernate.query.sqm.tree.domain.AbstractSqmFrom.createCorrelation.

public SqmRoot<?>
findRoot()

Overrides default org.hibernate.query.sqm.tree.domain.SqmPath.findRoot.

public String
getEntityName()

public SqmPath<?>
getLhs()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmPath.getLhs.

Implements org.hibernate.query.criteria.JpaPath.getLhs, org.hibernate.query.sqm.tree.domain.SqmPath.getLhs.

The source (think "left hand side") of this path
public EntityDomainType<E>
getManagedType()

Implements org.hibernate.query.criteria.JpaRoot.getManagedType.

public EntityDomainType<E>
getModel()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmPath.getModel.

Implements org.hibernate.query.criteria.JpaRoot.getModel, jakarta.persistence.criteria.Path.getModel.

Return the metamodel entity corresponding to the root.
public List<SqmJoin<?, ?>>
getOrderedJoins()

public boolean
isAllowJoins()

public String
toString()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmPath.toString.

Returns a string representation of the object.
public <S extends E> SqmTreatedRoot<E, S>
treatAs(Class<S> treatJavaType)

Implements org.hibernate.query.criteria.JpaPath.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.sqm.tree.domain.SqmPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.
public <S extends E> SqmTreatedRoot<E, S>
treatAs(EntityDomainType<S> treatTarget)

Implements org.hibernate.query.criteria.JpaPath.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.sqm.tree.domain.SqmPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.
public <S extends E> SqmFrom<?, S>
treatAs(Class<S> treatJavaType, String alias)

Implements org.hibernate.query.sqm.tree.from.SqmFrom.treatAs.

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

Implements org.hibernate.query.sqm.tree.from.SqmFrom.treatAs.

Inherited from org.hibernate.query.sqm.tree.domain.AbstractSqmFrom:
addTreataliasappendHqlStringcopyTocrossJoincrossJoinfetchfetchfetchfetchfetchfetchfindTreatgetCorrelationParentgetExplicitAliasgetFetchesgetJoinsgetParentPathgetSqmJoinsgetSqmTreatshasJoinshasTreatsisCorrelatedjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinCollectionjoinCollectionjoinLateraljoinLateraljoinListjoinListjoinMapjoinMapjoinSetjoinSetresolvePathPartsetExplicitAliasvisitSqmJoins

Field Detail

allowJoinsback to summary
private final boolean allowJoins
orderedJoinsback to summary
private List<SqmJoin<?, ?>> orderedJoins

Constructor Detail

SqmRootback to summary
public SqmRoot(EntityDomainType<E> entityType, String alias, boolean allowJoins, NodeBuilder nodeBuilder)
SqmRootback to summary
protected SqmRoot(NavigablePath navigablePath, SqmPathSource<E> referencedNavigable, NodeBuilder nodeBuilder)
SqmRootback to summary
public SqmRoot(NavigablePath navigablePath, EntityDomainType<E> entityType, String alias, NodeBuilder nodeBuilder)
SqmRootback to summary
protected SqmRoot(NavigablePath navigablePath, SqmPathSource<E> referencedNavigable, String alias, boolean allowJoins, NodeBuilder nodeBuilder)

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
addOrderedJoinback to summary
public void addOrderedJoin(SqmJoin<?, ?> join)
addOrderedJoinTransitiveback to summary
private void addOrderedJoinTransitive(SqmJoin<?, ?> join)
addSqmJoinback to summary
public void addSqmJoin(SqmJoin<E, ?> join)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmFrom.addSqmJoin.

Implements org.hibernate.query.sqm.tree.from.SqmFrom.addSqmJoin.

Doc from org.hibernate.query.sqm.tree.from.SqmFrom.addSqmJoin.

Add an associated join

Annotations
@Override
containsOnlyInnerJoinsback to summary
public boolean containsOnlyInnerJoins()
copyback to summary
public SqmRoot<E> copy(SqmCopyContext context)

Implements org.hibernate.query.sqm.tree.from.SqmFrom.copy, org.hibernate.query.sqm.tree.domain.SqmPath.copy, org.hibernate.query.sqm.tree.expression.SqmExpression.copy, org.hibernate.query.sqm.tree.select.SqmSelectableNode.copy, org.hibernate.query.sqm.tree.SqmNode.copy.

Annotations
@Override
copyToback to summary
public void copyTo(SqmRoot<E> target, SqmCopyContext context)
Annotations
@Internal
createCorrelationback to summary
public SqmCorrelatedRoot<E> createCorrelation()

Implements abstract org.hibernate.query.sqm.tree.domain.AbstractSqmFrom.createCorrelation.

Annotations
@Override
findRootback to summary
public SqmRoot<?> findRoot()

Overrides default org.hibernate.query.sqm.tree.domain.SqmPath.findRoot.

Annotations
@Override
getEntityNameback to summary
public String getEntityName()
getLhsback to summary
public SqmPath<?> getLhs()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmPath.getLhs.

Implements org.hibernate.query.criteria.JpaPath.getLhs, org.hibernate.query.sqm.tree.domain.SqmPath.getLhs.

Doc from org.hibernate.query.criteria.JpaPath.getLhs.

The source (think "left hand side") of this path

Annotations
@Override
getManagedTypeback to summary
public EntityDomainType<E> getManagedType()

Implements org.hibernate.query.criteria.JpaRoot.getManagedType.

Annotations
@Override
getModelback to summary
public EntityDomainType<E> getModel()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmPath.getModel.

Implements org.hibernate.query.criteria.JpaRoot.getModel, jakarta.persistence.criteria.Path.getModel.

Doc from jakarta.persistence.criteria.Root.getModel.

Return the metamodel entity corresponding to the root.

Returns:EntityDomainType<E>

metamodel entity corresponding to the root

Annotations
@Override
getOrderedJoinsback to summary
public List<SqmJoin<?, ?>> getOrderedJoins()
isAllowJoinsback to summary
public boolean isAllowJoins()
toStringback to summary
public String toString()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmPath.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
treatAsback to summary
public <S extends E> SqmTreatedRoot<E, S> treatAs(Class<S> treatJavaType) throws PathException

Implements org.hibernate.query.criteria.JpaPath.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.sqm.tree.domain.SqmPath.treatAs.

Doc from org.hibernate.query.criteria.JpaPath.treatAs.

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

Annotations
@Override
treatAsback to summary
public <S extends E> SqmTreatedRoot<E, S> treatAs(EntityDomainType<S> treatTarget) throws PathException

Implements org.hibernate.query.criteria.JpaPath.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.sqm.tree.domain.SqmPath.treatAs.

Doc from org.hibernate.query.criteria.JpaPath.treatAs.

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

Annotations
@Override
treatAsback to summary
public <S extends E> SqmFrom<?, S> treatAs(Class<S> treatJavaType, String alias)

Implements org.hibernate.query.sqm.tree.from.SqmFrom.treatAs.

Annotations
@Override
treatAsback to summary
public <S extends E> SqmFrom<?, S> treatAs(EntityDomainType<S> treatTarget, String alias)

Implements org.hibernate.query.sqm.tree.from.SqmFrom.treatAs.

Annotations
@Override