Java Persistence API 2.2 · javax.persistence.criteria.Join

Method Summary

Modifier and Type	Method and Description
public Attribute<? super Z, ?>	Returns: metamodel attribute corresponding to the join getAttribute() Return the metamodel attribute corresponding to the join.
public JoinType	Returns: join type getJoinType() Return the join type.
public Predicate	Returns: the ON restriction predicate getOn() Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified.
public From<?, Z>	Returns: join parent getParent() Return the parent of the join.
public Join<Z, X>	Returns: the modified join object on(Expression<Boolean> a simple or compound boolean expression restriction) Modify the join to restrict the result according to the specified ON condition and return the join object.
public Join<Z, X>	Returns: the modified join object on(Predicate... zero or more restriction predicates restrictions) Modify the join to restrict the result according to the specified ON condition and return the join object.

Method Detail

getAttribute	back to summary
public Attribute<? super Z, ?> getAttribute() Return the metamodel attribute corresponding to the join. Returns:Attribute<? super Z, ?> metamodel attribute corresponding to the join

getAttribute

back to summary

public Attribute<? super Z, ?> getAttribute()

Return the metamodel attribute corresponding to the join.

Returns:Attribute<? super Z, ?>: metamodel attribute corresponding to the join

getJoinType	back to summary
public JoinType getJoinType() Return the join type. Returns:JoinType join type

getJoinType

back to summary

public JoinType getJoinType()

Return the join type.

Returns:JoinType: join type

getOn	back to summary
public Predicate getOn() Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified. Returns:Predicate the ON restriction predicate Since Java Persistence 2.1

getOn

back to summary

public Predicate getOn()

Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified.

Returns:Predicate: the ON restriction predicate
Since: Java Persistence 2.1

getParent	back to summary
public From<?, Z> getParent() Return the parent of the join. Returns:From<?, Z> join parent

getParent

back to summary

public From<?, Z> getParent()

Return the parent of the join.

Returns:From<?, Z>: join parent

on	back to summary
public Join<Z, X> on(Expression<Boolean> restriction) 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:Join<Z, X> the modified join object Since Java Persistence 2.1

back to summary

public Join<Z, X> on(Expression<Boolean> restriction)

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:Join<Z, X>

the modified join object

Since

Java Persistence 2.1

on	back to summary
public Join<Z, X> on(Predicate... restrictions) 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:Join<Z, X> the modified join object Since Java Persistence 2.1

back to summary

public Join<Z, X> on(Predicate... restrictions)

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:Join<Z, X>

the modified join object

Since

Java Persistence 2.1

public Interface Join<Z, X>

Method Summary

Method Detail