org.eclipse.persistence.annotations

Annotation Type NamedEntityGraph

@Target(value=TYPE)
@Retention(value=RUNTIME)
public @interface NamedEntityGraph

A NamedEntityGraph allows for the static definition of an entity graph. Once defined this graph may be used as a template for persistence operations.

Since:

EclipseLink 2.4.2

Author:

Gordon Yorke

See Also:

org.eclipse.persistence.jpa.NamedEntityGraph

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
NamedAttributeNode[]	attributes (Required) list of attributes that exist in this sub-graph.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	name (Optional) The name of the sub-graph.
NamedSubgraph[]	subclassSubgraphs
NamedSubgraph[]	subgraphs (Optional) This is a list of ManagedComponents that exist in the sub-graph.

Element Detail

attributes

public abstract NamedAttributeNode[] attributes

(Required) list of attributes that exist in this sub-graph.

name

public abstract java.lang.String name

(Optional) The name of the sub-graph. Defaults to the entity name of the root entity.

Default:

""

subgraphs

public abstract NamedSubgraph[] subgraphs

(Optional) This is a list of ManagedComponents that exist in the sub-graph. They will be referenced by name from other component definitions.

Default:

{}

subclassSubgraphs

public abstract NamedSubgraph[] subclassSubgraphs

Default:

{}