-
- Type Parameters:
T
- The type of the attribute.
public interface Subgraph<T>
This type represents a subgraph for an attribute node that corresponds to a Managed Type. Using this class, an entity subgraph can be embedded within an EntityGraph.- Since:
- Java Persistence 2.1
- See Also:
EntityGraph
,AttributeNode
,NamedSubgraph
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
addAttributeNodes(Attribute<T,?>... attribute)
Add one or more attribute nodes to the entity graph.void
addAttributeNodes(String... attributeName)
Add one or more attribute nodes to the entity graph.<X> Subgraph<X>
addKeySubgraph(Attribute<T,X> attribute)
Add a node to the graph that corresponds to a map key that is a managed type.<X> Subgraph<? extends X>
addKeySubgraph(Attribute<T,X> attribute, Class<? extends X> type)
Add a node to the graph that corresponds to a map key that is a managed type with inheritance.<X> Subgraph<X>
addKeySubgraph(String attributeName)
Add a node to the graph that corresponds to a map key that is a managed type.<X> Subgraph<X>
addKeySubgraph(String attributeName, Class<X> type)
Add a node to the graph that corresponds to a map key that is a managed type with inheritance.<X> Subgraph<X>
addSubgraph(Attribute<T,X> attribute)
Add a node to the graph that corresponds to a managed type.<X> Subgraph<? extends X>
addSubgraph(Attribute<T,X> attribute, Class<? extends X> type)
Add a node to the graph that corresponds to a managed type with inheritance.<X> Subgraph<X>
addSubgraph(String attributeName)
Add a node to the graph that corresponds to a managed type.<X> Subgraph<X>
addSubgraph(String attributeName, Class<X> type)
Add a node to the graph that corresponds to a managed type with inheritance.List<AttributeNode<?>>
getAttributeNodes()
Return the attribute nodes corresponding to the attributes of this managed type that are included in the subgraph.Class<T>
getClassType()
Return the type for which this subgraph was defined.
-
-
-
Method Detail
-
addAttributeNodes
void addAttributeNodes(String... attributeName)
Add one or more attribute nodes to the entity graph.- Parameters:
attributeName
- name of the attribute- Throws:
IllegalArgumentException
- if the attribute is not an attribute of this managed type.IllegalStateException
- if the EntityGraph has been statically defined
-
addAttributeNodes
void addAttributeNodes(Attribute<T,?>... attribute)
Add one or more attribute nodes to the entity graph.- Parameters:
attribute
- attribute- Throws:
IllegalStateException
- if this EntityGraph has been statically defined
-
addSubgraph
<X> Subgraph<X> addSubgraph(Attribute<T,X> attribute)
Add a node to the graph that corresponds to a managed type. This allows for construction of multi-node entity graphs that include related managed types.- Parameters:
attribute
- attribute- Returns:
- subgraph for the attribute
- Throws:
IllegalArgumentException
- if the attribute's target type is not a managed typeIllegalStateException
- if the EntityGraph has been statically defined
-
addSubgraph
<X> Subgraph<? extends X> addSubgraph(Attribute<T,X> attribute, Class<? extends X> type)
Add a node to the graph that corresponds to a managed type with inheritance. This allows for multiple subclass subgraphs to be defined for this node of the entity graph. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs- Parameters:
attribute
- attributetype
- entity subclass- Returns:
- subgraph for the attribute
- Throws:
IllegalArgumentException
- if the attribute's target type is not a managed typeIllegalStateException
- if this EntityGraph has been statically defined
-
addSubgraph
<X> Subgraph<X> addSubgraph(String attributeName)
Add a node to the graph that corresponds to a managed type. This allows for construction of multi-node entity graphs that include related managed types.- Parameters:
attributeName
- name of the attribute- Returns:
- subgraph for the attribute
- Throws:
IllegalArgumentException
- if the attribute is not an attribute of this managed type.IllegalArgumentException
- if the attribute's target type is not a managed typeIllegalStateException
- if this EntityGraph has been statically defined
-
addSubgraph
<X> Subgraph<X> addSubgraph(String attributeName, Class<X> type)
Add a node to the graph that corresponds to a managed type with inheritance. This allows for multiple subclass subgraphs to be defined for this node of the entity graph. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs- Parameters:
attributeName
- name of the attributetype
- entity subclass- Returns:
- subgraph for the attribute
- Throws:
IllegalArgumentException
- if the attribute is not an attribute of this managed type.IllegalArgumentException
- if the attribute's target type is not a managed typeIllegalStateException
- if this EntityGraph has been statically defined
-
addKeySubgraph
<X> Subgraph<X> addKeySubgraph(Attribute<T,X> attribute)
Add a node to the graph that corresponds to a map key that is a managed type. This allows for construction of multinode entity graphs that include related managed types.- Parameters:
attribute
- attribute- Returns:
- subgraph for the key attribute
- Throws:
IllegalArgumentException
- if the attribute's target type is not a managed type entityIllegalStateException
- if this EntityGraph has been statically defined
-
addKeySubgraph
<X> Subgraph<? extends X> addKeySubgraph(Attribute<T,X> attribute, Class<? extends X> type)
Add a node to the graph that corresponds to a map key that is a managed type with inheritance. This allows for construction of multi-node entity graphs that include related managed types. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs- Parameters:
attribute
- attributetype
- entity subclass- Returns:
- subgraph for the attribute
- Throws:
IllegalArgumentException
- if the attribute's target type is not a managed type entityIllegalStateException
- if this EntityGraph has been statically defined
-
addKeySubgraph
<X> Subgraph<X> addKeySubgraph(String attributeName)
Add a node to the graph that corresponds to a map key that is a managed type. This allows for construction of multi-node entity graphs that include related managed types.- Parameters:
attributeName
- name of the attribute- Returns:
- subgraph for the key attribute
- Throws:
IllegalArgumentException
- if the attribute is not an attribute of this entity.IllegalArgumentException
- if the attribute's target type is not a managed typeIllegalStateException
- if this EntityGraph has been statically defined
-
addKeySubgraph
<X> Subgraph<X> addKeySubgraph(String attributeName, Class<X> type)
Add a node to the graph that corresponds to a map key that is a managed type with inheritance. This allows for construction of multi-node entity graphs that include related managed types. Subclass subgraphs will include the specified attributes of superclass subgraphs- Parameters:
attributeName
- name of the attributetype
- entity subclass- Returns:
- subgraph for the attribute
- Throws:
IllegalArgumentException
- if the attribute is not an attribute of this entity.IllegalArgumentException
- if the attribute's target type is not a managed typeIllegalStateException
- if this EntityGraph has been statically defined
-
getAttributeNodes
List<AttributeNode<?>> getAttributeNodes()
Return the attribute nodes corresponding to the attributes of this managed type that are included in the subgraph.- Returns:
- list of attribute nodes included in the subgraph or empty List if none have been defined
-
-
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 18:32:20 Cette version de la page est en cache (à la date du 21/08/2025 18:32:20) 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/Subgraph.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.