org.objectweb.speedo.mim.lib
Class SpeedoFetchPlan

java.lang.Object
  extended by org.objectweb.speedo.mim.lib.SpeedoFetchPlan
All Implemented Interfaces:
FetchPlanItf
Direct Known Subclasses:
JDOFetchPlan

public class SpeedoFetchPlan
extends java.lang.Object
implements FetchPlanItf

Author:
Y.Bersihand

Field Summary
 
Fields inherited from interface org.objectweb.speedo.mim.api.FetchPlanItf
ALL, DEFAULT, FETCH_SIZE_GREEDY, FETCH_SIZE_OPTIMAL, NONE, VALUES
 
Constructor Summary
SpeedoFetchPlan()
           
SpeedoFetchPlan(java.lang.String fgName)
           
 
Method Summary
 FetchPlanItf speedoAddGroup(java.lang.String fetchGroupName)
          Add a group into the fetch plan.
 FetchPlanItf speedoClearGroups()
          Remove all active groups leaving no active fetch group.
 int speedoGetFetchSize()
          Return the fetch size, or FetchPlanItf.FETCH_SIZE_OPTIMAL if not set, or FetchPlanItf.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 a group from the fetch plan.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SpeedoFetchPlan

public SpeedoFetchPlan()

SpeedoFetchPlan

public SpeedoFetchPlan(java.lang.String fgName)
Method Detail

speedoAddGroup

public FetchPlanItf speedoAddGroup(java.lang.String fetchGroupName)
Add a group into the fetch plan.

Specified by:
speedoAddGroup in interface FetchPlanItf
Returns:
the FetchPlan

speedoRemoveGroup

public FetchPlanItf speedoRemoveGroup(java.lang.String fetchGroupName)
Remove a group from the fetch plan.

Specified by:
speedoRemoveGroup in interface FetchPlanItf
Returns:
the FetchPlan

speedoGetGroups

public java.util.Collection speedoGetGroups()
Description copied from interface: FetchPlanItf
Return the names of all active fetch groups.

Specified by:
speedoGetGroups in interface FetchPlanItf
Returns:
the names of active fetch groups

speedoSetGroups

public FetchPlanItf speedoSetGroups(java.util.Collection fetchGroupNames)
Description copied from interface: FetchPlanItf
Set a collection of groups.

Specified by:
speedoSetGroups in interface FetchPlanItf
Parameters:
fetchGroupNames - a collection of names of fetch groups
Returns:
the FetchPlan

speedoClearGroups

public FetchPlanItf speedoClearGroups()
Description copied from interface: FetchPlanItf
Remove all active groups leaving no active fetch group.

Specified by:
speedoClearGroups in interface FetchPlanItf
Returns:
the FetchPlan

speedoSetGroup

public FetchPlanItf speedoSetGroup(java.lang.String fetchGroupName)
Description copied from interface: FetchPlanItf
Set the active fetch groups to the single named fetch group.

Specified by:
speedoSetGroup in interface FetchPlanItf
Parameters:
fetchGroupName - the single fetch group
Returns:
the FetchPlan

speedoSetGroups

public FetchPlanItf speedoSetGroups(java.lang.String[] fetchGroupNames)
Description copied from interface: FetchPlanItf
Set a collection of groups.

Specified by:
speedoSetGroups in interface FetchPlanItf
Parameters:
fetchGroupNames - a String array of names of fetch groups
Returns:
the FetchPlan

speedoSetFetchSize

public FetchPlanItf speedoSetFetchSize(int fetchSize)
Description copied from interface: FetchPlanItf
Set the fetch size for large result set support. Use FetchPlanItf.FETCH_SIZE_OPTIMAL to unset, and FetchPlanItf.FETCH_SIZE_GREEDY to force loading of everything.

Specified by:
speedoSetFetchSize in interface FetchPlanItf
Parameters:
fetchSize - the fetch size
Returns:
the FetchPlan

speedoGetFetchSize

public int speedoGetFetchSize()
Description copied from interface: FetchPlanItf
Return the fetch size, or FetchPlanItf.FETCH_SIZE_OPTIMAL if not set, or FetchPlanItf.FETCH_SIZE_GREEDY to fetch all.

Specified by:
speedoGetFetchSize in interface FetchPlanItf
Returns:
the fetch size