Package javax.persistence

Annotation Type NamedEntityGraph

  • @Repeatable(NamedEntityGraphs.class)
@Target(TYPE)
@Retention(RUNTIME)
public @interface NamedEntityGraph
    Used to specify the path and boundaries for a find operation or query.
    Since:
    2.1

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      NamedAttributeNode[] attributeNodes
      (Optional) A list of attributes of the entity that are included in this graph.
      boolean includeAllAttributes
      (Optional) Includes all of the attributes of the annotated entity class as attribute nodes in the NamedEntityGraph without the need to explicitly list them.
      java.lang.String name
      (Optional) The name of the entity graph.
      NamedSubgraph[] subclassSubgraphs
      (Optional) A list of subgraphs that will add additional attributes for subclasses of the annotated entity class to the entity graph.
      NamedSubgraph[] subgraphs
      (Optional) A list of subgraphs that are included in the entity graph.

    • Element Detail

      • name

        java.lang.String name
        (Optional) The name of the entity graph. Defaults to the entity name of the root entity.
        Default:
        ""

      • attributeNodes

        NamedAttributeNode[] attributeNodes
        (Optional) A list of attributes of the entity that are included in this graph.
        Default:
        {}

      • includeAllAttributes

        boolean includeAllAttributes
        (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.
        Default:
        false

      • subgraphs

        NamedSubgraph[] subgraphs
        (Optional) A list of subgraphs that are included in the entity graph. These are referenced by name from NamedAttributeNode definitions.
        Default:
        {}

      • subclassSubgraphs

        NamedSubgraph[] subclassSubgraphs
        (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.
        Default:
        {}