Hibernate ORM - hibernate-core 6.4.4.Final · org.hibernate.graph.Graph

Method Summary

Modifier and Type	Method and Description
public <AJ> AttributeNode<AJ>	addAttributeNode(String attributeName) Add an `AttributeNode` (with no associated `SubGraph`) to this container by attribute name.
public <AJ> AttributeNode<AJ>	addAttributeNode(PersistentAttribute<? extends J, AJ> attribute) Add an `AttributeNode` (with no associated `SubGraph`) to this container by attribute reference.
public <AJ> SubGraph<AJ>	addKeySubGraph(String attributeName)
public <AJ> SubGraph<AJ>	addKeySubGraph(String attributeName, Class<AJ> type)
public <AJ> SubGraph<AJ>	addKeySubGraph(PersistentAttribute<? extends J, AJ> attribute)
public <AJ> SubGraph<? extends AJ>	addKeySubGraph(PersistentAttribute<? extends J, AJ> attribute, Class<? extends AJ> type)
public default <AJ> SubGraph<AJ>	addPluralSubgraph(PluralAttribute<? extends J, ?, AJ> attribute) Add a subgraph rooted at a plural attribute, allowing further nodes to be added to the subgraph.
public <AJ> SubGraph<AJ>	addSubGraph(String attributeName) Create and return a new (mutable) `SubGraph` associated with the named `AttributeNode`.
public <AJ> SubGraph<AJ>	addSubGraph(String attributeName, Class<AJ> type)
public <AJ> SubGraph<AJ>	addSubGraph(PersistentAttribute<? extends J, AJ> attribute) Create and return a new (mutable) `SubGraph` associated with the `AttributeNode` for the given attribute.
public <AJ> SubGraph<? extends AJ>	addSubGraph(PersistentAttribute<? extends J, AJ> attribute, Class<? extends AJ> type)
public <AJ> AttributeNode<AJ>	findAttributeNode(String attributeName) Find an already existing AttributeNode by attributeName within this container
public <AJ> AttributeNode<AJ>	findAttributeNode(PersistentAttribute<? extends J, AJ> attribute) Find an already existing AttributeNode by corresponding attribute reference, within this container.
public List<AttributeNode<?>>	getAttributeNodeList() Get a list of all existing AttributeNodes within this container.
public List<AttributeNode<?>>	getGraphAttributeNodes() Ultimately only needed for implementing `jakarta.persistence.EntityGraph#getAttributeNodes()` and `jakarta.persistence.Subgraph#getAttributeNodes()`
public ManagedDomainType<J>	Returns: the `ManagedType` being graphed here. getGraphedType() Graphs apply only to `jakarta.persistence.metamodel.ManagedType`s.
public Graph<J>	makeCopy(boolean mutable) Redeclares org.hibernate.graph.GraphNode.makeCopy.
public RootGraph<J>	makeRootGraph(String name, boolean controls whether the resulting `Graph` is mutable mutable) Create a named root `Graph` if the given name is not null.
public SubGraph<J>	makeSubGraph(boolean mutable) Create a new (mutable or immutable) `SubGraph` rooted at this `Graph`.

Inherited from org.hibernate.graph.GraphNode:: isMutable

Method Detail

addAttributeNode	back to summary
public <AJ> AttributeNode<AJ> addAttributeNode(String attributeName) Add an `AttributeNode` (with no associated `SubGraph`) to this container by attribute name.

addAttributeNode	back to summary
public <AJ> AttributeNode<AJ> addAttributeNode(PersistentAttribute<? extends J, AJ> attribute) Add an `AttributeNode` (with no associated `SubGraph`) to this container by attribute reference.

addKeySubGraph	back to summary
public <AJ> SubGraph<AJ> addKeySubGraph(String attributeName) throws CannotContainSubGraphException

addKeySubGraph	back to summary
public <AJ> SubGraph<AJ> addKeySubGraph(String attributeName, Class<AJ> type) throws CannotContainSubGraphException

addKeySubGraph	back to summary
public <AJ> SubGraph<AJ> addKeySubGraph(PersistentAttribute<? extends J, AJ> attribute) throws CannotContainSubGraphException

addKeySubGraph	back to summary
public <AJ> SubGraph<? extends AJ> addKeySubGraph(PersistentAttribute<? extends J, AJ> attribute, Class<? extends AJ> type) throws CannotContainSubGraphException

