Package org.datanucleus.metadata
Class FetchPlanMetaData
java.lang.Object
org.datanucleus.metadata.MetaData
org.datanucleus.metadata.FetchPlanMetaData
- All Implemented Interfaces:
Serializable
FetchPlan defined in MetaData.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List
<FetchGroupMetaData> Series of Fetch Groups used in this FetchPlan.protected int
Fetch Size for use when querying using this FetchPlan.protected int
Max fetch depth for this FetchPlan.(package private) String
Name of the FetchPlan.private static final long
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_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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a new FetchGroupMetaDatafinal FetchGroupMetaData[]
Accessor for fetchGroupMetaDatafinal int
final int
final String
getName()
Accessor for nameint
newFetchGroupMetaData
(String name) Method to create a new FetchGroup metadata, add it and return it.setFetchSize
(int fetchSize) setFetchSize
(String fetchSize) setMaxFetchDepth
(int maxFetchDepth) 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, setInitialised, setParent, setPopulated, setUsed
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
name
String nameName of the FetchPlan. -
maxFetchDepth
protected int maxFetchDepthMax fetch depth for this FetchPlan. -
fetchSize
protected int fetchSizeFetch Size for use when querying using this FetchPlan. -
fetchGroups
Series of Fetch Groups used in this FetchPlan. Only used during construction.
-
-
Constructor Details
-
FetchPlanMetaData
Constructor for a fetch plan with a name. Set fields using setters, before populate().- Parameters:
name
- Name of fetch plan
-
-
Method Details
-
getName
Accessor for name- Returns:
- Returns the name.
-
getMaxFetchDepth
public final int getMaxFetchDepth() -
setMaxFetchDepth
-
setMaxFetchDepth
-
getFetchSize
public final int getFetchSize() -
getNumberOfFetchGroups
public int getNumberOfFetchGroups() -
setFetchSize
-
setFetchSize
-
getFetchGroupMetaData
Accessor for fetchGroupMetaData- Returns:
- Returns the fetchGroupMetaData.
-
addFetchGroup
Add a new FetchGroupMetaData- Parameters:
fgmd
- the fetch group
-
newFetchGroupMetaData
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
-