javax.persistence.criteria
Interface From<Z,X>

Type Parameters:

Z -

X -

All Superinterfaces:

Expression<X>, FetchParent<Z,X>, Path<X>, Selection<X>, TupleElement<X>

All Known Subinterfaces:

CollectionJoin<Z,E>, Join<Z,X>, ListJoin<Z,E>, MapJoin<Z,K,V>, PluralJoin<Z,C,E>, Root<X>, SetJoin<Z,E>

public interface From<Z,X>
extends Path<X>, FetchParent<Z,X>

Represents a bound type, usually an entity that appears in the from clause, but may also be an embeddable belonging to an entity in the from clause. Serves as a factory for Joins of associations, embeddables and collections belonging to the type, and for Paths of attributes belonging to the type.

Since:

Java Persistence 2.0

Method Summary

java.util.Set<Join<X,?>>	getJoins() Return the joins that have been made from this type.
<Y> CollectionJoin<X,Y>	join(CollectionAttribute<? super X,Y> collection) Join to the specified Collection-valued attribute using an inner join.
<Y> CollectionJoin<X,Y>	join(CollectionAttribute<? super X,Y> collection, JoinType jt) Join to the specified Collection-valued attribute using the given join type.
<Y> ListJoin<X,Y>	join(ListAttribute<? super X,Y> list) Join to the specified List-valued attribute using an inner join.
<Y> ListJoin<X,Y>	join(ListAttribute<? super X,Y> list, JoinType jt) Join to the specified List-valued attribute using the given join type.
<K,V> MapJoin<X,K,V>	join(MapAttribute<? super X,K,V> map) Join to the specified Map-valued attribute using an inner join.
<K,V> MapJoin<X,K,V>	join(MapAttribute<? super X,K,V> map, JoinType jt) Join to the specified Map-valued attribute using the given join type.
<Y> SetJoin<X,Y>	join(SetAttribute<? super X,Y> set) Join to the specified Set-valued attribute using an inner join.
<Y> SetJoin<X,Y>	join(SetAttribute<? super X,Y> set, JoinType jt) Join to the specified Set-valued attribute using the given join type.
<Y> Join<X,Y>	join(SingularAttribute<? super X,Y> attribute) Join to the specified attribute using an inner join.
<Y> Join<X,Y>	join(SingularAttribute<? super X,Y> attribute, JoinType jt) Join to the specified attribute, using the given join type.
<Y> Join<X,Y>	join(java.lang.String attributeName) Join to the specified attribute using an inner join.
<Y> Join<X,Y>	join(java.lang.String attributeName, JoinType jt) Join to the specified attribute using the given join type.
<Y> CollectionJoin<X,Y>	joinCollection(java.lang.String attributeName) Join to the specified Collection-valued attribute using an inner join.
<Y> CollectionJoin<X,Y>	joinCollection(java.lang.String attributeName, JoinType jt) Join to the specified Collection-valued attribute using the given join type.
<Y> ListJoin<X,Y>	joinList(java.lang.String attributeName) Join to the specified List-valued attribute using an inner join.
<Y> ListJoin<X,Y>	joinList(java.lang.String attributeName, JoinType jt) Join to the specified List-valued attribute using the given join type.
<K,V> MapJoin<X,K,V>	joinMap(java.lang.String attributeName) Join to the specified Map-valued attribute using an inner join.
<K,V> MapJoin<X,K,V>	joinMap(java.lang.String attributeName, JoinType jt) Join to the specified Map-valued attribute using the given join type.
<Y> SetJoin<X,Y>	joinSet(java.lang.String attributeName) Join to the specified Set-valued attribute using an inner join.
<Y> SetJoin<X,Y>	joinSet(java.lang.String attributeName, JoinType jt) Join to the specified Set-valued attribute using the given join type.

Methods inherited from interface javax.persistence.criteria.Path

get, get, get, get, getModel, getParentPath, type

Methods inherited from interface javax.persistence.criteria.Expression

as, in, in, in, in, isNotNull, isNull

Methods inherited from interface javax.persistence.criteria.Selection

setAlias

Methods inherited from interface javax.persistence.TupleElement