addPluralSubgraph	back to summary
public default <AJ> SubGraph<AJ> addPluralSubgraph(PluralAttribute<? extends J, ?, AJ> attribute) Add a subgraph rooted at a plural attribute, allowing further nodes to be added to the subgraph. API Note This method is missing in JPA, and nodes cannot be added in a typesafe way to subgraphs representing fetched collections Since 6.3

addPluralSubgraph

back to summary

public default <AJ> SubGraph<AJ> addPluralSubgraph(PluralAttribute<? extends J, ?, AJ> attribute)

Add a subgraph rooted at a plural attribute, allowing further nodes to be added to the subgraph.

API Note

This method is missing in JPA, and nodes cannot be added in a typesafe way to subgraphs representing fetched collections

Since: 6.3

addSubGraph	back to summary
public <AJ> SubGraph<AJ> addSubGraph(String attributeName) throws CannotContainSubGraphException Create and return a new (mutable) `SubGraph` associated with the named `AttributeNode`. API Note If no such AttributeNode exists yet, it is created.

addSubGraph	back to summary
public <AJ> SubGraph<AJ> addSubGraph(String attributeName, Class<AJ> type) throws CannotContainSubGraphException

addSubGraph	back to summary
public <AJ> SubGraph<AJ> addSubGraph(PersistentAttribute<? extends J, AJ> attribute) throws CannotContainSubGraphException Create and return a new (mutable) `SubGraph` associated with the `AttributeNode` for the given attribute. API Note If no such AttributeNode exists yet, it is created.

addSubGraph	back to summary
public <AJ> SubGraph<? extends AJ> addSubGraph(PersistentAttribute<? extends J, AJ> attribute, Class<? extends AJ> type) throws CannotContainSubGraphException

findAttributeNode	back to summary
public <AJ> AttributeNode<AJ> findAttributeNode(String attributeName) Find an already existing AttributeNode by attributeName within this container

findAttributeNode	back to summary
public <AJ> AttributeNode<AJ> findAttributeNode(PersistentAttribute<? extends J, AJ> attribute) Find an already existing AttributeNode by corresponding attribute reference, within this container.

getAttributeNodeList	back to summary
public List<AttributeNode<?>> getAttributeNodeList() Get a list of all existing AttributeNodes within this container.

getGraphAttributeNodes	back to summary
public List<AttributeNode<?>> getGraphAttributeNodes() Ultimately only needed for implementing `jakarta.persistence.EntityGraph#getAttributeNodes()` and `jakarta.persistence.Subgraph#getAttributeNodes()`

getGraphedType back to summary

getGraphedType	back to summary
public ManagedDomainType<J> getGraphedType() Graphs apply only to `jakarta.persistence.metamodel.ManagedType`s. Returns:ManagedDomainType<J> the `ManagedType` being graphed here.

public ManagedDomainType<J> getGraphedType()

Graphs apply only to jakarta.persistence.metamodel.ManagedTypes.

Returns:ManagedDomainType<J>: the ManagedType being graphed here.

makeCopy	back to summary
public Graph<J> makeCopy(boolean mutable) Redeclares org.hibernate.graph.GraphNode.makeCopy. Annotations @Override

makeCopy

back to summary

public Graph<J> makeCopy(boolean mutable)

Redeclares org.hibernate.graph.GraphNode.makeCopy.

Annotations

@Override

makeRootGraph back to summary

makeRootGraph	back to summary
public RootGraph<J> makeRootGraph(String name, boolean mutable) throws CannotBecomeEntityGraphException Create a named root `Graph` if the given name is not null. Parameters mutable:boolean controls whether the resulting `Graph` is mutable Exceptions CannotBecomeEntityGraphException: If the named attribute is not entity-valued

public RootGraph<J> makeRootGraph(String name, boolean mutable) throws CannotBecomeEntityGraphException

Create a named root Graph if the given name is not null.

Parameters

mutable:boolean: controls whether the resulting Graph is mutable

Exceptions

CannotBecomeEntityGraphException:: If the named attribute is not entity-valued

makeSubGraph	back to summary
public SubGraph<J> makeSubGraph(boolean mutable) Create a new (mutable or immutable) `SubGraph` rooted at this `Graph`.

public Interface Graph<J>

Method Summary

Method Detail