Top Constructors Methods
org.hibernate.query.sqm.tree.domain

public Class SqmListJoin<O, E>

extends AbstractSqmPluralJoin<O, List<E>, E>
implements JpaListJoin<O, E>
Class Inheritance
All Implemented Interfaces
org.hibernate.query.criteria.JpaListJoin, jakarta.persistence.criteria.ListJoin, jakarta.persistence.criteria.PluralJoin, jakarta.persistence.criteria.Join, 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.JpaPluralJoin, org.hibernate.query.criteria.JpaJoin, org.hibernate.query.criteria.JpaJoinedFrom, 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.SqmTreatedListJoin, org.hibernate.query.sqm.tree.domain.SqmCorrelatedListJoin
Imports
java.util.List, org.hibernate.metamodel.model.domain.EntityDomainType, .ListPersistentAttribute, org.hibernate.query.sqm.SemanticQueryWalker, .NodeBuilder, .SqmPathSource, org.hibernate.spi.NavigablePath, org.hibernate.query.criteria.JpaExpression, .JpaListJoin, .JpaPredicate, org.hibernate.query.hql.spi.SqmCreationProcessingState, org.hibernate.query.sqm.tree.SqmCopyContext, .SqmJoinType, org.hibernate.query.sqm.tree.from.SqmAttributeJoin, .SqmFrom, jakarta.persistence.criteria.Expression, .Predicate
Author
Steve Ebersole

Constructor Summary

AccessConstructor and Description
public
SqmListJoin(SqmFrom<?, O> lhs, ListPersistentAttribute<O, E> listAttribute, String alias, SqmJoinType sqmJoinType, boolean fetched, NodeBuilder nodeBuilder)

protected
SqmListJoin(SqmFrom<?, O> lhs, NavigablePath navigablePath, ListPersistentAttribute<O, E> listAttribute, String alias, SqmJoinType joinType, boolean fetched, NodeBuilder nodeBuilder)

Method Summary

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

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.accept.

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

Accept the walker per visitation
public SqmListJoin<O, E>
copy(SqmCopyContext context)

Implements org.hibernate.query.sqm.tree.from.SqmJoin.copy, 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 SqmCorrelatedListJoin<O, E>
createCorrelation()

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

public ListPersistentAttribute<O, E>
getAttribute()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.getAttribute.

Implements org.hibernate.query.criteria.JpaPluralJoin.getAttribute, jakarta.persistence.criteria.Join.getAttribute, org.hibernate.query.criteria.JpaJoin.getAttribute, jakarta.persistence.criteria.Fetch.getAttribute.

Return the metamodel attribute corresponding to the join.
public ListPersistentAttribute<O, E>
getModel()

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

Implements jakarta.persistence.criteria.Path.getModel, jakarta.persistence.criteria.PluralJoin.getModel, jakarta.persistence.criteria.ListJoin.getModel.

Return the metamodel representation for the list attribute.
public SqmPath<Integer>
index()

Implements jakarta.persistence.criteria.ListJoin.index.

Create an expression that corresponds to the index of the object in the referenced association or element collection.
public SqmAttributeJoin<O, E>
makeCopy(SqmCreationProcessingState creationProcessingState)

Implements org.hibernate.query.sqm.tree.from.SqmAttributeJoin.makeCopy.

public SqmListJoin<O, E>
on(JpaExpression<Boolean> restriction)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.on.

Implements org.hibernate.query.criteria.JpaListJoin.on, org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaFetch.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Add a restriction to the fetch.
public SqmListJoin<O, E>
on(Expression<Boolean>
a simple or compound boolean expression
restriction)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.on.

Implements org.hibernate.query.criteria.JpaListJoin.on, org.hibernate.query.criteria.JpaJoin.on, jakarta.persistence.criteria.Join.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.
public SqmListJoin<O, E>
on(JpaPredicate... restrictions)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.on.

Implements org.hibernate.query.criteria.JpaListJoin.on, org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaFetch.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Add a restriction to the fetch.
public SqmListJoin<O, E>
on(Predicate...
zero or more restriction predicates
restrictions)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.on.

Implements org.hibernate.query.criteria.JpaListJoin.on, org.hibernate.query.criteria.JpaJoin.on, jakarta.persistence.criteria.Join.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Modify the join to restrict the result according to the specified ON condition and return the join object.
public <S extends E> SqmTreatedListJoin<O, E, S>
treatAs(Class<S> treatAsType)

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

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

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

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

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

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

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

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

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

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

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

Constructor Detail

SqmListJoinback to summary
public SqmListJoin(SqmFrom<?, O> lhs, ListPersistentAttribute<O, E> listAttribute, String alias, SqmJoinType sqmJoinType, boolean fetched, NodeBuilder nodeBuilder)
SqmListJoinback to summary
protected SqmListJoin(SqmFrom<?, O> lhs, NavigablePath navigablePath, ListPersistentAttribute<O, E> listAttribute, String alias, SqmJoinType joinType, boolean fetched, NodeBuilder nodeBuilder)

Method Detail

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

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.accept.

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

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

Accept the walker per visitation

