- 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:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected List<FetchGroupMetaData>
fetchGroups
Series of Fetch Groups used in this FetchPlan.protected int
fetchSize
Fetch Size for use when querying using this FetchPlan.protected int
maxFetchDepth
Max fetch depth for this FetchPlan.-
Fields inherited from class org.datanucleus.metadata.MetaData
EXTENSION_CLASS_CREATETIMESTAMP, EXTENSION_CLASS_CREATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_CREATEUSER, EXTENSION_CLASS_CREATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_CREATEUSER_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_COLUMN_LENGTH, EXTENSION_CLASS_MULTITENANCY_COLUMN_NAME, EXTENSION_CLASS_MULTITENANCY_JDBC_TYPE, EXTENSION_CLASS_MULTITENANT, EXTENSION_CLASS_READ_ONLY, EXTENSION_CLASS_SOFTDELETE, EXTENSION_CLASS_SOFTDELETE_COLUMN_NAME, EXTENSION_CLASS_UPDATETIMESTAMP, EXTENSION_CLASS_UPDATETIMESTAMP_COLUMN_NAME, EXTENSION_CLASS_UPDATEUSER, EXTENSION_CLASS_UPDATEUSER_COLUMN_LENGTH, EXTENSION_CLASS_UPDATEUSER_COLUMN_NAME, EXTENSION_CLASS_VERSION_FIELD_NAME, EXTENSION_CLASS_VIEW_DEFINITION, EXTENSION_CLASS_VIEW_IMPORTS, EXTENSION_INDEX_COLUMN_ORDERING, EXTENSION_MEMBER_CACHEABLE, EXTENSION_MEMBER_CALENDAR_ONE_COLUMN, EXTENSION_MEMBER_CASCADE_ATTACH, EXTENSION_MEMBER_CASCADE_DETACH, EXTENSION_MEMBER_CASCADE_PERSIST, EXTENSION_MEMBER_CASCADE_REFRESH, EXTENSION_MEMBER_COMPARATOR_NAME, EXTENSION_MEMBER_CONTAINER_ALLOW_NULLS, EXTENSION_MEMBER_CREATE_TIMESTAMP, EXTENSION_MEMBER_CREATE_USER, EXTENSION_MEMBER_ENUM_VALUE_GETTER, EXTENSION_MEMBER_FETCH_FK_ONLY, EXTENSION_MEMBER_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_INSERTABLE, EXTENSION_MEMBER_KEY_IMPLEMENTATION_CLASSES, EXTENSION_MEMBER_LIST_ORDERING, EXTENSION_MEMBER_RELATION_DISCRIM_COLUMN, EXTENSION_MEMBER_RELATION_DISCRIM_PK, EXTENSION_MEMBER_RELATION_DISCRIM_VALUE, EXTENSION_MEMBER_STRATEGY_WHEN_NOTNULL, EXTENSION_MEMBER_TYPE_CONVERTER_DISABLED, EXTENSION_MEMBER_TYPE_CONVERTER_NAME, EXTENSION_MEMBER_UPDATE_TIMESTAMP, EXTENSION_MEMBER_UPDATE_USER, EXTENSION_MEMBER_UPDATEABLE, EXTENSION_MEMBER_VALUE_IMPLEMENTATION_CLASSES, EXTENSION_VERSION_NUMBER_INITIAL_VALUE, extensions, metaDataState, parent, VENDOR_NAME
-
-
Constructor Summary
Constructors Constructor Description FetchPlanMetaData(String name)
Constructor for a fetch plan with a name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addFetchGroup(FetchGroupMetaData fgmd)
Add a new FetchGroupMetaDataFetchGroupMetaData[]
getFetchGroupMetaData()
Accessor for fetchGroupMetaDataint
getFetchSize()
int
getMaxFetchDepth()
String
getName()
Accessor for nameint
getNumberOfFetchGroups()
FetchGroupMetaData
newFetchGroupMetaData(String name)
Method to create a new FetchGroup metadata, add it and return it.FetchPlanMetaData
setFetchSize(int fetchSize)
FetchPlanMetaData
setFetchSize(String fetchSize)
FetchPlanMetaData
setMaxFetchDepth(int maxFetchDepth)
FetchPlanMetaData
setMaxFetchDepth(String maxFetchDepth)
-
Methods inherited from class org.datanucleus.metadata.MetaData
addExtension, addExtensions, getExtensions, getMetaDataManager, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, removeExtension, setExtensions, setParent
-
-
-
-
Field Detail
-
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 Detail
-
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 Detail
-
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
-
-