org.hibernate.jpa.graph.internal

Class EntityGraphImpl<T>

java.lang.Object

org.hibernate.jpa.graph.internal.AbstractGraphNode<T>

org.hibernate.jpa.graph.internal.EntityGraphImpl<T>

All Implemented Interfaces:

EntityGraph<T>, EntityGraphImplementor<T>, GraphNodeImplementor, HibernateEntityManagerFactoryAware

public class EntityGraphImpl<T>
extends AbstractGraphNode<T>
implements EntityGraph<T>, EntityGraphImplementor<T>

The Hibernate implementation of the JPA EntityGraph contract.

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
EntityGraphImpl(String name, EntityType<T> entityType, SessionFactoryImplementor sessionFactory)

Method Summary

Modifier and Type	Method and Description
void	addAttributeNodes(Attribute<T,?>... attributes) Add one or more attribute nodes to the entity graph.
void	addAttributeNodes(String... attributeNames) Add one or more attribute nodes to the entity graph.
<X> SubgraphImpl<X>	addKeySubgraph(Attribute<T,X> attribute) Add a node to the graph that corresponds to a map key that is a managed type.
<X> SubgraphImpl<? 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> SubgraphImpl<X>	addKeySubgraph(String attributeName) Add a node to the graph that corresponds to a map key that is a managed type.
<X> SubgraphImpl<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<? extends X>	addSubclassSubgraph(Class<? extends X> type) Add additional attributes to this entity graph that correspond to attributes of subclasses of this EntityGraph's entity type.
<X> SubgraphImpl<X>	addSubgraph(Attribute<T,X> attribute) Add a node to the graph that corresponds to a managed type.
<X> SubgraphImpl<? 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> SubgraphImpl<X>	addSubgraph(String attributeName) Add a node to the graph that corresponds to a managed type.
<X> SubgraphImpl<X>	addSubgraph(String attributeName, Class<X> type) Add a node to the graph that corresponds to a managed type with inheritance.
boolean	appliesTo(EntityType<? super T> entityType)
boolean	appliesTo(String entityName)
List<AttributeNode<?>>	getAttributeNodes() Return the attribute nodes of this entity that are included in the entity graph.
EntityType<T>	getEntityType()
String	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.
EntityGraphImpl<T>	makeImmutableCopy(String name) Make an immutable copy of this entity graph, using the given name.
EntityGraphImpl<T>	makeMutableCopy() Make a mutable copy of this entity graph
protected Attribute<T,?>	resolveAttribute(String attributeName)

Methods inherited from class org.hibernate.jpa.graph.internal.AbstractGraphNode

addAttribute, addAttribute, addAttributeNode, attributeImplementorNodes, attributeNodes, buildAttributeNode, containsAttribute, getFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.graph.spi.GraphNodeImplementor

attributeImplementorNodes, attributeNodes, containsAttribute

Constructor Detail

EntityGraphImpl

public EntityGraphImpl(String name,
                       EntityType<T> entityType,
                       SessionFactoryImplementor sessionFactory)

Method Detail

makeImmutableCopy

public EntityGraphImpl<T> makeImmutableCopy(String name)

Description copied from interface: EntityGraphImplementor

Make an immutable copy of this entity graph, using the given name.

Specified by:

makeImmutableCopy in interface EntityGraphImplementor<T>

Parameters:

name - The name to apply to the immutable copy

Returns:

The immutable copy

makeMutableCopy

public EntityGraphImpl<T> makeMutableCopy()

Description copied from interface: EntityGraphImplementor

Make a mutable copy of this entity graph

Specified by:

makeMutableCopy in interface EntityGraphImplementor<T>

Returns:

The immutable copy

getEntityType

public EntityType<T> getEntityType()

getName

public String getName()

Description copied from interface: EntityGraph

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.

Specified by:

getName in interface EntityGraph<T>

addAttributeNodes

public void addAttributeNodes(String... attributeNames)

