Class JDOFetchPlan

java.lang.Object
org.datanucleus.api.jdo.JDOFetchPlan
All Implemented Interfaces:
Serializable, javax.jdo.FetchPlan
public class JDOFetchPlan extends Object implements javax.jdo.FetchPlan, Serializable
Implementation of a FetchPlan for JDO. Provides a JDO wrapper around the internal org.datanucleus.FetchPlan.
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • fp

      org.datanucleus.FetchPlan fp

  • Constructor Details

    • JDOFetchPlan

      public JDOFetchPlan(org.datanucleus.FetchPlan fp)
      Constructor.
      Parameters:
      fp - FetchPlan

  • Method Details

    • getGroups

      public Set getGroups()
      Accessor for the groups.
      Specified by:
      getGroups in interface javax.jdo.FetchPlan
      Returns:
      The groups

    • addGroup

      public javax.jdo.FetchPlan addGroup(String group)
      Method to add a group to the fetch plan.
      Specified by:
      addGroup in interface javax.jdo.FetchPlan
      Parameters:
      group - The group to add
      Returns:
      The updated FetchPlan

    • clearGroups

      public javax.jdo.FetchPlan clearGroups()
      Method to clear the fetch plan groups.
      Specified by:
      clearGroups in interface javax.jdo.FetchPlan
      Returns:
      The updated FetchPlan

    • removeGroup

      public javax.jdo.FetchPlan removeGroup(String group)
      Method to remove a group from the FetchPlan.
      Specified by:
      removeGroup in interface javax.jdo.FetchPlan
      Parameters:
      group - The group to remove
      Returns:
      The updated FetchPlan

    • setGroup

      public javax.jdo.FetchPlan setGroup(String group)
      Method to set the FetchPlan to a single group.
      Specified by:
      setGroup in interface javax.jdo.FetchPlan
      Parameters:
      group - The group to set
      Returns:
      The updated FetchPlan

    • setGroups

      public javax.jdo.FetchPlan setGroups(Collection groups)
      Method to set the groups to the passed collection.
      Specified by:
      setGroups in interface javax.jdo.FetchPlan
      Parameters:
      groups - Collection of groups
      Returns:
      Updated FetchPlan

    • setGroups

      public javax.jdo.FetchPlan setGroups(String... groups)
      Method to set the groups to the passed array.
      Specified by:
      setGroups in interface javax.jdo.FetchPlan
      Parameters:
      groups - Collection of groups
      Returns:
      Updated FetchPlan

    • getFetchSize

      public int getFetchSize()
      Accessor for the fetch size.
      Specified by:
      getFetchSize in interface javax.jdo.FetchPlan
      Returns:
      The fetch size

    • setFetchSize

      public javax.jdo.FetchPlan setFetchSize(int size)
      Method to set the fetch size (large result sets).
      Specified by:
      setFetchSize in interface javax.jdo.FetchPlan
      Parameters:
      size - The size
      Returns:
      Updated FetchPlan

    • getMaxFetchDepth

      public int getMaxFetchDepth()
      Accessor for the max fetch depth.
      Specified by:
      getMaxFetchDepth in interface javax.jdo.FetchPlan
      Returns:
      Max fetch depth

    • setMaxFetchDepth

      public javax.jdo.FetchPlan setMaxFetchDepth(int depth)
      Method to set the max fetch depth.
      Specified by:
      setMaxFetchDepth in interface javax.jdo.FetchPlan
      Parameters:
      depth - The depth
      Returns:
      Updated FetchPlan

    • getDetachmentOptions

      public int getDetachmentOptions()
      Accessor for the detachment options.
      Specified by:
      getDetachmentOptions in interface javax.jdo.FetchPlan
      Returns:
      Detachment options.

    • getDetachmentRootClasses

      public Class[] getDetachmentRootClasses()
      Accessor for the detachment root classes.
      Specified by:
      getDetachmentRootClasses in interface javax.jdo.FetchPlan
      Returns:
      Detachment root classes

    • getDetachmentRoots

      public Collection getDetachmentRoots()
      Accessor for the detachment roots.
      Specified by:
      getDetachmentRoots in interface javax.jdo.FetchPlan
      Returns:
      Detachment roots

    • setDetachmentOptions

      public javax.jdo.FetchPlan setDetachmentOptions(int options)
      Method to set the detachment options.
      Specified by:
      setDetachmentOptions in interface javax.jdo.FetchPlan
      Parameters:
      options - Detachment options
      Returns:
      Updated FetchPlan

    • setDetachmentRootClasses

      public javax.jdo.FetchPlan setDetachmentRootClasses(Class... rootClasses)
      Method to set the detachment root classes.
      Specified by:
      setDetachmentRootClasses in interface javax.jdo.FetchPlan
      Parameters:
      rootClasses - The detachment root classes
      Returns:
      Updated FetchPlan

    • setDetachmentRoots

      public javax.jdo.FetchPlan setDetachmentRoots(Collection roots)
      Method to set the detachment roots.
      Specified by:
      setDetachmentRoots in interface javax.jdo.FetchPlan
      Parameters:
      roots - Detachment roots
      Returns:
      Updated FetchPlan

    • getInternalFetchPlan

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