getAlias, getJavaType

Methods inherited from interface javax.persistence.criteria.FetchParent

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

Method Detail

getJoins

java.util.Set<Join<X,?>> getJoins()

Return the joins that have been made from this type.

Returns:

joins made from this type

join

<Y> Join<X,Y> join(SingularAttribute<? super X,Y> attribute)

Join to the specified attribute using an inner join.

Parameters:

attribute - target of the join

Returns:

the resulting join

join

<Y> Join<X,Y> join(SingularAttribute<? super X,Y> attribute,
                   JoinType jt)

Join to the specified attribute, using the given join type.

Parameters:

attribute - target of the join

jt - join type

Returns:

the resulting join

join

<Y> CollectionJoin<X,Y> join(CollectionAttribute<? super X,Y> collection)

Join to the specified Collection-valued attribute using an inner join.

Parameters:

collection - target of the join

Returns:

the resulting join

join

<Y> SetJoin<X,Y> join(SetAttribute<? super X,Y> set)

Join to the specified Set-valued attribute using an inner join.

Parameters:

set - target of the join

Returns:

the resulting join

join

<Y> ListJoin<X,Y> join(ListAttribute<? super X,Y> list)

Join to the specified List-valued attribute using an inner join.

Parameters:

list - target of the join

Returns:

the resulting join

join

<K,V> MapJoin<X,K,V> join(MapAttribute<? super X,K,V> map)

Join to the specified Map-valued attribute using an inner join.

Parameters:

map - target of the join

Returns:

the resulting join

join

<Y> CollectionJoin<X,Y> join(CollectionAttribute<? super X,Y> collection,
                             JoinType jt)

Join to the specified Collection-valued attribute using the given join type.

Parameters:

collection - target of the join

jt - join type

Returns:

the resulting join

join

<Y> SetJoin<X,Y> join(SetAttribute<? super X,Y> set,
                      JoinType jt)

Join to the specified Set-valued attribute using the given join type.

Parameters:

set - target of the join

jt - join type

Returns:

the resulting join

join

<Y> ListJoin<X,Y> join(ListAttribute<? super X,Y> list,
                       JoinType jt)

Join to the specified List-valued attribute using the given join type.

Parameters:

list - target of the join

jt - join type

Returns:

the resulting join

join

<K,V> MapJoin<X,K,V> join(MapAttribute<? super X,K,V> map,
                          JoinType jt)

Join to the specified Map-valued attribute using the given join type.

Parameters:

map - target of the join

jt - join type

Returns:

the resulting join

join

<Y> Join<X,Y> join(java.lang.String attributeName)

Join to the specified attribute using an inner join.

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

joinCollection

<Y> CollectionJoin<X,Y> joinCollection(java.lang.String attributeName)

Join to the specified Collection-valued attribute using an inner join.

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

joinSet

<Y> SetJoin<X,Y> joinSet(java.lang.String attributeName)

Join to the specified Set-valued attribute using an inner join.

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

joinList

<Y> ListJoin<X,Y> joinList(java.lang.String attributeName)

Join to the specified List-valued attribute using an inner join.

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

joinMap

<K,V> MapJoin<X,K,V> joinMap(java.lang.String attributeName)

Join to the specified Map-valued attribute using an inner join.

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

join

<Y> Join<X,Y> join(java.lang.String attributeName,
                   JoinType jt)

Join to the specified attribute using the given join type.

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

joinCollection

<Y> CollectionJoin<X,Y> joinCollection(java.lang.String attributeName,
                                       JoinType jt)

Join to the specified Collection-valued attribute using the given join type.

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

joinSet

<Y> SetJoin<X,Y> joinSet(java.lang.String attributeName,
                         JoinType jt)

Join to the specified Set-valued attribute using the given join type.

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

joinList

<Y> ListJoin<X,Y> joinList(java.lang.String attributeName,
                           JoinType jt)

Join to the specified List-valued attribute using the given join type.

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

joinMap

<K,V> MapJoin<X,K,V> joinMap(java.lang.String attributeName,
                             JoinType jt)

Join to the specified Map-valued attribute using the given join type.

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join