Top Description Methods
org.hibernate.query.criteria

public Interface JpaJoin<O, T>

extends JpaJoinedFrom<O, T>, Join<O, T>
Known Direct Subinterfaces
org.hibernate.query.criteria.JpaPluralJoin, org.hibernate.query.sqm.tree.from.SqmAttributeJoin
Known Direct Implementers
org.hibernate.query.sqm.tree.domain.AbstractSqmPluralJoin
Imports
jakarta.persistence.criteria.Expression, .Fetch, .Join, .Predicate, org.hibernate.metamodel.model.domain.EntityDomainType, .PersistentAttribute
Consolidates the Join and Fetch hierarchies since that is how we implement them. This allows us to treat them polymorphically.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public PersistentAttribute<? super O, ?>
getAttribute()

Redeclares jakarta.persistence.criteria.Join.getAttribute.

Return the metamodel attribute corresponding to the join.
public JpaJoin<O, T>
on(JpaExpression<Boolean> restriction)

Redeclares org.hibernate.query.criteria.JpaJoinedFrom.on.

public JpaJoin<O, T>
on(Expression<Boolean>
a simple or compound boolean expression
restriction)

Redeclares org.hibernate.query.criteria.JpaJoinedFrom.on, jakarta.persistence.criteria.Join.on.

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

Redeclares org.hibernate.query.criteria.JpaJoinedFrom.on.

public JpaJoin<O, T>
on(Predicate...
zero or more restriction predicates
restrictions)

Redeclares org.hibernate.query.criteria.JpaJoinedFrom.on, jakarta.persistence.criteria.Join.on.

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

Redeclares org.hibernate.query.criteria.JpaPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.
public <S extends T> JpaJoin<O, S>
treatAs(EntityDomainType<S> treatAsType)

Redeclares org.hibernate.query.criteria.JpaPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.
Inherited from jakarta.persistence.criteria.Join:
getJoinTypegetOngetParent
Inherited from org.hibernate.query.criteria.JpaJoinedFrom:
getOn

Method Detail

getAttributeback to summary
public PersistentAttribute<? super O, ?> getAttribute()

Redeclares jakarta.persistence.criteria.Join.getAttribute.

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

Return the metamodel attribute corresponding to the join.

Returns:PersistentAttribute<? super O, ?>

metamodel attribute corresponding to the join

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

Redeclares org.hibernate.query.criteria.JpaJoinedFrom.on.

onback to summary
public JpaJoin<O, T> on(Expression<Boolean> restriction)

Redeclares org.hibernate.query.criteria.JpaJoinedFrom.on, jakarta.persistence.criteria.Join.on.

Doc from jakarta.persistence.criteria.Join.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:JpaJoin<O, T>

the modified join object

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

Redeclares org.hibernate.query.criteria.JpaJoinedFrom.on.

onback to summary
public JpaJoin<O, T> on(Predicate... restrictions)

Redeclares org.hibernate.query.criteria.JpaJoinedFrom.on, jakarta.persistence.criteria.Join.on.

Doc from jakarta.persistence.criteria.Join.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:JpaJoin<O, T>

the modified join object

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

Redeclares org.hibernate.query.criteria.JpaPath.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 T> JpaJoin<O, S> treatAs(EntityDomainType<S> treatAsType)

Redeclares org.hibernate.query.criteria.JpaPath.treatAs.

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

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

Annotations
@Override