javax.persistence.criteria

Interface Fetch<Z,X>

Type Parameters:

Z - the source type of the fetch

X - the target type of the fetch

All Superinterfaces:

FetchParent<Z,X>

public interface Fetch<Z,X>
extends FetchParent<Z,X>

Represents a join-fetched association or attribute.

Since:

Java Persistence 2.0

Method Summary

Methods

Modifier and Type	Method and Description
Attribute<? super Z,?>	getAttribute() Return the metamodel attribute corresponding to the fetch join.
JoinType	getJoinType() Return the join type used in the fetch join.
FetchParent<?,Z>	getParent() Return the parent of the fetched item.
Fetch<Z,X>	on(Expression<java.lang.Boolean> restriction) Modify the fetch join to restrict the result according to the specified ON condition.
Fetch<Z,X>	on(Predicate... restrictions) Modify the fetch join to restrict the result according to the specified ON condition.

Methods inherited from interface javax.persistence.criteria.FetchParent

fetch, fetch, fetch, fetch, fetch, fetch, getFetches

Method Detail

on

Fetch<Z,X> on(Expression<java.lang.Boolean> restriction)

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

Parameters:

restriction - a simple or compound boolean expression

Returns:

the modified fetch join object

on

Fetch<Z,X> on(Predicate... restrictions)

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

Parameters:

restrictions - zero or more restriction predicates

Returns:

the modified fetch join object

getAttribute

Attribute<? super Z,?> getAttribute()

Return the metamodel attribute corresponding to the fetch join.

Returns:

metamodel attribute for the join

getParent

FetchParent<?,Z> getParent()

Return the parent of the fetched item.

Returns:

fetch parent

getJoinType

JoinType getJoinType()

Return the join type used in the fetch join.

Returns:

join type