org.objectweb.speedo.metadata
Class SpeedoFetchGroup

java.lang.Object
  extended byorg.objectweb.speedo.metadata.SpeedoElement
      extended byorg.objectweb.speedo.metadata.SpeedoFetchGroup

public class SpeedoFetchGroup
extends SpeedoElement

Author:
Y.Bersihand

Field Summary
 int depth
          Recursive fetch group references are controlled by the depth attribute.
static byte DEPTH_DEFINED
           
static java.lang.String FG_AT
           
static byte FG_DEFINED
           
static java.lang.String FG_DOT
           
static java.lang.String FG_ELEMENT
           
static java.lang.String FG_KEY
           
static java.lang.String FG_SHARP
           
static java.lang.String FG_SLASH
           
static java.lang.String FG_VALUE
           
protected  java.util.Map jdoFetchGroups
          The list of nested fetchgroups.
protected  java.util.Map jdoFields
          The list of fields declared to be in this fetch group.
 java.lang.String name
          The name of the fetch group.
static byte NOTHING_DEFINED
           
 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.
 
Fields inherited from class org.objectweb.speedo.metadata.SpeedoElement
jdoExtension
 
Constructor Summary
SpeedoFetchGroup()
           
 
Method Summary
 void addFetchGroup(java.lang.Object fetchGroup)
          Add a new FetchGroupMetaData
 void addField(java.lang.Object field)
          Add a new SpeedoField
 int getDepth()
           
 java.util.Map getFields()
           
 java.util.Set getFieldsToLoad()
           
 java.lang.String getName()
           
 java.util.Map getNestedFetchGroups()
           
 boolean getPostLoad()
           
 java.lang.String toString()
           
 
Methods inherited from class org.objectweb.speedo.metadata.SpeedoElement
addExtension, getExtension, getExtensionByKey, getExtensionValueByKey
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FG_AT

public static final java.lang.String FG_AT
See Also:
Constant Field Values

FG_SHARP

public static final java.lang.String FG_SHARP
See Also:
Constant Field Values

FG_DOT

public static final java.lang.String FG_DOT
See Also:
Constant Field Values

FG_KEY

public static final java.lang.String FG_KEY
See Also:
Constant Field Values

FG_VALUE

public static final java.lang.String FG_VALUE
See Also:
Constant Field Values

FG_ELEMENT

public static final java.lang.String FG_ELEMENT
See Also:
Constant Field Values

FG_SLASH

public static final java.lang.String FG_SLASH
See Also:
Constant Field Values

NOTHING_DEFINED

public static final byte NOTHING_DEFINED
See Also:
Constant Field Values

DEPTH_DEFINED

public static final byte DEPTH_DEFINED
See Also:
Constant Field Values

FG_DEFINED

public static final byte FG_DEFINED
See Also:
Constant Field Values

name

public java.lang.String name
The name of the fetch group.


jdoFetchGroups

protected java.util.Map jdoFetchGroups
The list of nested fetchgroups.


jdoFields

protected java.util.Map jdoFields
The list of fields declared to be in this fetch group.


depth

public int depth
Recursive fetch group references are controlled by the depth attribute. A depth of 0 (the default) will fetch the whole graph of instances reachable from this field.


postLoad

public 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. It defaults to false, for all fetch groups except the default fetch group, on which it defaults to true.

Constructor Detail

SpeedoFetchGroup

public SpeedoFetchGroup()
Method Detail

getDepth

public int getDepth()
Returns:
Return the depth.

getName

public java.lang.String getName()
Returns:
Returns the name of the fetchgroup

getPostLoad

public boolean getPostLoad()
Returns:
Returns the postLoad.

getFields

public java.util.Map getFields()
Returns:
Return the map of fields.

getNestedFetchGroups

public java.util.Map getNestedFetchGroups()
Returns:
Returns the map of nested fetch groups

addFetchGroup

public void addFetchGroup(java.lang.Object fetchGroup)
Add a new FetchGroupMetaData

Parameters:
fetchGroup - is the group to add

addField

public void addField(java.lang.Object field)
Add a new SpeedoField

Parameters:
field - is the field to add

getFieldsToLoad

public java.util.Set getFieldsToLoad()
Returns:
the set of the names of the fields to load with this fetchgroup

toString

public java.lang.String toString()