Description copied from interface: EntityGraph

Add one or more attribute nodes to the entity graph.

Specified by:

addAttributeNodes in interface EntityGraph<T>

Overrides:

addAttributeNodes in class AbstractGraphNode<T>

Parameters:

attributeNames - name of the attribute

addAttributeNodes

@SafeVarargs
public final void addAttributeNodes(Attribute<T,?>... attributes)

Description copied from interface: EntityGraph

Add one or more attribute nodes to the entity graph.

Specified by:

addAttributeNodes in interface EntityGraph<T>

Overrides:

addAttributeNodes in class AbstractGraphNode<T>

Parameters:

attributes - attribute

addSubgraph

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

Description copied from interface: EntityGraph

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.

Specified by:

addSubgraph in interface EntityGraph<T>

Overrides:

addSubgraph in class AbstractGraphNode<T>

Parameters:

attribute - attribute

Returns:

subgraph for the attribute

addSubgraph

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

Description copied from interface: EntityGraph

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.

Specified by:

addSubgraph in interface EntityGraph<T>

Overrides:

addSubgraph in class AbstractGraphNode<T>

Parameters:

attribute - attribute

type - entity subclass

Returns:

subgraph for the attribute

addSubgraph

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

Description copied from interface: EntityGraph

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.

Specified by:

addSubgraph in interface EntityGraph<T>

Overrides:

addSubgraph in class AbstractGraphNode<T>

Parameters:

attributeName - name of the attribute

Returns:

subgraph for the attribute

addSubgraph

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

Description copied from interface: EntityGraph

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.

Specified by:

addSubgraph in interface EntityGraph<T>

Overrides:

addSubgraph in class AbstractGraphNode<T>

Parameters:

attributeName - name of the attribute

type - entity subclass

Returns:

subgraph for the attribute

addKeySubgraph

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

Description copied from interface: EntityGraph

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.

Specified by:

addKeySubgraph in interface EntityGraph<T>

Overrides:

addKeySubgraph in class AbstractGraphNode<T>

Parameters:

attribute - attribute

Returns:

subgraph for the key attribute

addKeySubgraph

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

Description copied from interface: EntityGraph

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.

Specified by:

addKeySubgraph in interface EntityGraph<T>

Overrides:

addKeySubgraph in class AbstractGraphNode<T>

Parameters:

attribute - attribute

type - entity subclass

Returns:

subgraph for the key attribute

addKeySubgraph

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

Description copied from interface: EntityGraph

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.

Specified by:

addKeySubgraph in interface EntityGraph<T>

Overrides:

addKeySubgraph in class AbstractGraphNode<T>

Parameters:

attributeName - name of the attribute

Returns:

subgraph for the key attribute

addKeySubgraph

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

Description copied from interface: EntityGraph

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

Specified by:

addKeySubgraph in interface EntityGraph<T>

Overrides:

addKeySubgraph in class AbstractGraphNode<T>

Parameters:

attributeName - name of the attribute

type - entity subclass

Returns:

subgraph for the key attribute

addSubclassSubgraph

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

Description copied from interface: EntityGraph

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.

Specified by:

addSubclassSubgraph in interface EntityGraph<T>

Parameters:

type - entity subclass

Returns:

subgraph for the subclass

getAttributeNodes

public List<AttributeNode<?>> getAttributeNodes()

Description copied from interface: EntityGraph

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

Specified by:

getAttributeNodes in interface EntityGraph<T>

Returns:

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

resolveAttribute

protected Attribute<T,?> resolveAttribute(String attributeName)

Specified by:

resolveAttribute in class AbstractGraphNode<T>

appliesTo

public boolean appliesTo(String entityName)

Specified by:

appliesTo in interface EntityGraphImplementor<T>

appliesTo

public boolean appliesTo(EntityType<? super T> entityType)

Specified by:

appliesTo in interface EntityGraphImplementor<T>