Interface BlazeJoin<Z,X>
- Type Parameters:
Z
- the source type of the joinX
- the target type of the join
- All Superinterfaces:
BlazeExpression<X>
,BlazeFetchParent<Z,
,X> BlazeFrom<Z,
,X> BlazePath<X>
,Expression<X>
,Fetch<Z,
,X> FetchParent<Z,
,X> From<Z,
,X> Join<Z,
,X> Path<X>
,Selection<X>
,TupleElement<X>
- All Known Subinterfaces:
BlazeCollectionJoin<Z,
,E> BlazeListJoin<Z,
,E> BlazeMapJoin<Z,
,K, V> BlazeSetJoin<Z,
E>
An extended version of
Join
.- Since:
- 1.2.0
- Author:
- Christian Beikov
-
Method Summary
Modifier and TypeMethodDescriptionfetch()
Fetches this join.getOn()
Return the predicate that corresponds to the ON restriction(s) on the join, or null if no ON condition has been specified.boolean
isFetch()
Whether this join is marked to also be fetched.on
(Expression<Boolean> restriction) Modify the join to restrict the result according to the specified ON condition.Modify the join to restrict the result according to the specified ON condition.Treats this from object as the given subtype.Methods inherited from interface com.blazebit.persistence.criteria.BlazeExpression
as
Methods inherited from interface com.blazebit.persistence.criteria.BlazeFetchParent
fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetch, fetch
Methods inherited from interface com.blazebit.persistence.criteria.BlazeFrom
getBlazeJoins, getCorrelationParent, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinCollection, joinCollection, joinCollection, joinCollection, joinList, joinList, joinList, joinList, joinMap, joinMap, joinMap, joinMap, joinSet, joinSet, joinSet, joinSet
Methods inherited from interface com.blazebit.persistence.criteria.BlazePath
get, get, get, get, getParentPath, type
Methods inherited from interface javax.persistence.criteria.Expression
in, in, in, in, isNotNull, isNull
Methods inherited from interface javax.persistence.criteria.Fetch
getAttribute, getJoinType, getParent
Methods inherited from interface javax.persistence.criteria.FetchParent
getFetches
Methods inherited from interface javax.persistence.criteria.From
getJoins, isCorrelated
Methods inherited from interface javax.persistence.criteria.Join
getAttribute, getJoinType, getParent
Methods inherited from interface javax.persistence.criteria.Selection
alias, getCompoundSelectionItems, isCompoundSelection
Methods inherited from interface javax.persistence.TupleElement
getAlias, getJavaType
-
Method Details
-
treatAs
Treats this from object as the given subtype. This will not cause a treat join but return a wrapper, that can be used for further joins.- Type Parameters:
T
- The target treat type- Parameters:
type
- type to be downcast to- Returns:
- The treated join object
-
fetch
Fetches this join.- Returns:
- this join instance
-
isFetch
boolean isFetch()Whether this join is marked to also be fetched.- Returns:
- true if it should be fetched, false otherwise
-
on
Modify the join to restrict the result according to the specified ON condition. Replaces the previous ON condition, if any. Return the join object- Parameters:
restriction
- a simple or compound boolean expression- Returns:
- the modified join object
-
on
Modify the join to restrict the result according to the specified ON condition. Replaces the previous ON condition, if any. Return the join object- Parameters:
restrictions
- zero or more restriction predicates- Returns:
- the modified join object
-
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
-