Package javax.persistence
Interface Subgraph<T>
-
- 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:
- 2.1
- See Also:
EntityGraph
,AttributeNode
,NamedSubgraph
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addAttributeNodes(java.lang.String... attributeName)
Add one or more attribute nodes to the entity graph.void
addAttributeNodes(Attribute<T,?>... attribute)
Add one or more attribute nodes to the entity graph.<X> Subgraph<X>
addKeySubgraph(java.lang.String attributeName)
Add a node to the graph that corresponds to a map key that is a managed type.<X> Subgraph<X>
addKeySubgraph(java.lang.String attributeName, java.lang.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>
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, java.lang.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>
addSubgraph(java.lang.String attributeName)
Add a node to the graph that corresponds to a managed type.<X> Subgraph<X>
addSubgraph(java.lang.String attributeName, java.lang.Class<X> type)
Add a node to the graph that corresponds to 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, java.lang.Class<? extends X> type)
Add a node to the graph that corresponds to a managed type with inheritance.java.util.List<AttributeNode<?>>
getAttributeNodes()
Return the attribute nodes corresponding to the attributes of this managed type that are included in the subgraph.java.lang.Class<T>
getClassType()
Return the type for which this subgraph was defined.
-
-
-
Method Detail
-
addAttributeNodes
void addAttributeNodes(java.lang.String... attributeName)
Add one or more attribute nodes to the entity graph.- Parameters:
attributeName
- name of the attribute- Throws:
java.lang.IllegalArgumentException
- if the attribute is not an attribute of this managed type.java.lang.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:
java.lang.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:
java.lang.IllegalArgumentException
- if the attribute's target type is not a managed typejava.lang.IllegalStateException
- if the EntityGraph has been statically defined
-
addSubgraph
<X> Subgraph<? extends X> addSubgraph(Attribute<T,X> attribute, java.lang.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:
java.lang.IllegalArgumentException
- if the attribute's target type is not a managed typejava.lang.IllegalStateException
- if this EntityGraph has been statically defined
-
addSubgraph
<X> Subgraph<X> addSubgraph(java.lang.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:
java.lang.IllegalArgumentException
- if the attribute is not an attribute of this managed type.java.lang.IllegalArgumentException
- if the attribute's target type is not a managed typejava.lang.IllegalStateException
- if this EntityGraph has been statically defined
-
addSubgraph
<X> Subgraph<X> addSubgraph(java.lang.String attributeName, java.lang.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:
java.lang.IllegalArgumentException
- if the attribute is not an attribute of this managed type.java.lang.IllegalArgumentException
- if the attribute's target type is not a managed typejava.lang.IllegalStateException
- 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:
java.lang.IllegalArgumentException
- if the attribute's target type is not a managed type entityjava.lang.IllegalStateException
- if this EntityGraph has been statically defined
-
addKeySubgraph
<X> Subgraph<? extends X> addKeySubgraph(Attribute<T,X> attribute, java.lang.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:
java.lang.IllegalArgumentException
- if the attribute's target type is not a managed type entityjava.lang.IllegalStateException
- if this EntityGraph has been statically defined
-
addKeySubgraph
<X> Subgraph<X> addKeySubgraph(java.lang.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:
java.lang.IllegalArgumentException
- if the attribute is not an attribute of this entity.java.lang.IllegalArgumentException
- if the attribute's target type is not a managed typejava.lang.IllegalStateException
- if this EntityGraph has been statically defined
-
addKeySubgraph
<X> Subgraph<X> addKeySubgraph(java.lang.String attributeName, java.lang.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:
java.lang.IllegalArgumentException
- if the attribute is not an attribute of this entity.java.lang.IllegalArgumentException
- if the attribute's target type is not a managed typejava.lang.IllegalStateException
- if this EntityGraph has been statically defined
-
getAttributeNodes
java.util.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
-
getClassType
java.lang.Class<T> getClassType()
Return the type for which this subgraph was defined.- Returns:
- managed type referenced by the subgraph
-
-