org.datanucleus.metadata

Class FetchGroupMetaData

java.lang.Object

org.datanucleus.metadata.MetaData

org.datanucleus.metadata.FetchGroupMetaData

All Implemented Interfaces:

Serializable

public class FetchGroupMetaData
extends MetaData

A fetch group defines a particular loaded state for an object graph. It specifies fields/properties to be loaded for all of the instances in the graph when this fetch group is active.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<FetchGroupMetaData>	fetchGroups A contained fetch-group element indicates that the named group is to be included in the group being defined.
protected Set<FetchGroupMemberMetaData>	members members (fields/properties) declared to be in this fetch group.

Fields inherited from class org.datanucleus.metadata.MetaData

extensions, LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent, VENDOR_NAME, VENDOR_NAME_OLD

Constructor Summary

Constructors

Constructor and Description
FetchGroupMetaData(String name) Constructor for a named fetch group.

Method Summary

Modifier and Type	Method and Description
void	addFetchGroup(FetchGroupMetaData fgmd) Add a new FetchGroupMetaData
void	addMember(FetchGroupMemberMetaData fgmmd) Add a new field/property.
Set<FetchGroupMetaData>	getFetchGroups()
Set<FetchGroupMemberMetaData>	getMembers() Accessor for metadata for the members of this group.
String	getName()
int	getNumberOfMembers()
Boolean	getPostLoad()
FetchGroupMemberMetaData	newMemberMetaData(String name) Method to create a new member, add it, and return it.
FetchGroupMetaData	setPostLoad(Boolean postLoad)
String	toString(String prefix, String indent) Returns a string representation of the object.

Methods inherited from class org.datanucleus.metadata.MetaData

addExtension, addExtension, assertIfInitialised, getExtensions, getNoOfExtensions, getParent, getValueForExtension, getValuesForExtension, hasExtension, initialise, isInitialised, isPopulated, isUsed, newExtensionMetaData, removeExtension, setParent, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

fetchGroups

protected Set<FetchGroupMetaData> fetchGroups

A contained fetch-group element indicates that the named group is to be included in the group being defined. Nested fetch group elements are limited to only the name attribute.

members

protected Set<FetchGroupMemberMetaData> members

members (fields/properties) declared to be in this fetch group.

Constructor Detail

FetchGroupMetaData

public FetchGroupMetaData(String name)

Constructor for a named fetch group. Set fields using setters, before populate().

Parameters:

name - Name of fetch group

Method Detail

getName

public final String getName()

getPostLoad

public final Boolean getPostLoad()

setPostLoad

public FetchGroupMetaData setPostLoad(Boolean postLoad)

getFetchGroups

public final Set<FetchGroupMetaData> getFetchGroups()

getMembers

public final Set<FetchGroupMemberMetaData> getMembers()

Accessor for metadata for the members of this group.

Returns:

Returns the metadata for members

getNumberOfMembers

public int getNumberOfMembers()

addFetchGroup

public void addFetchGroup(FetchGroupMetaData fgmd)

Add a new FetchGroupMetaData

Parameters:

fgmd - the fetch group

addMember

public void addMember(FetchGroupMemberMetaData fgmmd)

Add a new field/property.

Parameters:

fgmmd - the field/property metadata

newMemberMetaData

public FetchGroupMemberMetaData newMemberMetaData(String name)

Method to create a new member, add it, and return it.

Returns:

The field metadata

toString

public String toString(String prefix,
                       String indent)

Returns a string representation of the object. This can be used as part of a facility to output a MetaData file.

Overrides:

toString in class MetaData

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.