EclipseLink JPA 4.0.2 · org.eclipse.persistence.internal.jpa.EntityGraphImpl

Modifier and Type	Field and Description
protected AttributeGroup	attributeGroup
protected Map<String, AttributeNodeImpl<X>>	attributeNodes
protected Class<X>	classType
protected transient ClassDescriptor	descriptor
protected transient boolean	isMutable

Access	Constructor and Description
protected	EntityGraphImpl(AttributeGroup group, ClassDescriptor descriptor)
public	EntityGraphImpl(AttributeGroup group)
protected	EntityGraphImpl(AttributeGroup group, ClassDescriptor descriptor, String attribute)

Method Summary

Modifier and Type	Method and Description
protected void	addAttributeNodeImpl(AttributeNodeImpl<X> attributeNode)
public void	addAttributeNodes(String... name of the attribute attributeNames) Implements jakarta.persistence.EntityGraph.addAttributeNodes, jakarta.persistence.Subgraph.addAttributeNodes. Add one or more attribute nodes to the entity graph.
public void	addAttributeNodes(Attribute<X, ?>... attribute attribute) Implements jakarta.persistence.EntityGraph.addAttributeNodes, jakarta.persistence.Subgraph.addAttributeNodes. Add one or more attribute nodes to the entity graph.
public <T> Subgraph<T>	addKeySubgraph(Attribute<X, T> attribute attribute) Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph. Add a node to the graph that corresponds to a map key that is a managed type.
public <T> Subgraph<? extends T>	addKeySubgraph(Attribute<X, T> attribute attribute, Class<? extends T> entity subclass type) Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph. Add a node to the graph that corresponds to a map key that is a managed type with inheritance.
public <X> Subgraph<X>	addKeySubgraph(String name of the attribute attributeName) Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph. Add a node to the graph that corresponds to a map key that is a managed type.
public <X> Subgraph<X>	addKeySubgraph(String name of the attribute attributeName, Class<X> entity subclass type) Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph. Add a node to the graph that corresponds to a map key that is a managed type with inheritance.
public <T> Subgraph<? extends T>	addSubclassSubgraph(Class<? extends T> entity subclass type) Implements jakarta.persistence.EntityGraph.addSubclassSubgraph. Add additional attributes to this entity graph that correspond to attributes of subclasses of this EntityGraph's entity type.
public <T> Subgraph<T>	addSubgraph(Attribute<X, T> attribute attribute) Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph. Add a node to the graph that corresponds to a managed type.
public <T> Subgraph<? extends T>	addSubgraph(Attribute<X, T> attribute attribute, Class<? extends T> entity subclass type) Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph. Add a node to the graph that corresponds to a managed type with inheritance.
public <X> Subgraph<X>	addSubgraph(String name of the attribute attributeName) Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph. Add a node to the graph that corresponds to a managed type.
public <X> Subgraph<X>	addSubgraph(String name of the attribute attributeName, Class<X> entity subclass type) Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph. Add a node to the graph that corresponds to a managed type with inheritance.
protected void	buildAttributeNodes()
public AttributeGroup	Returns: the attributeGroup getAttributeGroup()
public String	getAttributeName() Overrides org.eclipse.persistence.internal.jpa.AttributeNodeImpl.getAttributeName. Implements jakarta.persistence.AttributeNode.getAttributeName. Return the name of the attribute corresponding to the attribute node.
public List<AttributeNode<?>>	getAttributeNodes() Implements jakarta.persistence.EntityGraph.getAttributeNodes, jakarta.persistence.Subgraph.getAttributeNodes. Return the attribute nodes of this entity that are included in the entity graph.
public Class<X>	getClassType() Implements jakarta.persistence.Subgraph.getClassType. Return the type for which this subgraph was defined.
public String	getName() Implements jakarta.persistence.EntityGraph.getName. Return the name of a named EntityGraph (an entity graph defined by means of the `NamedEntityGraph` annotation, XML descriptor element, or added by means of the `addNamedEntityGraph` method.

Inherited from org.eclipse.persistence.internal.jpa.AttributeNodeImpl:: addKeySubgraph addSubgraph getKeySubgraphs getSubgraphs

attributeGroup	back to summary
protected AttributeGroup attributeGroup

attributeNodes	back to summary
protected Map<String, AttributeNodeImpl<X>> attributeNodes

classType	back to summary
protected Class<X> classType

descriptor	back to summary
protected transient ClassDescriptor descriptor

isMutable	back to summary
protected transient boolean isMutable

EntityGraphImpl	back to summary
protected EntityGraphImpl(AttributeGroup group, ClassDescriptor descriptor)

EntityGraphImpl	back to summary
public EntityGraphImpl(AttributeGroup group)

EntityGraphImpl	back to summary
protected EntityGraphImpl(AttributeGroup group, ClassDescriptor descriptor, String attribute)

Method Detail

addAttributeNodeImpl	back to summary
protected void addAttributeNodeImpl(AttributeNodeImpl<X> attributeNode)

addAttributeNodes	back to summary
public void addAttributeNodes(String... attributeNames) Implements jakarta.persistence.EntityGraph.addAttributeNodes, jakarta.persistence.Subgraph.addAttributeNodes. Doc from jakarta.persistence.EntityGraph.addAttributeNodes. Add one or more attribute nodes to the entity graph. Parameters attributeNames:String[] name of the attribute Annotations @Override

addAttributeNodes

back to summary

public void addAttributeNodes(String... attributeNames)

Implements jakarta.persistence.EntityGraph.addAttributeNodes, jakarta.persistence.Subgraph.addAttributeNodes.

Doc from jakarta.persistence.EntityGraph.addAttributeNodes.

Add one or more attribute nodes to the entity graph.

Parameters

attributeNames:String[]: name of the attribute

Annotations

@Override

addAttributeNodes	back to summary
public void addAttributeNodes(Attribute<X, ?>... attribute) Implements jakarta.persistence.EntityGraph.addAttributeNodes, jakarta.persistence.Subgraph.addAttributeNodes. Doc from jakarta.persistence.EntityGraph.addAttributeNodes. Add one or more attribute nodes to the entity graph. Parameters attribute:Attribute<X, ?>[] attribute Annotations @Override

addAttributeNodes

back to summary

public void addAttributeNodes(Attribute<X, ?>... attribute)

Implements jakarta.persistence.EntityGraph.addAttributeNodes, jakarta.persistence.Subgraph.addAttributeNodes.

Doc from jakarta.persistence.EntityGraph.addAttributeNodes.

Add one or more attribute nodes to the entity graph.

Parameters

attribute:Attribute<X, ?>[]: attribute

Annotations

@Override

addKeySubgraph	back to summary
public <T> Subgraph<T> addKeySubgraph(Attribute<X, T> attribute) Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph. Doc from jakarta.persistence.EntityGraph.addKeySubgraph. 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 attribute:Attribute<X, T> attribute Returns:Subgraph<T> subgraph for the key attribute Annotations @Override

addKeySubgraph

back to summary

public <T> Subgraph<T> addKeySubgraph(Attribute<X, T> attribute)

Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph.

Doc from jakarta.persistence.EntityGraph.addKeySubgraph.

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

attribute:Attribute<X, T>: attribute

Returns:Subgraph<T>

subgraph for the key attribute

Annotations

@Override

addKeySubgraph	back to summary
public <T> Subgraph<? extends T> addKeySubgraph(Attribute<X, T> attribute, Class<? extends T> type) Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph. Doc from jakarta.persistence.EntityGraph.addKeySubgraph. 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 attribute:Attribute<X, T> attribute type:Class<? extends T> entity subclass Returns:Subgraph<? extends T> subgraph for the key attribute Annotations @Override

addKeySubgraph

back to summary

public <T> Subgraph<? extends T> addKeySubgraph(Attribute<X, T> attribute, Class<? extends T> type)

Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph.

Doc from jakarta.persistence.EntityGraph.addKeySubgraph.

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

attribute:Attribute<X, T>: attribute
type:Class<? extends T>: entity subclass

Returns:Subgraph<? extends T>

subgraph for the key attribute

Annotations

@Override

addKeySubgraph	back to summary
public <X> Subgraph<X> addKeySubgraph(String attributeName) Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph. Doc from jakarta.persistence.EntityGraph.addKeySubgraph. 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:String name of the attribute Returns:Subgraph<X> subgraph for the key attribute Annotations @Override

addKeySubgraph

back to summary

public <X> Subgraph<X> addKeySubgraph(String attributeName)

Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph.

Doc from jakarta.persistence.EntityGraph.addKeySubgraph.

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:String: name of the attribute

Returns:Subgraph<X>

subgraph for the key attribute

Annotations

@Override

addKeySubgraph	back to summary
public <X> Subgraph<X> addKeySubgraph(String attributeName, Class<X> type) Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph. Doc from jakarta.persistence.EntityGraph.addKeySubgraph. 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 attributeName:String name of the attribute type:Class<X> entity subclass Returns:Subgraph<X> subgraph for the key attribute Annotations @Override

addKeySubgraph

back to summary

public <X> Subgraph<X> addKeySubgraph(String attributeName, Class<X> type)

Implements jakarta.persistence.EntityGraph.addKeySubgraph, jakarta.persistence.Subgraph.addKeySubgraph.

Doc from jakarta.persistence.EntityGraph.addKeySubgraph.

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

attributeName:String: name of the attribute
type:Class<X>: entity subclass

Returns:Subgraph<X>

subgraph for the key attribute

Annotations

@Override

addSubclassSubgraph	back to summary
public <T> Subgraph<? extends T> addSubclassSubgraph(Class<? extends T> type) Implements jakarta.persistence.EntityGraph.addSubclassSubgraph. Doc from jakarta.persistence.EntityGraph.addSubclassSubgraph. Add additional attributes to this entity graph that correspond to attributes of subclasses of this EntityGraph's entity type. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs. Parameters type:Class<? extends T> entity subclass Returns:Subgraph<? extends T> subgraph for the subclass Annotations @Override

addSubclassSubgraph

back to summary

public <T> Subgraph<? extends T> addSubclassSubgraph(Class<? extends T> type)

Implements jakarta.persistence.EntityGraph.addSubclassSubgraph.

Doc from jakarta.persistence.EntityGraph.addSubclassSubgraph.

Add additional attributes to this entity graph that correspond to attributes of subclasses of this EntityGraph's entity type. Subclass subgraphs will automatically include the specified attributes of superclass subgraphs.

Parameters

type:Class<? extends T>: entity subclass

Returns:Subgraph<? extends T>

subgraph for the subclass

Annotations

@Override

addSubgraph	back to summary
public <T> Subgraph<T> addSubgraph(Attribute<X, T> attribute) Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph. Doc from jakarta.persistence.EntityGraph.addSubgraph. 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<X, T> attribute Returns:Subgraph<T> subgraph for the attribute Annotations @Override

addSubgraph

back to summary

public <T> Subgraph<T> addSubgraph(Attribute<X, T> attribute)

Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph.

Doc from jakarta.persistence.EntityGraph.addSubgraph.

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<X, T>: attribute

Returns:Subgraph<T>

subgraph for the attribute

Annotations

@Override

addSubgraph	back to summary
public <T> Subgraph<? extends T> addSubgraph(Attribute<X, T> attribute, Class<? extends T> type) Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph. Doc from jakarta.persistence.EntityGraph.addSubgraph. 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:Attribute<X, T> attribute type:Class<? extends T> entity subclass Returns:Subgraph<? extends T> subgraph for the attribute Annotations @Override

addSubgraph

back to summary

public <T> Subgraph<? extends T> addSubgraph(Attribute<X, T> attribute, Class<? extends T> type)

Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph.

Doc from jakarta.persistence.EntityGraph.addSubgraph.

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:Attribute<X, T>: attribute
type:Class<? extends T>: entity subclass

Returns:Subgraph<? extends T>

subgraph for the attribute

Annotations

@Override

addSubgraph	back to summary
public <X> Subgraph<X> addSubgraph(String attributeName) Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph. Doc from jakarta.persistence.EntityGraph.addSubgraph. 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:String name of the attribute Returns:Subgraph<X> subgraph for the attribute Annotations @Override

addSubgraph

back to summary

public <X> Subgraph<X> addSubgraph(String attributeName)

Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph.

Doc from jakarta.persistence.EntityGraph.addSubgraph.

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:String: name of the attribute

Returns:Subgraph<X>

subgraph for the attribute

Annotations

@Override

addSubgraph	back to summary
public <X> Subgraph<X> addSubgraph(String attributeName, Class<X> type) Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph. Doc from jakarta.persistence.EntityGraph.addSubgraph. 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:String name of the attribute type:Class<X> entity subclass Returns:Subgraph<X> subgraph for the attribute Annotations @Override

addSubgraph

back to summary

public <X> Subgraph<X> addSubgraph(String attributeName, Class<X> type)

Implements jakarta.persistence.EntityGraph.addSubgraph, jakarta.persistence.Subgraph.addSubgraph.

Doc from jakarta.persistence.EntityGraph.addSubgraph.

Parameters

attributeName:String: name of the attribute
type:Class<X>: entity subclass

Returns:Subgraph<X>

subgraph for the attribute

Annotations

@Override

buildAttributeNodes	back to summary
protected void buildAttributeNodes()

getAttributeGroup	back to summary
public AttributeGroup getAttributeGroup() Returns:AttributeGroup the attributeGroup

getAttributeName	back to summary
public String getAttributeName() Overrides org.eclipse.persistence.internal.jpa.AttributeNodeImpl.getAttributeName. Implements jakarta.persistence.AttributeNode.getAttributeName. Doc from jakarta.persistence.AttributeNode.getAttributeName. Return the name of the attribute corresponding to the attribute node. Returns:String name of the attribute Annotations @Override

getAttributeName

back to summary

public String getAttributeName()

Overrides org.eclipse.persistence.internal.jpa.AttributeNodeImpl.getAttributeName.

Implements jakarta.persistence.AttributeNode.getAttributeName.

Doc from jakarta.persistence.AttributeNode.getAttributeName.

Return the name of the attribute corresponding to the attribute node.

Returns:String

name of the attribute

Annotations

@Override

getAttributeNodes	back to summary
public List<AttributeNode<?>> getAttributeNodes() Implements jakarta.persistence.EntityGraph.getAttributeNodes, jakarta.persistence.Subgraph.getAttributeNodes. Doc from jakarta.persistence.EntityGraph.getAttributeNodes. Return the attribute nodes of this entity that are included in the entity graph. Returns:List<AttributeNode<?>> attribute nodes for the annotated entity type or empty list if none have been defined Annotations @Override

getAttributeNodes

back to summary

public List<AttributeNode<?>> getAttributeNodes()

Implements jakarta.persistence.EntityGraph.getAttributeNodes, jakarta.persistence.Subgraph.getAttributeNodes.

Doc from jakarta.persistence.EntityGraph.getAttributeNodes.

Return the attribute nodes of this entity that are included in the entity graph.

Returns:List<AttributeNode<?>>

attribute nodes for the annotated entity type or empty list if none have been defined

Annotations

@Override

getClassType	back to summary
public Class<X> getClassType() Implements jakarta.persistence.Subgraph.getClassType. Doc from jakarta.persistence.Subgraph.getClassType. Return the type for which this subgraph was defined. Returns:Class<X> managed type referenced by the subgraph Annotations @Override

getClassType

back to summary

public Class<X> getClassType()

Implements jakarta.persistence.Subgraph.getClassType.

Doc from jakarta.persistence.Subgraph.getClassType.

Return the type for which this subgraph was defined.

Returns:Class<X>

managed type referenced by the subgraph

Annotations

@Override

getName back to summary

getName	back to summary
public String getName() Implements jakarta.persistence.EntityGraph.getName. Doc from jakarta.persistence.EntityGraph.getName. Return the name of a named EntityGraph (an entity graph defined by means of the `NamedEntityGraph` annotation, XML descriptor element, or added by means of the `addNamedEntityGraph` method. Returns null if the EntityGraph is not a named EntityGraph. Annotations @Override

public String getName()

Implements jakarta.persistence.EntityGraph.getName.

Doc from jakarta.persistence.EntityGraph.getName.

Return the name of a named EntityGraph (an entity graph defined by means of the NamedEntityGraph annotation, XML descriptor element, or added by means of the addNamedEntityGraph method. Returns null if the EntityGraph is not a named EntityGraph.

Annotations

@Override

public Class EntityGraphImpl<X>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail