Package org.datanucleus.api.jpa

Class JPAFetchPlan

  • All Implemented Interfaces:
    Serializable
    public class JPAFetchPlan
extends Object
implements Serializable
    Implementation of a FetchPlan for JPA. Provides a JPA wrapper around the internal org.datanucleus.FetchPlan.
    See Also:
    Serialized Form

    • Constructor Detail

      • JPAFetchPlan

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

    • Method Detail

      • getGroups

        public Set<String> getGroups()
        Accessor for the groups.
        Returns:
        The groups

      • addGroup

        public JPAFetchPlan addGroup​(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​(String group)
        Method to remove a group from the FetchPlan.
        Parameters:
        group - The group to remove
        Returns:
        The updated FetchPlan

      • setGroup

        public JPAFetchPlan setGroup​(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​(Collection groups)
        Method to set the groups to the passed collection.
        Parameters:
        groups - Collection of groups
        Returns:
        Updated FetchPlan

      • setGroups

        public JPAFetchPlan setGroups​(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 Class[] getDetachmentRootClasses()
        Accessor for the detachment root classes.
        Returns:
        Detachment root classes

      • getDetachmentRoots

        public 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​(Class... rootClasses)
        Method to set the detachment root classes.
        Parameters:
        rootClasses - The detachment root classes
        Returns:
        Updated FetchPlan

      • setDetachmentRoots

        public JPAFetchPlan setDetachmentRoots​(Collection roots)
        Method to set the detachment roots.
        Parameters:
        roots - Detachment roots
        Returns:
        Updated FetchPlan

      • getInternalFetchPlan

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