Interface AttributeNode<J>

Type Parameters:

J - The type of the attribute

All Superinterfaces:

AttributeNode<J>, GraphNode<J>

All Known Subinterfaces:

AttributeNodeImplementor<J,E,K>

public interface AttributeNode<J>
extends GraphNode<J>, AttributeNode<J>

Represents a fetched attribute in an entity graph.

An AttributeNode representing an attribute whose type is a managed type or collection of some managed type may have an associated value subgraph, which is represented by an instance of SubGraph.

• For a singular attribute, the value type is the type of the attribute.
• For a plural attribute, the value type is the collection element type.

Or, if the represented attribute is a Map, the AttributeNode maye have an associated key subgraph, similarly represented by a SubGraph.

Not every attribute node has a subgraph.

Extends the JPA-defined AttributeNode with additional operations.

API Note:

Historically, this interface declared operations with incorrect generic types, leading to unsound code. This was in Hibernate 7, with possible breakage to older code.

Method Summary

Modifier and Type	Method	Description
PersistentAttribute<?,J>	getAttributeDescriptor()	The PersistentAttribute represented by this node.
default Map<Class,Subgraph>	getKeySubgraphs()	All key subgraphs rooted at this node.
Map<Class<?>, ? extends SubGraph<?>>	getKeySubGraphs()	All key subgraphs rooted at this node.
default Map<Class,Subgraph>	getSubgraphs()	All value subgraphs rooted at this node.
Map<Class<?>, ? extends SubGraph<?>>	getSubGraphs()	All value subgraphs rooted at this node.
boolean	isRemoved()	Whether this attribute was removed.
SubGraph<?>	makeKeySubGraph()	Deprecated. This operation is not properly type safe.
<S> SubGraph<S>	makeKeySubGraph(Class<S> subtype)	Deprecated. This operation is not properly type safe.
SubGraph<?>	makeSubGraph()	Deprecated. This operation is not properly type safe.
<S> SubGraph<S>	makeSubGraph(Class<S> subtype)	Deprecated. This operation is not properly type safe.

Methods inherited from interface AttributeNode

getAttributeName

Methods inherited from interface GraphNode

isMutable, makeCopy

Method Details

getAttributeDescriptor

PersistentAttribute<?,J> getAttributeDescriptor()

The PersistentAttribute represented by this node.

isRemoved

boolean isRemoved()

Whether this attribute was removed. Per the Jakarta Persistence specification, such nodes should actually suppress inclusion of the attribute mapped for eager fetching when the graph is used as a load graph.

getSubGraphs

Map<Class<?>, ? extends SubGraph<?>> getSubGraphs()

All value subgraphs rooted at this node.

Includes treated subgraphs.

See Also:

• AttributeNode.getSubgraphs()

getKeySubGraphs

Map<Class<?>, ? extends SubGraph<?>> getKeySubGraphs()

All key subgraphs rooted at this node.

Includes treated subgraphs.

See Also:

• AttributeNode.getKeySubgraphs()

getSubgraphs

default Map<Class,Subgraph> getSubgraphs()

All value subgraphs rooted at this node.

Includes treated subgraphs.

Specified by:

getSubgraphs in interface AttributeNode<J>

See Also:

• getSubGraphs()

API Note:

This operation is declared with raw types by JPA

getKeySubgraphs

default Map<Class,Subgraph> getKeySubgraphs()

All key subgraphs rooted at this node.

Includes treated subgraphs.

Specified by:

getKeySubgraphs in interface AttributeNode<J>

See Also:

• getKeySubGraphs()

API Note:

This operation is declared with raw types by JPA

makeSubGraph

@Deprecated(since="7.0")
SubGraph<?> makeSubGraph()

Deprecated.

This operation is not properly type safe. Note that graph.addAttributeNode(att).makeSubGraph() is a synonym for graph.addSubgraph(att).

Create and return a new value SubGraph rooted at this node, or return an existing such SubGraph if there is one.

See Also:

• Graph.addSubgraph(jakarta.persistence.metamodel.Attribute)

makeKeySubGraph

@Deprecated(since="7.0")
SubGraph<?> makeKeySubGraph()

Deprecated.

This operation is not properly type safe. Note that graph.addAttributeNode(att).makeKeySubGraph() is a synonym for graph.addMapKeySubgraph(att).

Create and return a new key SubGraph rooted at this node, or return an existing such SubGraph if there is one.

See Also:

• Graph.addMapKeySubgraph(jakarta.persistence.metamodel.MapAttribute)

makeSubGraph

@Deprecated(since="7.0")
<S> SubGraph<S> makeSubGraph(Class<S> subtype)

Deprecated.

This operation is not properly type safe. Note that graph.addAttributeNode(att).makeSubGraph(cl) is a synonym for graph.addTreatedSubgraph(att,cl).

Create and return a new value SubGraph rooted at this node, with the given type, which may be a subtype of the value type, or return an existing such SubGraph if there is one.

If the given type is a proper subtype of the value type, the result is a treated subgraph.

Parameters:

subtype - The type or treated type of the value type

See Also:

• Graph.addTreatedSubgraph(jakarta.persistence.metamodel.Attribute, Class)

makeKeySubGraph

@Deprecated(since="7.0")
<S> SubGraph<S> makeKeySubGraph(Class<S> subtype)

Deprecated.

This operation is not properly type safe. Note that graph.addAttributeNode(att).makeKeySubGraph(cl) is a synonym for graph.addTreatedMapKeySubgraph(att,cl).

Create and return a new value SubGraph rooted at this node, with the given type, which may be a subtype of the key type, or return an existing such SubGraph if there is one.

If the given type is a proper subtype of the key type, the result is a treated subgraph.

Parameters:

subtype - The type or treated type of the key type

See Also:

• Graph.addTreatedMapKeySubgraph(jakarta.persistence.metamodel.MapAttribute,Class)