Module persistence.api
Package javax.persistence

Annotation Type NamedSubgraph

@Target({}) @Retention(RUNTIME) public @interface NamedSubgraph
The NamedSubgraph annotation is used to further define an attribute node. It is referenced by its name from the subgraph or keySubgraph element of a NamedAttributeNode element.
Since:
JPA 2.1

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    NamedAttributeNode[]
    attributeNodes
    Lists attributes of the class that must be included.
    String
    name
    The name element is the name used to reference the subgraph from a NamedAttributeNode definition.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class
    type
    The type element must be specified when the subgraph corresponds to a subclass of the entity type corresponding to the referencing attribute node.

  • Element Details

    • name

      String name
      The name element is the name used to reference the subgraph from a NamedAttributeNode definition. In the case of entity inheritance, multiple subgraph elements have the same name.
      Returns:
      name

    • attributeNodes

      NamedAttributeNode[] attributeNodes
      Lists attributes of the class that must be included. If the subgraph corresponds to a subclass of the class referenced by the corresponding attribute node, only subclass-specific attributes are listed.
      Returns:
      attribute nodes

    • type

      Class type
      The type element must be specified when the subgraph corresponds to a subclass of the entity type corresponding to the referencing attribute node.
      Returns:
      type
      Default:
      void.class