|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.objectweb.speedo.metadata.SpeedoElement
org.objectweb.speedo.metadata.SpeedoCommonField
org.objectweb.speedo.metadata.SpeedoField
public class SpeedoField
This class corresponds to the description of persistent fields.
Field Summary | |
---|---|
boolean |
defaultFetchGroup
This boolean indicates if the field is in the default fetch group. |
int |
depth
Recursive fetchgroups are controlled by the depth attribute. |
boolean |
embedded
Attribute embedded of the XML file. |
java.lang.String |
fetchGroup
|
boolean |
isCascadeDelete
Indicates if the field has to be deleted when its referencer is deleted. |
boolean |
isCoherentReverseField
Indicates if the coherence of bidirectional relationship must be assumed by Speedo. |
static byte |
MANY_MANY_BI_RELATION
|
static byte |
MANY_ONE_BI_RELATION
|
static byte |
MANY_REFERENCE
|
boolean |
mappedByReversefield
In case of bi directional relationship the mapping of this field can be defined since the mapping of the reverse field. |
static byte |
NO_BI_RELATION
|
static byte |
NONE
|
byte |
nullValue
Attribute null-value in the XML file. |
int |
number
is the index of the persistent field. |
static byte |
ONE_MANY_BI_RELATION
|
static byte |
ONE_ONE_BI_RELATION
|
static byte |
ONE_REFERENCE
|
static java.lang.String[] |
PERSISTENCE_STATUS
|
byte |
persistenceStatus
Attribute persistence-modifier in the XML file. |
static byte |
PERSISTENT
|
boolean |
primaryKey
Boolean indicating if the field is a primary key. |
static byte |
PROPAG_ALL
|
static byte |
PROPAG_MERGE
|
static byte |
PROPAG_NONE
|
static byte |
PROPAG_PERSIST
|
static byte |
PROPAG_REFRESH
|
static byte |
PROPAG_REMOVE
|
byte |
propagate
Specify the kind of persistence characteristic should be propagated through this field (PERSIST | MERGE | REMOVE | REFRESH). |
byte |
relationType
Type of the relation containinig the persistent field |
java.lang.String |
reverseField
Is the name of the field which composes with the current field, a bidirectional relation ship. |
java.lang.String |
sequence
Attribute sequence |
java.lang.String |
type
Type of the persistent field |
static byte |
UNKNOWN
|
java.lang.String |
valueStrategy
Attribute value-strategy |
int |
visibility
visibility of the field (public | protected | private | static ...) |
Fields inherited from class org.objectweb.speedo.metadata.SpeedoCommonField |
---|
columns, jdoTuple, join, moClass, name |
Fields inherited from class org.objectweb.speedo.metadata.SpeedoElement |
---|
jdoExtension, personality |
Constructor Summary | |
---|---|
SpeedoField()
|
Method Summary | |
---|---|
void |
addColumn(SpeedoColumn col)
|
java.lang.String |
getClassName()
|
SpeedoField |
getFieldOfTheReferencedClass(java.lang.String fieldName)
|
SpeedoClass |
getReferencedClass()
|
SpeedoField |
getReverseField()
|
java.lang.String |
getSourceDesc()
|
java.lang.String |
modifier()
Returns the field's modifier |
static java.lang.String |
parsePersistenceStatus(byte ps)
|
static byte |
parsePersistenceStatus(java.lang.String s)
|
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.SpeedoCommonField |
---|
getFKColumn, getFKJoinColumn, getFQFieldName, getJoinColumn, printColumns |
Methods inherited from class org.objectweb.speedo.metadata.SpeedoElement |
---|
addExtension, addInArray, getExtension, getExtensionByKey, getExtensionValueByKey, indexOfInArray, removeInArray, setValueInArray |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final byte PROPAG_NONE
public static final byte PROPAG_PERSIST
public static final byte PROPAG_MERGE
public static final byte PROPAG_REMOVE
public static final byte PROPAG_REFRESH
public static final byte PROPAG_ALL
public static final byte NO_BI_RELATION
public static final byte ONE_ONE_BI_RELATION
public static final byte ONE_MANY_BI_RELATION
public static final byte MANY_ONE_BI_RELATION
public static final byte MANY_MANY_BI_RELATION
public static final byte ONE_REFERENCE
public static final byte MANY_REFERENCE
public static final byte UNKNOWN
public static final byte NONE
public static final byte PERSISTENT
public static final java.lang.String[] PERSISTENCE_STATUS
public int visibility
Constants.ACC_PUBLIC
,
Constants.ACC_PRIVATE
,
Constants.ACC_PROTECTED
,
Constants.ACC_STATIC
,
Constants.ACC_FINAL
,
Constants.ACC_TRANSIENT
public byte propagate
PROPAG_ALL
,
PROPAG_PERSIST
,
PROPAG_MERGE
,
PROPAG_REMOVE
,
PROPAG_REFRESH
,
PROPAG_NONE
public java.lang.String type
Type.getDescriptor()
public int number
public byte persistenceStatus
public boolean primaryKey
public byte nullValue
public boolean defaultFetchGroup
public int depth
public java.lang.String fetchGroup
public boolean embedded
public java.lang.String valueStrategy
public java.lang.String sequence
public byte relationType
NO_BI_RELATION
,
ONE_ONE_BI_RELATION
,
ONE_MANY_BI_RELATION
,
MANY_ONE_BI_RELATION
,
MANY_MANY_BI_RELATION
public java.lang.String reverseField
public boolean isCoherentReverseField
public boolean isCascadeDelete
public boolean mappedByReversefield
SpeedoCommonField.columns
,
SpeedoCommonField.join
Constructor Detail |
---|
public SpeedoField()
Method Detail |
---|
public static byte parsePersistenceStatus(java.lang.String s)
s
- is a string representation of a persistence status
public static java.lang.String parsePersistenceStatus(byte ps)
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String publicSignature()
public java.lang.String privateSignature()
public java.lang.String modifier()
public
,
private
, protected
)public java.lang.String type()
public SpeedoField getReverseField() throws SpeedoException
SpeedoException
public SpeedoField getFieldOfTheReferencedClass(java.lang.String fieldName) throws SpeedoException
SpeedoException
public java.lang.String getSourceDesc()
getSourceDesc
in class SpeedoCommonField
public void addColumn(SpeedoColumn col)
addColumn
in class SpeedoCommonField
public java.lang.String getClassName()
public SpeedoClass getReferencedClass()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |