|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jdo.impl.model.jdo.JDOElementImpl
org.apache.jdo.impl.model.jdo.JDOMemberImpl
org.apache.jdo.impl.model.jdo.JDOFieldImplDynamic
An instance of this class represents the JDO metadata of a managed field of a persistence capable class. This dynamic implementation only stores property values explicitly set by setter method.
Please note, you cannot rely on the Java identity of the
JDORelationship instance returned by getRelationship()
.
The getter will always return a new Java Instance, unless the
relationship is explicitly set by the setter
setRelationship(JDORelationship relationship)
.
TBD:
Field Summary | |
protected java.lang.Boolean |
defaultFetchGroup
Property defaultFetchGroup. |
protected java.lang.Boolean |
embedded
Property embedded. |
protected JavaField |
javaField
Property javaField. |
private java.lang.String |
mappedByName
Property mappedByName. |
protected static I18NHelper |
msg
I18N support |
private int |
nullValueTreatment
Property nullValueTreatment. |
protected int |
persistenceModifier
Property persistenceModifier. |
private boolean |
primaryKey
Property primaryKey. |
protected JDORelationship |
relationship
Relationship JDOField<->JDORelationship. |
private boolean |
serializable
Property serializable. |
Fields inherited from class org.apache.jdo.impl.model.jdo.JDOMemberImpl |
|
Fields inherited from class org.apache.jdo.impl.model.jdo.JDOElementImpl |
|
Constructor Summary | |
protected |
JDOFieldImplDynamic(java.lang.String name,
JDOClass declaringClass)
Constructor. |
Method Summary | |
JDOArray |
createJDOArray()
Creates and returns a new JDOArray instance. |
protected JDOArray |
createJDOArrayInternal()
Creates and returns a new JDOArray instance. |
JDOCollection |
createJDOCollection()
Creates and returns a new JDOCollection instance. |
protected JDOCollection |
createJDOCollectionInternal()
Creates and returns a new JDOCollection instance. |
JDOMap |
createJDOMap()
Creates and returns a new JDOMap instance. |
protected JDOMap |
createJDOMapInternal()
Creates and returns a new JDOMap instance. |
JDOReference |
createJDOReference()
Creates and returns a new JDOReference instance. |
protected JDOReference |
createJDOReferenceInternal()
Creates and returns a new JDOReference instance. |
int |
getFieldNumber()
Returns the absolute field number of this JDOField. |
JavaField |
getJavaField()
Get the corresponding JavaField 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. |
(package private) UnresolvedRelationshipHelper |
getUnresolvedRelationshipHelper()
Returns the UnresolvedRelationshipHelper instance from the declaring JDOModel instacne of the declaring JDOClass. |
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. |
private boolean |
nameHasJDOPrefix()
Returns true if the name of this JDOField has the
prefix jdo. |
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 nullValueTreatment)
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 class org.apache.jdo.impl.model.jdo.JDOMemberImpl |
compareTo, equals, getDeclaringClass, getName, hashCode, toString |
Methods inherited from class org.apache.jdo.impl.model.jdo.JDOElementImpl |
addPropertyChangeListener, addVetoableChangeListener, createJDOExtension, firePropertyChange, fireVetoableChange, getJDOExtensions, removeJDOExtension, removePropertyChangeListener, removeVetoableChangeListener |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
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 |
Field Detail |
protected int persistenceModifier
getPersistenceModifier()
.
private boolean primaryKey
false
.
private int nullValueTreatment
protected java.lang.Boolean defaultFetchGroup
isDefaultFetchGroup()
.
protected java.lang.Boolean embedded
isEmbedded()
.
protected transient JavaField javaField
private boolean serializable
false
.
private java.lang.String mappedByName
null
.
protected JDORelationship relationship
protected static final I18NHelper msg
Constructor Detail |
protected JDOFieldImplDynamic(java.lang.String name, JDOClass declaringClass)
Method Detail |
public int getPersistenceModifier()
getPersistenceModifier
in interface JDOField
PersistenceModifier.NONE
,
PersistenceModifier.PERSISTENT
,
PersistenceModifier.TRANSACTIONAL
, or
PersistenceModifier.POSSIBLY_PERSISTENT
.public void setPersistenceModifier(int persistenceModifier) throws ModelException
setPersistenceModifier
in interface JDOField
persistenceModifier
- an integer indicating the persistence
modifier, one of: PersistenceModifier.UNSPECIFIED
,
PersistenceModifier.NONE
,
PersistenceModifier.PERSISTENT
,
PersistenceModifier.TRANSACTIONAL
, or
PersistenceModifier.POSSIBLY_PERSISTENT
.
ModelException
- if impossiblepublic boolean isPrimaryKey()
isPrimaryKey
in interface JDOField
true
if the field is a key field,
false
otherwisepublic void setPrimaryKey(boolean primaryKey)
setPrimaryKey
in interface JDOField
primaryKey
- if true
, the JDOField is marked
as a key field; otherwise, it is notpublic int getNullValueTreatment()
getNullValueTreatment
in interface JDOField
NullValueTreatment.NONE
, NullValueTreatment.EXCEPTION
or
NullValueTreatment.DEFAULT
public void setNullValueTreatment(int nullValueTreatment)
setNullValueTreatment
in interface JDOField
nullValueTreatment
- an integer indicating the null
value treatment, one of: NullValueTreatment.NONE
,
NullValueTreatment.EXCEPTION
or
NullValueTreatment.DEFAULT
public boolean isDefaultFetchGroup()
isDefaultFetchGroup
in interface JDOField
true
if the field is part of the default fetch
group, false
otherwisepublic void setDefaultFetchGroup(boolean defaultFetchGroup)
setDefaultFetchGroup
in interface JDOField
defaultFetchGroup
- if true
, the JDOField is marked
as beeing part of the default fetch group; otherwise, it is notpublic boolean isEmbedded()
isEmbedded
in interface JDOField
true
if the field is stored as part of the instance;
false
otherwisepublic void setEmbedded(boolean embedded)
setEmbedded
in interface JDOField
embedded
- true
if the field is stored as part of the
instance; false
otherwisepublic JavaField getJavaField()
getJavaField
in interface JDOField
public void setJavaField(JavaField javaField) throws ModelException
setJavaField
in interface JDOField
javaField
- the corresponding Java field representation
ModelException
- if impossiblepublic boolean isSerializable()
isSerializable
in interface JDOField
true
if the field is serializable,
false
otherwisepublic void setSerializable(boolean serializable) throws ModelException
setSerializable
in interface JDOField
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.
getMappedByName
in interface JDOField
null
otherwise.public void setMappedByName(java.lang.String mappedByName) throws ModelException
setMappedByName
in interface JDOField
mappedByName
- the mappedBy field name.
ModelException
- if impossiblepublic JDORelationship getRelationship()
getRelationship
in interface JDOField
null
if
this JDOField is not a relationshippublic void setRelationship(JDORelationship relationship) throws ModelException
setRelationship
in interface JDOField
relationship
- the JDORelationship instance
ModelException
- if impossiblepublic JDOReference createJDOReference() throws ModelException
getRelationship()
returns the new created instance
this.getRelationship().getDeclaringField() == this
createJDOReference
in interface JDOField
ModelException
- if impossiblepublic JDOCollection createJDOCollection() throws ModelException
getRelationship()
returns the new created instance
this.getRelationship().getDeclaringField() == this
createJDOCollection
in interface JDOField
ModelException
- if impossiblepublic JDOArray createJDOArray() throws ModelException
getRelationship()
returns the new created instance
this.getRelationship().getDeclaringField() == this
createJDOArray
in interface JDOField
ModelException
- if impossiblepublic JDOMap createJDOMap() throws ModelException
getRelationship()
returns the new created instance
this.getRelationship().getDeclaringField() == this
createJDOMap
in interface JDOField
ModelException
- if impossiblepublic boolean isPersistent()
isPersistent
in interface JDOField
true
if this field has the
PersistenceModifier.PERSISTENT
modifier; false
otherwisepublic boolean isTransactional()
isTransactional
in interface JDOField
true
if this field has the
PersistenceModifier.TRANSACTIONAL
modifier; false
otherwisepublic boolean isManaged()
PersistenceModifier.PERSISTENT
or
PersistenceModifier.TRANSACTIONAL
.
isManaged
in interface JDOField
true
if this field is a managed field;
false
otherwisepublic boolean isRelationship()
isRelationship
in interface JDOField
true
if this field is a relationship;
false
otherwisepublic boolean isProperty()
isProperty
in interface JDOField
true
if this field represents a property;
false
otherwisepublic JavaType getType()
getType
in interface JDOField
public int getFieldNumber()
getFieldNumber
in interface JDOField
public int getRelativeFieldNumber()
getRelativeFieldNumber
in interface JDOField
protected JDOReference createJDOReferenceInternal()
protected JDOCollection createJDOCollectionInternal()
protected JDOArray createJDOArrayInternal()
protected JDOMap createJDOMapInternal()
private boolean nameHasJDOPrefix()
true
if the name of this JDOField has the
prefix jdo.
true
if the name of this JDOField has the
prefix jdo; false
otherwise.UnresolvedRelationshipHelper getUnresolvedRelationshipHelper()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |