Package org.hibernate.query.criteria

Interface JpaCollectionJoin<O,T>

All Superinterfaces:

CollectionJoin<O,T>, Expression<T>, FetchParent<O,T>, From<O,T>, Join<O,T>, JpaCriteriaNode, JpaExpression<T>, JpaFetchParent<O,T>, JpaFrom<O,T>, JpaJoin<O,T>, JpaJoinedFrom<O,T>, JpaPath<T>, JpaPluralJoin<O,Collection<T>,T>, JpaSelection<T>, JpaTupleElement<T>, Path<T>, PluralJoin<O,Collection<T>,T>, Selection<T>, Serializable, TupleElement<T>

All Known Implementing Classes:

SqmBagJoin, SqmCorrelatedBagJoin, SqmTreatedBagJoin

public interface JpaCollectionJoin<O,T>
extends JpaPluralJoin<O,Collection<T>,T>, CollectionJoin<O,T>

Specialization of JpaJoin for Collection typed attribute joins

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method	Description
JpaCollectionJoin<O,T>	on(Expression<Boolean> restriction)	Modify the join to restrict the result according to the specified ON condition and return the join object.
JpaCollectionJoin<O,T>	on(Predicate... restrictions)	Modify the join to restrict the result according to the specified ON condition and return the join object.
JpaCollectionJoin<O,T>	on(JpaExpression<Boolean> restriction)
JpaCollectionJoin<O,T>	on(JpaPredicate... restrictions)
<S extends T> JpaCollectionJoin<O,S>	treatAs(Class<S> treatAsType)	Support for JPA's explicit (TREAT) down-casting.
<S extends T> JpaCollectionJoin<O,S>	treatAs(EntityDomainType<S> treatAsType)	Support for JPA's explicit (TREAT) down-casting.

Methods inherited from interface jakarta.persistence.criteria.CollectionJoin

getModel

Methods inherited from interface jakarta.persistence.criteria.From

getJoins, isCorrelated

Methods inherited from interface jakarta.persistence.criteria.Join

getJoinType, getOn, getParent

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

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

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

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

getOn

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

get, get, get, get, getLhs, getNavigablePath, getParentPath, type

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

getAttribute

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

alias, getCompoundSelectionItems, getSelectionItems

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

getJavaType, getJavaTypeDescriptor, getJavaTypeName, isEnum

Methods inherited from interface jakarta.persistence.criteria.Selection

isCompoundSelection

Methods inherited from interface jakarta.persistence.TupleElement

getAlias

Method Details

on

JpaCollectionJoin<O,T> on(JpaExpression<Boolean> restriction)

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface JpaJoinedFrom<O,T>

Specified by:

on in interface JpaPluralJoin<O,Collection<T>,T>

on

JpaCollectionJoin<O,T> on(Expression<Boolean> restriction)

Description copied from interface: Join

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.

Specified by:

on in interface CollectionJoin<O,T>

Specified by:

on in interface Join<O,T>

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface JpaJoinedFrom<O,T>

Specified by:

on in interface JpaPluralJoin<O,Collection<T>,T>

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified join object

on

JpaCollectionJoin<O,T> on(JpaPredicate... restrictions)

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface JpaJoinedFrom<O,T>

Specified by:

on in interface JpaPluralJoin<O,Collection<T>,T>

on

JpaCollectionJoin<O,T> on(Predicate... restrictions)

Description copied from interface: Join

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.

Specified by:

on in interface CollectionJoin<O,T>

Specified by:

on in interface Join<O,T>

Specified by:

on in interface JpaJoin<O,T>

Specified by:

on in interface JpaJoinedFrom<O,T>

Specified by:

on in interface JpaPluralJoin<O,Collection<T>,T>

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified join object

treatAs

<S extends T> JpaCollectionJoin<O,S> treatAs(Class<S> treatAsType)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaJoin<O,T>

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface JpaPluralJoin<O,Collection<T>,T>

treatAs

<S extends T> JpaCollectionJoin<O,S> treatAs(EntityDomainType<S> treatAsType)

Description copied from interface: JpaPath

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

Specified by:

treatAs in interface JpaJoin<O,T>

Specified by:

treatAs in interface JpaPath<O>

Specified by:

treatAs in interface JpaPluralJoin<O,Collection<T>,T>