Package org.datanucleus.api.jdo

Class JDOFetchPlan

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      (package private) org.datanucleus.FetchPlan fp  
      private static long serialVersionUID  

      • Fields inherited from interface javax.jdo.FetchPlan

        ALL, DEFAULT, DETACH_LOAD_FIELDS, DETACH_UNLOAD_FIELDS, FETCH_SIZE_GREEDY, FETCH_SIZE_OPTIMAL

    • Constructor Summary

      Constructors 
      Constructor Description
      JDOFetchPlan​(org.datanucleus.FetchPlan fp)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.jdo.FetchPlan addGroup​(java.lang.String group)
      Method to add a group to the fetch plan.
      javax.jdo.FetchPlan 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.
      javax.jdo.FetchPlan removeGroup​(java.lang.String group)
      Method to remove a group from the FetchPlan.
      javax.jdo.FetchPlan setDetachmentOptions​(int options)
      Method to set the detachment options.
      javax.jdo.FetchPlan setDetachmentRootClasses​(java.lang.Class... rootClasses)
      Method to set the detachment root classes.
      javax.jdo.FetchPlan setDetachmentRoots​(java.util.Collection roots)
      Method to set the detachment roots.
      javax.jdo.FetchPlan setFetchSize​(int size)
      Method to set the fetch size (large result sets).
      javax.jdo.FetchPlan setGroup​(java.lang.String group)
      Method to set the FetchPlan to a single group.
      javax.jdo.FetchPlan setGroups​(java.lang.String... groups)
      Method to set the groups to the passed array.
      javax.jdo.FetchPlan setGroups​(java.util.Collection groups)
      Method to set the groups to the passed collection.
      javax.jdo.FetchPlan 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

    • Field Detail

      • fp

        org.datanucleus.FetchPlan fp

    • Constructor Detail

      • JDOFetchPlan

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

    • Method Detail

      • getGroups

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

      • addGroup

        public javax.jdo.FetchPlan addGroup​(java.lang.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​(java.lang.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​(java.lang.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​(java.util.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​(java.lang.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 java.lang.Class[] getDetachmentRootClasses()
        Accessor for the detachment root classes.
        Specified by:
        getDetachmentRootClasses in interface javax.jdo.FetchPlan
        Returns:
        Detachment root classes

      • getDetachmentRoots

        public java.util.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​(java.lang.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​(java.util.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