JPA Annotation

NamedEntityGraph

Target: TYPE
Implemented Interfaces:
Annotation
Defines a named plain. This annotation must be applied to the root entity of the graph, and specifies the limits of the graph of associated attributes and entities fetched when an operation which retrieves an instance or instances of the root entity is executed.

A reference to a named entity graph may be obtained by calling getEntityGraph(), and may be passed to find().

Since:
JPA 2.1

Public Annotation Attributes

NamedAttributeNode[] attributeNodes default {}
(Optional) A list of attributes of the entity that are included in this graph.
Since:
JPA 2.1
boolean includeAllAttributes default false
(Optional) Includes all of the attributes of the annotated entity class as attribute nodes in the NamedEntityGraph without the need to explicitly list them.
Included attributes can still be fully specified by an attribute node referencing a subgraph.
Since:
JPA 2.1
String name default ""
(Optional) The name used to identify the entity graph in calls to getEntityGraph().
If no name is explicitly specified, the name defaults to the entity name of the annotated root entity. Entity graph names must be unique within the persistence unit.
Since:
JPA 2.1
NamedSubgraph[] subclassSubgraphs default {}
(Optional) A list of subgraphs that will add additional attributes for subclasses of the annotated entity class to the entity graph.
Specified attributes from superclasses are included in subclasses.
Since:
JPA 2.1
NamedSubgraph[] subgraphs default {}
(Optional) A list of subgraphs that are included in the entity graph.
These are referenced by name from NamedAttributeNode definitions.
Since:
JPA 2.1