Class FetchPlanMetaData

java.lang.Object
org.datanucleus.metadata.MetaData
org.datanucleus.metadata.FetchPlanMetaData
All Implemented Interfaces:
Serializable

public class FetchPlanMetaData extends MetaData
FetchPlan defined in MetaData.
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • name

      String name
      Name of the FetchPlan.
    • maxFetchDepth

      protected int maxFetchDepth
      Max fetch depth for this FetchPlan.
    • fetchSize

      protected int fetchSize
      Fetch Size for use when querying using this FetchPlan.
    • fetchGroups

      protected List<FetchGroupMetaData> fetchGroups
      Series of Fetch Groups used in this FetchPlan. Only used during construction.
  • Constructor Details

    • FetchPlanMetaData

      public FetchPlanMetaData(String name)
      Constructor for a fetch plan with a name. Set fields using setters, before populate().
      Parameters:
      name - Name of fetch plan
  • Method Details

    • getName

      public final String getName()
      Accessor for name
      Returns:
      Returns the name.
    • getMaxFetchDepth

      public final int getMaxFetchDepth()
    • setMaxFetchDepth

      public FetchPlanMetaData setMaxFetchDepth(int maxFetchDepth)
    • setMaxFetchDepth

      public FetchPlanMetaData setMaxFetchDepth(String maxFetchDepth)
    • getFetchSize

      public final int getFetchSize()
    • getNumberOfFetchGroups

      public int getNumberOfFetchGroups()
    • setFetchSize

      public FetchPlanMetaData setFetchSize(int fetchSize)
    • setFetchSize

      public FetchPlanMetaData setFetchSize(String fetchSize)
    • getFetchGroupMetaData

      public final FetchGroupMetaData[] getFetchGroupMetaData()
      Accessor for fetchGroupMetaData
      Returns:
      Returns the fetchGroupMetaData.
    • addFetchGroup

      public void addFetchGroup(FetchGroupMetaData fgmd)
      Add a new FetchGroupMetaData
      Parameters:
      fgmd - the fetch group
    • newFetchGroupMetaData

      public FetchGroupMetaData newFetchGroupMetaData(String name)
      Method to create a new FetchGroup metadata, add it and return it.
      Parameters:
      name - Name of the fetch group
      Returns:
      The new fetch group metadata