org.datanucleus.api.jpa.annotations

Annotation Type FetchPlan

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

Annotation for the fetch plan of an entity manager, query, or extent.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	fetchGroups The fetch groups in this fetch plan.
int	fetchSize The number of instances of multi-valued fields retrieved by queries.
int	maxFetchDepth The depth of references to instantiate, starting with the root object.
String	name Name of the fetch plan.

Element Detail

name

public abstract String name

Name of the fetch plan.

Returns:

the name of the fetch plan

Default:

""

fetchGroups

public abstract String[] fetchGroups

The fetch groups in this fetch plan.

Returns:

the fetch groups

Default:

{}

maxFetchDepth

public abstract int maxFetchDepth

The depth of references to instantiate, starting with the root object.

Returns:

the maxium fetch depth

Default:

1

fetchSize

public abstract int fetchSize

The number of instances of multi-valued fields retrieved by queries.

Returns:

the fetch size

Default:

0