Package javax.persistence.criteria
Interface Join<Z,X>
- Type Parameters:
Z
- the source type of the joinX
- the target type of the join
- All Superinterfaces:
Expression<X>
,FetchParent<Z,
,X> From<Z,
,X> Path<X>
,Selection<X>
,TupleElement<X>
- All Known Subinterfaces:
CollectionJoin<Z,
,E> ListJoin<Z,
,E> MapJoin<Z,
,K, V> PluralJoin<Z,
,C, E> SetJoin<Z,
E>
A join to an entity, embeddable, or basic type.
- Since:
- Java Persistence 2.0
-
Method Summary
Modifier and TypeMethodDescriptionReturn the metamodel attribute corresponding to the join.Return the join type.getOn()
Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified.Return the parent of the join.on
(Expression<Boolean> restriction) Modify the join to restrict the result according to the specified ON condition and return the join object.Modify the join to restrict the result according to the specified ON condition and return the join object.Methods inherited from interface javax.persistence.criteria.Expression
as, in, in, in, in, isNotNull, isNull
Methods inherited from interface javax.persistence.criteria.FetchParent
fetch, fetch, fetch, fetch, fetch, fetch, getFetches
Methods inherited from interface javax.persistence.criteria.From
getCorrelationParent, getJoins, isCorrelated, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet
Methods inherited from interface javax.persistence.criteria.Path
get, get, get, get, getModel, getParentPath, type
Methods inherited from interface javax.persistence.criteria.Selection
alias, getCompoundSelectionItems, isCompoundSelection
Methods inherited from interface javax.persistence.TupleElement
getAlias, getJavaType
-
Method Details
-
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
- a simple or compound boolean expression- Returns:
- the modified join object
- Since:
- Java Persistence 2.1
-
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
- zero or more restriction predicates- Returns:
- the modified join object
- Since:
- Java Persistence 2.1
-
getOn
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:
- the ON restriction predicate
- Since:
- Java Persistence 2.1
-
getAttribute
Return the metamodel attribute corresponding to the join.- Returns:
- metamodel attribute corresponding to the join
-
getParent
Return the parent of the join.- Returns:
- join parent
-
getJoinType
JoinType getJoinType()Return the join type.- Returns:
- join type
-