-
- Type Parameters:
Z
- the source typeX
- the target type
- 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
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description From<Z,X>
getCorrelationParent()
Returns the parentFrom
object from which the correlatedFrom
object has been obtained through correlation (use of aSubquery
correlate
method).Set<Join<X,?>>
getJoins()
Return the joins that have been made from this bound type.boolean
isCorrelated()
Whether theFrom
object has been obtained as a result of correlation (use of aSubquery
correlate
method).<Y> CollectionJoin<X,Y>
join(CollectionAttribute<? super X,Y> collection)
Create an inner join to the specified Collection-valued attribute.<Y> CollectionJoin<X,Y>
join(CollectionAttribute<? super X,Y> collection, JoinType jt)
Create a join to the specified Collection-valued attribute using the given join type.<Y> ListJoin<X,Y>
join(ListAttribute<? super X,Y> list)
Create an inner join to the specified List-valued attribute.<Y> ListJoin<X,Y>
join(ListAttribute<? super X,Y> list, JoinType jt)
Create a 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)
Create an inner join to the specified Map-valued attribute.<K,V> MapJoin<X,K,V>
join(MapAttribute<? super X,K,V> map, JoinType jt)
Create a join to the specified Map-valued attribute using the given join type.<Y> SetJoin<X,Y>
join(SetAttribute<? super X,Y> set)
Create an inner join to the specified Set-valued attribute.<Y> SetJoin<X,Y>
join(SetAttribute<? super X,Y> set, JoinType jt)
Create a join to the specified Set-valued attribute using the given join type.<Y> Join<X,Y>
join(SingularAttribute<? super X,Y> attribute)
Create an inner join to the specified single-valued attribute.<Y> Join<X,Y>
join(SingularAttribute<? super X,Y> attribute, JoinType jt)
Create a join to the specified single-valued attribute using the given join type.<X,Y> Join<X,Y>
join(String attributeName)
Create an inner join to the specified attribute.<X,Y> Join<X,Y>
join(String attributeName, JoinType jt)
Create a join to the specified attribute using the given join type.<X,Y> CollectionJoin<X,Y>
joinCollection(String attributeName)
Create an inner join to the specified Collection-valued attribute.<X,Y> CollectionJoin<X,Y>
joinCollection(String attributeName, JoinType jt)
Create a join to the specified Collection-valued attribute using the given join type.<X,Y> ListJoin<X,Y>
joinList(String attributeName)
Create an inner join to the specified List-valued attribute.<X,Y> ListJoin<X,Y>
joinList(String attributeName, JoinType jt)
Create a join to the specified List-valued attribute using the given join type.<X,K,V> MapJoin<X,K,V>
joinMap(String attributeName)
Create an inner join to the specified Map-valued attribute.<X,K,V> MapJoin<X,K,V>
joinMap(String attributeName, JoinType jt)
Create a join to the specified Map-valued attribute using the given join type.<X,Y> SetJoin<X,Y>
joinSet(String attributeName)
Create an inner join to the specified Set-valued attribute.<X,Y> SetJoin<X,Y>
joinSet(String attributeName, JoinType jt)
Create a 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
alias, getCompoundSelectionItems, isCompoundSelection
-
Methods inherited from interface javax.persistence.TupleElement
getAlias, getJavaType
-
-
-
-
Method Detail
-
getJoins
Set<Join<X,?>> getJoins()
Return the joins that have been made from this bound type. Returns empty set if no joins have been made from this bound type. Modifications to the set do not affect the query.- Returns:
- joins made from this type
-
isCorrelated
boolean isCorrelated()
Whether theFrom
object has been obtained as a result of correlation (use of aSubquery
correlate
method).- Returns:
- boolean indicating whether the object has been obtained through correlation
-
getCorrelationParent
From<Z,X> getCorrelationParent()
Returns the parentFrom
object from which the correlatedFrom
object has been obtained through correlation (use of aSubquery
correlate
method).- Returns:
- the parent of the correlated From object
- Throws:
IllegalStateException
- if the From object has not been obtained through correlation
-
join
<Y> Join<X,Y> join(SingularAttribute<? super X,Y> attribute)
Create an inner join to the specified single-valued attribute.- Parameters:
attribute
- target of the join- Returns:
- the resulting join
-
join
<Y> Join<X,Y> join(SingularAttribute<? super X,Y> attribute, JoinType jt)
Create a join to the specified single-valued attribute using the given join type.- Parameters:
attribute
- target of the joinjt
- join type- Returns:
- the resulting join
-
join
<Y> CollectionJoin<X,Y> join(CollectionAttribute<? super X,Y> collection)
Create an inner join to the specified Collection-valued attribute.- Parameters:
collection
- target of the join- Returns:
- the resulting join
-
join
<Y> SetJoin<X,Y> join(SetAttribute<? super X,Y> set)
Create an inner join to the specified Set-valued attribute.- Parameters:
set
- target of the join- Returns:
- the resulting join
-
join
<Y> ListJoin<X,Y> join(ListAttribute<? super X,Y> list)
Create an inner join to the specified List-valued attribute.- Parameters:
list
- target of the join- Returns:
- the resulting join
-
join
<K,V> MapJoin<X,K,V> join(MapAttribute<? super X,K,V> map)
Create an inner join to the specified Map-valued attribute.- Parameters:
map
- target of the join- Returns:
- the resulting join
-
join
<Y> CollectionJoin<X,Y> join(CollectionAttribute<? super X,Y> collection, JoinType jt)
Create a join to the specified Collection-valued attribute using the given join type.- Parameters:
collection
- target of the joinjt
- join type- Returns:
- the resulting join
-
join
<Y> SetJoin<X,Y> join(SetAttribute<? super X,Y> set, JoinType jt)
Create a join to the specified Set-valued attribute using the given join type.- Parameters:
set
- target of the joinjt
- join type- Returns:
- the resulting join
-
join
<Y> ListJoin<X,Y> join(ListAttribute<? super X,Y> list, JoinType jt)
Create a join to the specified List-valued attribute using the given join type.- Parameters:
list
- target of the joinjt
- join type- Returns:
- the resulting join
-
join
<K,V> MapJoin<X,K,V> join(MapAttribute<? super X,K,V> map, JoinType jt)
Create a join to the specified Map-valued attribute using the given join type.- Parameters:
map
- target of the joinjt
- join type- Returns:
- the resulting join
-
join
<X,Y> Join<X,Y> join(String attributeName)
Create an inner join to the specified attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinCollection
<X,Y> CollectionJoin<X,Y> joinCollection(String attributeName)
Create an inner join to the specified Collection-valued attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinSet
<X,Y> SetJoin<X,Y> joinSet(String attributeName)
Create an inner join to the specified Set-valued attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinList
<X,Y> ListJoin<X,Y> joinList(String attributeName)
Create an inner join to the specified List-valued attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinMap
<X,K,V> MapJoin<X,K,V> joinMap(String attributeName)
Create an inner join to the specified Map-valued attribute.- Parameters:
attributeName
- name of the attribute for the target of the join- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
join
<X,Y> Join<X,Y> join(String attributeName, JoinType jt)
Create a join to the specified attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinCollection
<X,Y> CollectionJoin<X,Y> joinCollection(String attributeName, JoinType jt)
Create a join to the specified Collection-valued attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinSet
<X,Y> SetJoin<X,Y> joinSet(String attributeName, JoinType jt)
Create a join to the specified Set-valued attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinList
<X,Y> ListJoin<X,Y> joinList(String attributeName, JoinType jt)
Create a join to the specified List-valued attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
joinMap
<X,K,V> MapJoin<X,K,V> joinMap(String attributeName, JoinType jt)
Create a join to the specified Map-valued attribute using the given join type.- Parameters:
attributeName
- name of the attribute for the target of the joinjt
- join type- Returns:
- the resulting join
- Throws:
IllegalArgumentException
- if attribute of the given name does not exist
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 23:09:17 Cette version de la page est en cache (à la date du 21/08/2025 23:09:17) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/persistence/criteria/From.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.