org.apache.deltaspike.data.api

Annotation Type EntityGraph

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface EntityGraph

Defines an entity graph to be applied to a query. This annotation can be added to any query method of a repository class.

The arguments value and paths are mutually exclusive. If value is set, it references a named entity graph defined by JPA metadata.

If paths is set, an entity graph is constructed programmatically from the list of attribute paths.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	paths List of attribute paths.
EntityGraphType	type Type of entity graph (fetch or load).
String	value Name of a named entity graph.

Element Detail

value

public abstract String value

Name of a named entity graph.

Returns:

graph name

Default:

""

type

public abstract EntityGraphType type

Type of entity graph (fetch or load).

Returns:

graph type

Default:

org.apache.deltaspike.data.api.EntityGraphType.FETCH

paths

public abstract String[] paths

List of attribute paths. Each path may have multiple components, separated by dots. A single component path adds an attribute node to the entity graph. A path foo.bar.baz adds an attribute node baz to a subgraph bar for the subgraph foo.

Returns:

list of paths

Default:

{}