org.objectweb.speedo.metadata
Class SpeedoField

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

public class SpeedoField
extends SpeedoElement

This class corresponds to the description of persistent capable fields.

Author:
S.Chassande-Barrioz

Field Summary
 int access
          modifier of the field (public | protected | private)
 boolean defaultFetchGroup
          This boolean indicates if the field is in the default fetch group.
 int depth
          Recursive fetchgroups are controlled by the depth attribute.
 java.lang.String desc
          Type of the persistent field
 boolean embedded
          Attribute embedded of the XML file.
 java.lang.String fetchGroup
           
 SpeedoClass jdoClass
          Description of the class containing the field.
 SpeedoTuple jdoTuple
          Type of the tuple represented by this SpeedoField if it is a tuple
static byte MANY_MANY_RELATION
           
static byte MANY_ONE_RELATION
           
 java.lang.String name
          name of the persistent field
static byte NO_RELATION
           
 byte nullValue
          Attribute null-value in the XML file.
 int number
          is the index of the persistent field.
static byte ONE_MANY_RELATION
           
static byte ONE_ONE_RELATION
           
 byte persistenceModifier
          Attribute persistence-modifier in the XML file.
 boolean primaryKey
          Boolean indicating if the field is a primary key.
 byte relationType
          Type of the relation containinig the persistent field
 java.lang.String sequence
          Attribute sequence
 java.lang.String valueStrategy
          Attribute value-strategy
 
Fields inherited from class org.objectweb.speedo.metadata.SpeedoElement
jdoExtension
 
Constructor Summary
SpeedoField()
           
 
Method Summary
 java.lang.String modifier()
          Returns the field's modifier
 java.lang.String privateSignature()
          Returns the field's signature with a private modifier.
 java.lang.String publicSignature()
          Returns the field's signature with a public modifier.
 java.lang.String toString()
          Transforms a SpeedoField into a String.
 java.lang.String type()
          Returns the type of the field.
 
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

NO_RELATION

public static final byte NO_RELATION
See Also:
Constant Field Values

ONE_ONE_RELATION

public static final byte ONE_ONE_RELATION
See Also:
Constant Field Values

ONE_MANY_RELATION

public static final byte ONE_MANY_RELATION
See Also:
Constant Field Values

MANY_ONE_RELATION

public static final byte MANY_ONE_RELATION
See Also:
Constant Field Values

MANY_MANY_RELATION

public static final byte MANY_MANY_RELATION
See Also:
Constant Field Values

name

public java.lang.String name
name of the persistent field


access

public int access
modifier of the field (public | protected | private)


desc

public java.lang.String desc
Type of the persistent field


number

public int number
is the index of the persistent field. This field is computed through a MI visitor.


persistenceModifier

public byte persistenceModifier
Attribute persistence-modifier in the XML file.


primaryKey

public boolean primaryKey
Boolean indicating if the field is a primary key.


nullValue

public byte nullValue
Attribute null-value in the XML file.


defaultFetchGroup

public boolean defaultFetchGroup
This boolean indicates if the field is in the default fetch group. (not managed)


depth

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


fetchGroup

public java.lang.String fetchGroup

embedded

public boolean embedded
Attribute embedded of the XML file. (not managed)


valueStrategy

public java.lang.String valueStrategy
Attribute value-strategy


sequence

public java.lang.String sequence
Attribute sequence


relationType

public byte relationType
Type of the relation containinig the persistent field

See Also:
NO_RELATION, ONE_ONE_RELATION, ONE_MANY_RELATION, MANY_ONE_RELATION, MANY_MANY_RELATION

jdoTuple

public SpeedoTuple jdoTuple
Type of the tuple represented by this SpeedoField if it is a tuple


jdoClass

public SpeedoClass jdoClass
Description of the class containing the field.

Constructor Detail

SpeedoField

public SpeedoField()
Method Detail

toString

public java.lang.String toString()
Transforms a SpeedoField into a String.

Returns:
the String corresponding to the SpeedoField.

publicSignature

public java.lang.String publicSignature()
Returns the field's signature with a public modifier.

Returns:
the String containing the field' signature with a public modifier.

privateSignature

public java.lang.String privateSignature()
Returns the field's signature with a private modifier.

Returns:
the String containing the field' signature with a private modifier.

modifier

public java.lang.String modifier()
Returns the field's modifier

Returns:
the String representing the modifier (public, private, protected)

type

public java.lang.String type()
Returns the type of the field.

Returns:
type of the field.