|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A JDOField instance represents the JDO metadata of a managed field of a persistence-capable class.
Method Summary | |
JDOArray |
createJDOArray()
Creates and returns a new JDOArray instance. |
JDOCollection |
createJDOCollection()
Creates and returns a new JDOCollection instance. |
JDOMap |
createJDOMap()
Creates and returns a new JDOMap instance. |
JDOReference |
createJDOReference()
Creates and returns a new JDOReference instance. |
int |
getFieldNumber()
Returns the absolute field number of this JDOField. |
JavaField |
getJavaField()
Get the corresponding Java field representation for this JDOField. |
java.lang.String |
getMappedByName()
Get the name of the field specified in a mappedBy attribute in the metadata. |
int |
getNullValueTreatment()
Gets the null value treatment indicator of this JDOField. |
int |
getPersistenceModifier()
Get the persistence modifier of this JDOField. |
JDORelationship |
getRelationship()
Get the relationship information for this JDOField. |
int |
getRelativeFieldNumber()
Returns the relative field number of this JDOField. |
JavaType |
getType()
Get the JavaType representation of the type of the field. |
boolean |
isDefaultFetchGroup()
Determines whether this JDOField is part of the default fetch group or not. |
boolean |
isEmbedded()
Determines whether the field should be stored if possible as part of the instance instead of as its own instance in the datastore. |
boolean |
isManaged()
Convenience method to check the persistence modifier from this JDOField. |
boolean |
isPersistent()
Convenience method to check the persistence modifier from this JDOField. |
boolean |
isPrimaryKey()
Determines whether this JDOField is a key field or not. |
boolean |
isProperty()
Convenience method to check whether this field represents a property. |
boolean |
isRelationship()
Convenience method to check whether this field is a relationship field. |
boolean |
isSerializable()
Determines whether this JDOField is serializable or not. |
boolean |
isTransactional()
Convenience method to check the persistence modifier from this JDOField. |
void |
setDefaultFetchGroup(boolean defaultFetchGroup)
Set whether this JDOField is part of the default fetch group or not. |
void |
setEmbedded(boolean embedded)
Set whether the field should be stored if possible as part of the instance instead of as its own instance in the datastore. |
void |
setJavaField(JavaField javaField)
Sets the corresponding Java field representation for this JDOField. |
void |
setMappedByName(java.lang.String mappedByName)
Set the name of the field specified in a mappedBy attribute in the metadata. |
void |
setNullValueTreatment(int nullValueTreament)
Sets the null value treatment indicator for this JDOField. |
void |
setPersistenceModifier(int persistenceModifier)
Set the persistence modifier for this JDOField. |
void |
setPrimaryKey(boolean primaryKey)
Set whether this JDOField is a key field or not. |
void |
setRelationship(JDORelationship relationship)
Set the relationship information for this JDOField. |
void |
setSerializable(boolean serializable)
Set whether this JDOField is serializable or not. |
Methods inherited from interface org.apache.jdo.model.jdo.JDOMember |
getDeclaringClass, getName |
Methods inherited from interface org.apache.jdo.model.jdo.JDOElement |
addPropertyChangeListener, addVetoableChangeListener, createJDOExtension, getJDOExtensions, removeJDOExtension, removePropertyChangeListener, removeVetoableChangeListener |
Methods inherited from interface java.lang.Comparable |
compareTo |
Method Detail |
public int getPersistenceModifier()
PersistenceModifier.UNSPECIFIED
,
PersistenceModifier.NONE
,
PersistenceModifier.PERSISTENT
,
PersistenceModifier.TRANSACTIONAL
,
PersistenceModifier.POSSIBLY_PERSISTENT
.public void setPersistenceModifier(int persistenceModifier) throws ModelException
persistenceModifier
- an integer indicating the persistence
modifier, one of: PersistenceModifier.UNSPECIFIED
,
PersistenceModifier.NONE
,
PersistenceModifier.PERSISTENT
,
PersistenceModifier.TRANSACTIONAL
,
PersistenceModifier.POSSIBLY_PERSISTENT
.
ModelException
- if impossiblepublic boolean isPrimaryKey()
true
if the field is a key field,
false
otherwisepublic void setPrimaryKey(boolean primaryKey) throws ModelException
primaryKey
- if true
, the JDOField is marked
as a key field; otherwise, it is not
ModelException
- if impossiblepublic int getNullValueTreatment()
NullValueTreatment.NONE
, NullValueTreatment.EXCEPTION
or
NullValueTreatment.DEFAULT
public void setNullValueTreatment(int nullValueTreament) throws ModelException
nullValueTreament
- an integer indicating the null value treatment,
one of: NullValueTreatment.NONE
,
NullValueTreatment.EXCEPTION
or
NullValueTreatment.DEFAULT
ModelException
- if impossiblepublic boolean isDefaultFetchGroup()
true
if the field is part of the default fetch
group, false
otherwisepublic void setDefaultFetchGroup(boolean defaultFetchGroup) throws ModelException
defaultFetchGroup
- if true
, the JDOField is marked
as beeing part of the default fetch group; otherwise, it is not
ModelException
- if impossiblepublic boolean isEmbedded()
true
if the field is stored as part of the instance;
false
otherwisepublic void setEmbedded(boolean embedded) throws ModelException
embedded
- true
if the field is stored as part of the
instance; false
otherwise
ModelException
- if impossiblepublic boolean isSerializable()
true
if the field is serializable,
false
otherwisepublic void setSerializable(boolean serializable) throws ModelException
serializable
- if true
, the JDOField is serializable;
otherwise, it is not
ModelException
- if impossiblepublic java.lang.String getMappedByName()
null
if the metadata for this
field does not specify the mappedBy attribute. Note that this
can be provided at the field level to help population of the model,
but should only be specified on a field that has a corresponding
relationship.
null
otherwise.public void setMappedByName(java.lang.String mappedByName) throws ModelException
mappedByName
- the mappedBy field name.
ModelException
- if impossiblepublic JavaField getJavaField()
public void setJavaField(JavaField javaField) throws ModelException
javaField
- the corresponding Java field representation
ModelException
- if impossiblepublic JDORelationship getRelationship()
null
if
this JDOField is not a relationshippublic void setRelationship(JDORelationship relationship) throws ModelException
relationship
- the JDORelationship instance
ModelException
- if impossiblepublic JDOReference createJDOReference() throws ModelException
getRelationship()
returns the new created instance
this.getRelationship().getDeclaringField() == this
ModelException
- if impossiblepublic JDOCollection createJDOCollection() throws ModelException
getRelationship()
returns the new created instance
this.getRelationship().getDeclaringField() == this
ModelException
- if impossiblepublic JDOArray createJDOArray() throws ModelException
getRelationship()
returns the new created instance
this.getRelationship().getDeclaringField() == this
ModelException
- if impossiblepublic JDOMap createJDOMap() throws ModelException
getRelationship()
returns the new created instance
this.getRelationship().getDeclaringField() == this
ModelException
- if impossiblepublic boolean isPersistent()
true
if this field has the
PersistenceModifier.PERSISTENT
modifier; false
otherwisepublic boolean isTransactional()
true
if this field has the
PersistenceModifier.TRANSACTIONAL
modifier; false
otherwisepublic boolean isManaged()
PersistenceModifier.PERSISTENT
or
PersistenceModifier.TRANSACTIONAL
.
true
if this field is a managed field;
false
otherwisepublic boolean isRelationship()
true
if this field is a relationship;
false
otherwisepublic boolean isProperty()
true
if this field represents a property;
false
otherwisepublic JavaType getType()
public int getFieldNumber()
public int getRelativeFieldNumber()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |