Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT

## javax.jdo.annotations
Annotation Type FetchPlan

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

Annotation for the fetch plan of a persistence manager, query, or extent. Corresponds to the xml element "fetch-plan".

Since:
  2.1
Version:
  2.1

Optional Element Summary
`java.lang.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.
`java.lang.String` | `name` Name of the fetch plan.

### name

    public abstract java.lang.String name

  Name of the fetch plan.

  Returns:
    the name of the fetch plan
  Default:
    ""

### fetchGroups

    public abstract java.lang.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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT