org.datanucleus.jpa
Class JPAFetchPlan

java.lang.Object
  extended by org.datanucleus.jpa.JPAFetchPlan
All Implemented Interfaces:
java.io.Serializable

public class JPAFetchPlan
extends java.lang.Object
implements java.io.Serializable

Implementation of a FetchPlan for JDO. Provides a JDO wrapper around the internal org.datanucleus.FetchPlan.

See Also:
Serialized Form

Constructor Summary
JPAFetchPlan(org.datanucleus.FetchPlan fp)
          Constructor.
 
Method Summary
 JPAFetchPlan addGroup(java.lang.String group)
          Method to add a group to the fetch plan.
 JPAFetchPlan clearGroups()
          Method to clear the fetch plan groups.
 int getDetachmentOptions()
          Accessor for the detachment options.
 java.lang.Class[] getDetachmentRootClasses()
          Accessor for the detachment root classes.
 java.util.Collection getDetachmentRoots()
          Accessor for the detachment roots.
 int getFetchSize()
          Accessor for the fetch size.
 java.util.Set getGroups()
          Accessor for the groups.
 org.datanucleus.FetchPlan getInternalFetchPlan()
          Accessor for the internal fetch plan.
 int getMaxFetchDepth()
          Accessor for the max fetch depth.
 JPAFetchPlan removeGroup(java.lang.String group)
          Method to remove a group from the FetchPlan.
 JPAFetchPlan setDetachmentOptions(int options)
          Method to set the detachment options.
 JPAFetchPlan setDetachmentRootClasses(java.lang.Class... rootClasses)
          Method to set the detachment root classes.
 JPAFetchPlan setDetachmentRoots(java.util.Collection roots)
          Method to set the detachment roots.
 JPAFetchPlan setFetchSize(int size)
          Method to set the fetch size (large result sets).
 JPAFetchPlan setGroup(java.lang.String group)
          Method to set the FetchPlan to a single group.
 JPAFetchPlan setGroups(java.util.Collection groups)
          Method to set the groups to the passed collection.
 JPAFetchPlan setGroups(java.lang.String... groups)
          Method to set the groups to the passed array.
 JPAFetchPlan setMaxFetchDepth(int depth)
          Method to set the max fetch depth.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JPAFetchPlan

public JPAFetchPlan(org.datanucleus.FetchPlan fp)
Constructor.

Parameters:
fp - FetchPlan
Method Detail

getGroups

public java.util.Set getGroups()
Accessor for the groups.

Returns:
The groups

addGroup

public JPAFetchPlan addGroup(java.lang.String group)
Method to add a group to the fetch plan.

Parameters:
group - The group to add
Returns:
The updated FetchPlan

clearGroups

public JPAFetchPlan clearGroups()
Method to clear the fetch plan groups.

Returns:
The updated FetchPlan

removeGroup

public JPAFetchPlan removeGroup(java.lang.String group)
Method to remove a group from the FetchPlan.

Parameters:
group - The group to remove
Returns:
The updated FetchPlan

setGroup

public JPAFetchPlan setGroup(java.lang.String group)
Method to set the FetchPlan to a single group.

Parameters:
group - The group to set
Returns:
The updated FetchPlan

setGroups

public JPAFetchPlan setGroups(java.util.Collection groups)
Method to set the groups to the passed collection.

Parameters:
groups - Collection of groups
Returns:
Updated FetchPlan

setGroups

public JPAFetchPlan setGroups(java.lang.String... groups)
Method to set the groups to the passed array.

Parameters:
groups - Collection of groups
Returns:
Updated FetchPlan

getFetchSize

public int getFetchSize()
Accessor for the fetch size.

Returns:
The fetch size

setFetchSize

public JPAFetchPlan setFetchSize(int size)
Method to set the fetch size (large result sets).

Parameters:
size - The size
Returns:
Updated FetchPlan

getMaxFetchDepth

public int getMaxFetchDepth()
Accessor for the max fetch depth.

Returns:
Max fetch depth

setMaxFetchDepth

public JPAFetchPlan setMaxFetchDepth(int depth)
Method to set the max fetch depth.

Parameters:
depth - The depth
Returns:
Updated FetchPlan

getDetachmentOptions

public int getDetachmentOptions()
Accessor for the detachment options.

Returns:
Detachment options.

getDetachmentRootClasses

public java.lang.Class[] getDetachmentRootClasses()
Accessor for the detachment root classes.

Returns:
Detachment root classes

getDetachmentRoots

public java.util.Collection getDetachmentRoots()
Accessor for the detachment roots.

Returns:
Detachment roots

setDetachmentOptions

public JPAFetchPlan setDetachmentOptions(int options)
Method to set the detachment options.

Parameters:
options - Detachment options
Returns:
Updated FetchPlan

setDetachmentRootClasses

public JPAFetchPlan setDetachmentRootClasses(java.lang.Class... rootClasses)
Method to set the detachment root classes.

Parameters:
rootClasses - The detachment root classes
Returns:
Updated FetchPlan

setDetachmentRoots

public JPAFetchPlan setDetachmentRoots(java.util.Collection roots)
Method to set the detachment roots.

Parameters:
roots - Detachment roots
Returns:
Updated FetchPlan

getInternalFetchPlan

public org.datanucleus.FetchPlan getInternalFetchPlan()
Accessor for the internal fetch plan.

Returns:
Internal fetch plan


Copyright © 2011. All Rights Reserved.