Top Description Methods
jakarta.persistence

public @Interface NamedAttributeNode

extends Annotation
Annotations
@Target
@Retention:RUNTIME
Imports
java.lang.annotation.Target, .Retention, java.util.Map

A NamedAttributeNode is a member element of a NamedEntityGraph.
Since
2.1
See Also
NamedEntityGraph, NamedSubgraph

Method Summary

Modifier and TypeMethod and Description
public String
keySubgraph()

(Optional) If the attribute references a Map type, this element can be used to specify a subgraph for the Key in the case of an Entity key type.

public String
subgraph()

(Optional) If the attribute references a managed type that has its own AttributeNodes, this element is used to refer to that NamedSubgraph definition.

public String
value()

(Required) The name of the attribute that must be included in the graph.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

keySubgraphback to summary
public String keySubgraph()

(Optional) If the attribute references a Map type, this element can be used to specify a subgraph for the Key in the case of an Entity key type. A keySubgraph can not be specified without the Map attribute also being specified. If the target type has inheritance, multiple subgraphs can be specified. These additional subgraphs are intended to add subclass-specific attributes. Superclass subgraph entries are merged into subclass subgraphs.

The value of this element is the name of the key subgraph as specified by the name element of the corresponding NamedSubgraph element. If multiple key subgraphs are specified due to inheritance, they are referenced by this name.

subgraphback to summary
public String subgraph()

(Optional) If the attribute references a managed type that has its own AttributeNodes, this element is used to refer to that NamedSubgraph definition. If the target type has inheritance, multiple subgraphs can be specified. These additional subgraphs are intended to add subclass-specific attributes. Superclass subgraph entries will be merged into subclass subgraphs.

The value of this element is the name of the subgraph as specified by the name element of the corresponding NamedSubgraph element. If multiple subgraphs are specified due to inheritance, they are referenced by this name.

valueback to summary
public String value()

(Required) The name of the attribute that must be included in the graph.