|
| |
|
| java.lang.Object
 org.jpox.metadata.MetaData
org.jpox.metadata.FetchGroupMetaData
| FetchGroupMetaData | | public class FetchGroupMetaData extends MetaData (Code) | | 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.
since:
1.1
version:
$Revision: 1.12 $ |
| Field Summary | |
| protected FetchGroupMetaData[] | fetchGroupMetaData
A contained fetch-group element indicates that the named group is to be
included in the group being defined. | | protected List | fetchGroups
A contained fetch-group element indicates that the named group is to be
included in the group being defined. | | protected AbstractMemberMetaData[] | memberMetaData
members declared to be in this fetch group. | | protected List | members
members (fields/properties) declared to be in this fetch group. | | final String | name
The name attribute on a field element contained within a fetch-group
element is the name of field in the enclosing class or a dot-separated
expression identifying a field reachable from the class by navigating a
reference, collection or map. | | Boolean | postLoad
The post-load attribute on the fetch-group element indicates whether the
jdoPost-Load callback will be made when the fetch group is loaded. |
| fetchGroupMetaData | | protected FetchGroupMetaData[] fetchGroupMetaData(Code) | | 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.
|
| fetchGroups | | protected List fetchGroups(Code) | | 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 List members(Code) | | members (fields/properties) declared to be in this fetch group.
|
| name | | final String name(Code) | | The name attribute on a field element contained within a fetch-group
element is the name of field in the enclosing class or a dot-separated
expression identifying a field reachable from the class by navigating a
reference, collection or map. For maps of persistencecapable classes
"#key" or "#value" may be appended to the name of the map field to
navigate the key or value respectively (e.g. to include a field of the
key class or value class in the fetch group).
For collection and arrays of persistence-capable classes, "#element" may
be appended to the name of the field to navigate the element. This is
optional; if omitted for collections and arrays, #element is assumed.
|
| postLoad | | Boolean postLoad(Code) | | The post-load attribute on the fetch-group element indicates whether the
jdoPost-Load callback will be made when the fetch group is loaded. It
defaults to false, for all fetch groups except the default fetch group,
on which it defaults to true.
|
| FetchGroupMetaData | | public FetchGroupMetaData(MetaData parent, String postLoad, String name)(Code) | | Constructor.
Parameters:
parent - The parent MetaData
Parameters:
postLoad - Whether to use at post load
Parameters:
name - Name of fetch group |
| addFetchGroup | | public void addFetchGroup(FetchGroupMetaData fgmd)(Code) | | Add a new FetchGroupMetaData
Parameters:
fgmd - the fetch group |
| getFetchGroupMetaData | | final public FetchGroupMetaData[] getFetchGroupMetaData()(Code) | | Accessor for fetchGroupMetaData
Returns the fetchGroupMetaData. |
| getMemberMetaData | | final public AbstractMemberMetaData[] getMemberMetaData()(Code) | | Accessor for metadata for the members of this group.
Returns the metadata for members |
| getName | | final public String getName()(Code) | | Accessor for name
Returns the name. |
| getPostLoad | | final public Boolean getPostLoad()(Code) | | Accessor for postLoad
Returns the postLoad. |
| initialise | | public void initialise()(Code) | | Initialisation method. This should be called AFTER using the populate
method if you are going to use populate. It creates the internal
convenience arrays etc needed for normal operation.
|
| toString | | public String toString(String prefix, String indent)(Code) | | Returns a string representation of the object.
This can be used as part of a facility to output a MetaData file.
Parameters:
prefix - prefix string
Parameters:
indent - indent string a string representation of the object. |
|
|
|