Annotations
@Override
copyback to summary
public SqmListJoin<O, E> copy(SqmCopyContext context)

Implements org.hibernate.query.sqm.tree.from.SqmJoin.copy, 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
createCorrelationback to summary
public SqmCorrelatedListJoin<O, E> createCorrelation()

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

Annotations
@Override
getAttributeback to summary
public ListPersistentAttribute<O, E> getAttribute()

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.getAttribute.

Implements org.hibernate.query.criteria.JpaPluralJoin.getAttribute, jakarta.persistence.criteria.Join.getAttribute, org.hibernate.query.criteria.JpaJoin.getAttribute, jakarta.persistence.criteria.Fetch.getAttribute.

Doc from jakarta.persistence.criteria.Join.getAttribute.

Return the metamodel attribute corresponding to the join.

Returns:ListPersistentAttribute<O, E>

metamodel attribute corresponding to the join

Annotations
@Override
getModelback to summary
public ListPersistentAttribute<O, E> getModel()

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

Implements jakarta.persistence.criteria.Path.getModel, jakarta.persistence.criteria.PluralJoin.getModel, jakarta.persistence.criteria.ListJoin.getModel.

Doc from jakarta.persistence.criteria.ListJoin.getModel.

Return the metamodel representation for the list attribute.

Returns:ListPersistentAttribute<O, E>

metamodel type representing the List that is the target of the join

Annotations
@Override
indexback to summary
public SqmPath<Integer> index()

Implements jakarta.persistence.criteria.ListJoin.index.

Doc from jakarta.persistence.criteria.ListJoin.index.

Create an expression that corresponds to the index of the object in the referenced association or element collection. This method must only be invoked upon an object that represents an association or element collection for which an order column has been defined.

Returns:SqmPath<Integer>

expression denoting the index

Annotations
@Override
makeCopyback to summary
public SqmAttributeJoin<O, E> makeCopy(SqmCreationProcessingState creationProcessingState)

Implements org.hibernate.query.sqm.tree.from.SqmAttributeJoin.makeCopy.

Annotations
@Override
onback to summary
public SqmListJoin<O, E> on(JpaExpression<Boolean> restriction)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.on.

Implements org.hibernate.query.criteria.JpaListJoin.on, org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaFetch.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Doc from org.hibernate.query.criteria.JpaFetch.on.

Add a restriction to the fetch.

Annotations
@Override
onback to summary
public SqmListJoin<O, E> on(Expression<Boolean> restriction)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.on.

Implements org.hibernate.query.criteria.JpaListJoin.on, org.hibernate.query.criteria.JpaJoin.on, jakarta.persistence.criteria.Join.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Doc from jakarta.persistence.criteria.ListJoin.on.

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Parameters
restriction:Expression<Boolean>

a simple or compound boolean expression

Returns:SqmListJoin<O, E>

the modified join object

Annotations
@Override
onback to summary
public SqmListJoin<O, E> on(JpaPredicate... restrictions)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.on.

Implements org.hibernate.query.criteria.JpaListJoin.on, org.hibernate.query.criteria.JpaJoin.on, org.hibernate.query.criteria.JpaFetch.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Doc from org.hibernate.query.criteria.JpaFetch.on.

Add a restriction to the fetch.

Annotations
@Override
onback to summary
public SqmListJoin<O, E> on(Predicate... restrictions)

Overrides org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin.on.

Implements org.hibernate.query.criteria.JpaListJoin.on, org.hibernate.query.criteria.JpaJoin.on, jakarta.persistence.criteria.Join.on, org.hibernate.query.criteria.JpaJoinedFrom.on.

Doc from jakarta.persistence.criteria.ListJoin.on.

Modify the join to restrict the result according to the specified ON condition and return the join object. Replaces the previous ON condition, if any.

Parameters
restrictions:Predicate[]

zero or more restriction predicates

Returns:SqmListJoin<O, E>

the modified join object

Annotations
@Override
treatAsback to summary
public <S extends E> SqmTreatedListJoin<O, E, S> treatAs(Class<S> treatAsType)

Implements org.hibernate.query.criteria.JpaListJoin.treatAs, org.hibernate.query.criteria.JpaJoin.treatAs, org.hibernate.query.sqm.tree.from.SqmAttributeJoin.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.criteria.JpaPath.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> SqmTreatedListJoin<O, E, S> treatAs(EntityDomainType<S> treatTarget)

Implements org.hibernate.query.criteria.JpaListJoin.treatAs, org.hibernate.query.criteria.JpaJoin.treatAs, org.hibernate.query.sqm.tree.from.SqmAttributeJoin.treatAs, org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.criteria.JpaPath.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> SqmTreatedListJoin<O, E, S> treatAs(Class<S> treatJavaType, String alias)

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

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

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

Annotations
@Override
treatAsback to summary
public <S extends E> SqmTreatedListJoin<O, E, S> treatAs(Class<S> treatJavaType, String alias, boolean fetch)

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

Annotations
@Override
treatAsback to summary
public <S extends E> SqmTreatedListJoin<O, E, S> treatAs(EntityDomainType<S> treatTarget, String alias, boolean fetch)

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

Annotations
@Override