javax.jdo.FetchPlan - JDO interface
Fetch groups are activated using methods on this interface. An instance of this interface can be obtained from
PersistenceManager.getFetchPlan
,
Extent.getFetchPlan
, and
Query.getFetchPlan
. When a
Query
or
Extent
is retrieved from a
PersistenceManager
, its
FetchPlan
is initialized to the same settings as that of the
PersistenceManager
. Subsequent modifications of the
Query
or
Extent
's
FetchPlan
are not reflected in the
FetchPlan
of the
PersistenceManager
.
- Since:
- JDO 2.0
Add the fetch group to the set of active fetch groups.
Add the fetch group to the set of active fetch groups.
- Parameters:
-
fetchGroupName
-
- Returns:
- the FetchPlan
- Since:
- JDO 2.0
Remove all active groups leaving no active fetch group.
Remove all active groups leaving no active fetch group.
- Returns:
- the FetchPlan
- Since:
- JDO 2.0
Get options used during detachment.
Get options used during detachment.
- Since:
- JDO 2.0
Get the root classes for DetachAllOnCommit.
Get the root classes for DetachAllOnCommit.
- Returns:
- The detachment root classes
- Since:
- JDO 2.0
Get the roots for DetachAllOnCommit.
Get the roots for DetachAllOnCommit.
- Returns:
- Collection of detachment roots.
- Since:
- JDO 2.0
- Returns:
- the fetch size
- Since:
- JDO 2.0
Return an immutable Set containing the names of all active fetch groups.
Return an immutable Set containing the names of all active fetch groups. The Set is a copy of the currently active groups and will not change based on subsequent changes to the groups.
- Returns:
- an immutable Set containing the names of all currently active fetch groups
- Since:
- JDO 2.0
Return the maximum fetch depth used when fetching instances.
Return the maximum fetch depth used when fetching instances.
- Returns:
- the maximum fetch depth
- Since:
- JDO 2.0
Remove the fetch group from the set active fetch groups.
Remove the fetch group from the set active fetch groups.
- Parameters:
-
fetchGroupName
-
- Returns:
- the FetchPlan
- Since:
- JDO 2.0
Set options to be used during detachment.
- Parameters:
-
options
-
- Since:
- JDO 2.0
Set the root classes for DetachAllOnCommit.
Set the root classes for DetachAllOnCommit.
- Parameters:
-
rootClasses
- The root classes.
- Since:
- JDO 2.0
Set the roots for DetachAllOnCommit.
Set the roots for DetachAllOnCommit.
- Parameters:
-
roots
- Collection of the detachment roots.
- Since:
- JDO 2.0
Set the fetch size for large result set support.
- Parameters:
-
fetchSize
- the fetch size
- Returns:
- the FetchPlan
- Since:
- JDO 2.0
Set the active fetch groups to the single named fetch group.
Set the active fetch groups to the single named fetch group.
- Parameters:
-
fetchGroupName
- the single fetch group
- Returns:
- the FetchPlan
- Since:
- JDO 2.0
Set a collection of groups.
Set a collection of groups.
- Parameters:
-
fetchGroupNames
- a String array of names of fetch groups
- Returns:
- the FetchPlan
- Since:
- JDO 2.0
Set a collection of groups.
Set a collection of groups.
- Parameters:
-
fetchGroupNames
- a collection of names of fetch groups
- Returns:
- the FetchPlan
- Since:
- JDO 2.0
Set the maximum fetch depth when fetching.
Set the maximum fetch depth when fetching. A value of 0 has no meaning and will throw a JDOUserException. A value of -1 means that no limit is placed on fetching. A positive integer will result in that number of references from the initial object to be fetched.
- Parameters:
-
fetchDepth
- the depth
- Returns:
- the FetchPlan
- Since:
- JDO 2.0