|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FetchPlanItf
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
.
Field Summary | |
---|---|
static java.lang.String |
ALL
For use with speedoAddGroup(String) , speedoRemoveGroup(String) , and the
various speedoSetGroups(java.util.Collection) calls. |
static java.lang.String |
DEFAULT
For use with speedoAddGroup(String) , speedoRemoveGroup(String) , and the
various speedoSetGroups(java.util.Collection) calls. |
static int |
FETCH_SIZE_GREEDY
For use with #setFetchSize . |
static int |
FETCH_SIZE_OPTIMAL
For use with #setFetchSize . |
static java.lang.String |
NONE
For use with speedoAddGroup(String) , speedoRemoveGroup(String) , and the
various speedoSetGroups(java.util.Collection) calls. |
static java.lang.String |
VALUES
For use with speedoAddGroup(String) , speedoRemoveGroup(String) , and the
various speedoSetGroups(java.util.Collection) calls. |
Method Summary | |
---|---|
FetchPlanItf |
speedoAddGroup(java.lang.String fetchGroupName)
Add the fetch group to the set of active fetch groups. |
FetchPlanItf |
speedoClearGroups()
Remove all active groups leaving no active fetch group. |
int |
speedoGetFetchSize()
Return the fetch size, or FETCH_SIZE_OPTIMAL if not set,
or FETCH_SIZE_GREEDY to fetch all. |
java.util.Collection |
speedoGetGroups()
Return the names of all active fetch groups. |
FetchPlanItf |
speedoRemoveGroup(java.lang.String fetchGroupName)
Remove the fetch group from the set active fetch groups. |
FetchPlanItf |
speedoSetFetchSize(int fetchSize)
Set the fetch size for large result set support. |
FetchPlanItf |
speedoSetGroup(java.lang.String fetchGroupName)
Set the active fetch groups to the single named fetch group. |
FetchPlanItf |
speedoSetGroups(java.util.Collection fetchGroupNames)
Set a collection of groups. |
FetchPlanItf |
speedoSetGroups(java.lang.String[] fetchGroupNames)
Set a collection of groups. |
Field Detail |
---|
static final java.lang.String DEFAULT
speedoAddGroup(String)
, speedoRemoveGroup(String)
, and the
various speedoSetGroups(java.util.Collection)
calls. Value: default
.
static final java.lang.String ALL
speedoAddGroup(String)
, speedoRemoveGroup(String)
, and the
various speedoSetGroups(java.util.Collection)
calls. Value: all
.
static final java.lang.String VALUES
speedoAddGroup(String)
, speedoRemoveGroup(String)
, and the
various speedoSetGroups(java.util.Collection)
calls. Value: values
.
static final java.lang.String NONE
speedoAddGroup(String)
, speedoRemoveGroup(String)
, and the
various speedoSetGroups(java.util.Collection)
calls. Value: none
.
static final int FETCH_SIZE_GREEDY
#setFetchSize
. Value: -1.
static final int FETCH_SIZE_OPTIMAL
#setFetchSize
. Value: 0.
Method Detail |
---|
FetchPlanItf speedoAddGroup(java.lang.String fetchGroupName)
FetchPlanItf speedoRemoveGroup(java.lang.String fetchGroupName)
FetchPlanItf speedoClearGroups()
java.util.Collection speedoGetGroups()
FetchPlanItf speedoSetGroups(java.util.Collection fetchGroupNames)
fetchGroupNames
- a collection of names of fetch groups
FetchPlanItf speedoSetGroups(java.lang.String[] fetchGroupNames)
fetchGroupNames
- a String array of names of fetch groups
FetchPlanItf speedoSetGroup(java.lang.String fetchGroupName)
fetchGroupName
- the single fetch group
FetchPlanItf speedoSetFetchSize(int fetchSize)
FETCH_SIZE_OPTIMAL
to unset, and FETCH_SIZE_GREEDY
to force loading of everything.
fetchSize
- the fetch size
int speedoGetFetchSize()
FETCH_SIZE_OPTIMAL
if not set,
or FETCH_SIZE_GREEDY
to fetch all.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |