|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jpox.metadata.MetaData
org.jpox.metadata.ExtendableMetaData
org.jpox.metadata.AbstractPropertyMetaData
The property element declares mapping between a virtual field of an implemented interface and the corresponding persistent field of a persistence-capable class. The name attribute is required, and declares the name for the property. The naming conventions for JavaBeans property names is used: the property name is the same as the corresponding get method for the property with the get removed and the resulting name lowercased. The field-name attribute is required; it associates a persistent field with the named property.
Field Summary | |
protected java.lang.String |
className
Name of the class to which this field really belongs. |
protected java.lang.String |
column
column tag value. |
protected ColumnMetaData[] |
columnMetaData
Contains the metadata for column(s). |
protected java.util.List |
columns
Columns ColumnMetaData |
protected ContainerMetaData |
container
Meta-Data of any container. |
static int |
DEFAULT_RECURSION_DEPTH
Default recursion-depth according to proposed final draft spec, [12.7.2]. |
protected java.lang.Boolean |
defaultFetchGroup
default-fetch-group tag value. |
protected java.lang.Boolean |
dependent
dependent tag value. |
protected ElementMetaData |
elementMetaData
ElementMetaData. |
protected java.lang.Boolean |
embedded
embedded tag value. |
protected EmbeddedMetaData |
embeddedMetaData
EmbeddedMetaData. |
protected int |
fieldId
Id of the field in its class (only for fields managed by JDO). |
protected java.lang.String |
fieldType
The field-type attribute is used to specify a more restrictive type than the field definition in the class. |
protected ForeignKeyMetaData |
foreignKeyMetaData
ForeignKeyMetaData. |
protected IndexedValue |
indexed
The indexing value |
protected IndexMetaData |
indexMetaData
IndexMetaData. |
protected JoinMetaData |
joinMetaData
JoinMetaData. |
protected KeyMetaData |
keyMetaData
KeyMetaData. |
protected java.lang.String |
loadFetchGroup
load-fetch-group value. |
protected java.lang.String |
mappedBy
mapped-by tag value. |
protected int |
modifiers
Field modifiers |
protected java.lang.String |
name
Field name. |
protected NullValue |
nullValue
null-value tag value (default is NONE). |
protected OrderMetaData |
orderMetaData
OrderMetaData. |
protected FieldPersistenceModifier |
persistenceModifier
persistence-modifier tag value. |
protected java.lang.Boolean |
primaryKey
primary key tag value. |
protected int |
recursionDepth
recursion-depth value. |
protected AbstractPropertyMetaData |
relatedFieldMetaData
FieldMetaData for the other end of a relation when this field is a bidirectional relation. |
protected int |
relationType
The relation type of this field (1-1, 1-N, M-N, N-1). |
protected java.lang.String |
sequence
If the value-strategy is sequence, the sequence attribute specifies the name of the sequence to use to automatically generate a value for the field. |
protected java.lang.Boolean |
serialized
serialized tag value. |
protected java.lang.String |
table
Table name for this field. |
protected java.lang.Class |
type
Field type being represented by this MetaData. |
static int |
UNDEFINED_RECURSION_DEPTH
Indicates the recursion-depth is not defined. |
protected boolean |
uniqueConstraint
Whether to add a unique constraint. |
protected UniqueMetaData |
uniqueMetaData
UniqueMetaData. |
protected ValueMetaData |
valueMetaData
ValueMetaData. |
protected IdentityStrategy |
valueStrategy
The value-strategy attribute specifies the strategy used to generate values for the field. |
Fields inherited from class org.jpox.metadata.ExtendableMetaData |
extensions, JPOX_VENDOR_NAME |
Fields inherited from class org.jpox.metadata.MetaData |
LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent |
Constructor Summary | |
AbstractPropertyMetaData(MetaData parent,
AbstractPropertyMetaData fmd)
Convenience constructor to copy the specification from the passed field. |
|
AbstractPropertyMetaData(MetaData parent,
java.lang.String name)
Convenience constructor taking defaults |
|
AbstractPropertyMetaData(MetaData parent,
java.lang.String name,
java.lang.String pk,
java.lang.String modifier,
java.lang.String defaultFetchGroup,
java.lang.String nullValue,
java.lang.String embedded,
java.lang.String serialized,
java.lang.String dependent,
java.lang.String mappedBy,
java.lang.String column,
java.lang.String table,
java.lang.String deleteAction,
java.lang.String indexed,
java.lang.String unique,
java.lang.String recursionDepth,
java.lang.String loadFetchGroup,
java.lang.String valueStrategy,
java.lang.String foreignKey,
java.lang.String sequence,
java.lang.String fieldType)
Constructor. |
Method Summary | |
void |
addColumn(ColumnMetaData colmd)
Add a new ColumnMetaData element |
int |
compareTo(java.lang.Object o)
Comparator method. |
boolean |
fieldBelongsToClass()
Accessor for whether the field is for a superclass, and not for this class. |
int |
getAbsoluteFieldNumber()
Accessor for the field id |
AbstractClassMetaData |
getAbstractClassMetaData()
Convenience accessor for the MetaData of the parent class. |
ArrayMetaData |
getArray()
Accessor for an array container for this field. |
java.lang.String |
getClassName()
Accessor for the fully-qualified class name owning this field. |
java.lang.String |
getClassName(boolean fully_qualified)
Convenience to return the class name that this a field of. |
CollectionMetaData |
getCollection()
Accessor for a collection container for this field. |
java.lang.String |
getColumn()
Accessor for the column |
ColumnMetaData[] |
getColumnMetaData()
Acessor for the columns |
ContainerMetaData |
getContainer()
Accessor for the container for this field. |
ElementMetaData |
getElementMetaData()
Accessor for elementMetaData |
EmbeddedMetaData |
getEmbeddedMetaData()
Accessor for embeddedMetaData |
int |
getFieldId()
Accessor for the field id. |
java.lang.String |
getFieldType()
Accessor for the implementation type(s) that can be stored in this field when it is a reference type. |
ForeignKeyMetaData |
getForeignKeyMetaData()
Accessor for foreignKeyMetaData |
java.lang.String |
getFullFieldName()
Accessor for the full field name. |
IndexMetaData |
getIndexMetaData()
Accessor for indexMetaData |
JoinMetaData |
getJoinMetaData()
Accessor for joinMetaData |
KeyMetaData |
getKeyMetaData()
Accessor for keyMetaData |
java.lang.String |
getLoadFetchGroup()
Accessor for the (additional) fetch group for loading this field |
MapMetaData |
getMap()
Accessor for a map container for this field. |
java.lang.String |
getMappedBy()
Accessor for mappedBy |
MetaDataManager |
getMetaDataManager()
Convenience accessor for the MetaData Manager in use. |
java.lang.String |
getName()
Accessor for the field name |
NullValue |
getNullValue()
Accessor for the null-value tag |
OrderMetaData |
getOrderMetaData()
Accessor for orderMetaData |
FieldPersistenceModifier |
getPersistenceModifier()
Accessor for the persistence-modifier tag value |
int |
getRecursionDepth()
Accessor for the depth of the fetch when recursing |
AbstractPropertyMetaData |
getRelatedFieldMetaData(ClassLoaderResolver clr)
Accessor for the FieldMetaData of any related field (where this field is part of a bidirectional relation). |
int |
getRelationType(ClassLoaderResolver clr)
Accessor for the relation type for this field. |
java.lang.String |
getSequence()
If the value-strategy is sequence, the sequence attribute specifies the name of the sequence to use to automatically generate a value for the field. |
java.lang.String |
getTable()
Accessor for the table name |
java.lang.Class |
getType()
Accessor for the field type |
java.lang.String |
getTypeName()
Accessor for the field type name |
UniqueMetaData |
getUniqueMetaData()
Accessor for uniqueMetaData |
ValueMetaData |
getValueMetaData()
Accessor for valueMetaData |
IdentityStrategy |
getValueStrategy()
The value-strategy attribute specifies the strategy used to generate values for the field. |
boolean |
hasArray()
Accessor for whether the field has an array |
boolean |
hasCollection()
Accessor for whether the field has a collection |
boolean |
hasContainer()
Accessor for whether the field has a container. |
boolean |
hasMap()
Accessor for whether the field has a map. |
void |
initialise()
Initialisation method. |
boolean |
isDefaultFetchGroup()
Accessor for the default-fetch-group tag value |
boolean |
isDependent()
Accessor for the dependent attribute indicates that the field contains a reference that is to be deleted from the datastore if the referring instance in which the field is declared is deleted, or if the referring field is nullified. |
boolean |
isEmbedded()
Accessor for the embedded tag value. |
boolean |
isFieldArrayTypePersistenceCapable()
Utility to return if this array field has elements that are PersistenceCapable. |
boolean |
isFieldTypePersistenceCapable()
Utility to return if this field is PersistenceCapable. |
boolean |
isFinal()
Convenience method to return if this field represents a final field. |
boolean |
isJdoField()
Accessor for whether the field is to be managed by JDO. |
boolean |
isPrimaryKey()
Accessor for the primary-key tag value. |
boolean |
isSerialized()
Accessor for the serialized tag value |
boolean |
isStatic()
Convenience method to return if this field represents a static field. |
boolean |
isTransient()
Convenience method to return if this field represents a transient field. |
void |
mergeORMData(AbstractPropertyMetaData ormFmd)
Method to merge in the associated metadata from the ORM definition |
void |
populate(ClassLoaderResolver clr,
java.lang.Class fieldType,
int modifiers)
Method to provide the details of the field being represented by this MetaData. |
void |
setContainer(ContainerMetaData conmd)
Method to set the container for this field (if this field represents a container (collection, map, array). |
void |
setDependent(boolean dependent)
Mutator for dependent attribute. |
void |
setElementMetaData(ElementMetaData elementMetaData)
Mutator for the element MetaData |
void |
setEmbeddedMetaData(EmbeddedMetaData embeddedMetaData)
Mutator for the embedded MetaData |
void |
setForeignKeyMetaData(ForeignKeyMetaData foreignKeyMetaData)
Mutator for the foreignKey MetaData |
void |
setIndexMetaData(IndexMetaData indexMetaData)
Mutator for the index MetaData |
void |
setJoinMetaData(JoinMetaData joinMetaData)
Mutator for the join MetaData |
void |
setKeyMetaData(KeyMetaData keyMetaData)
Mutator for the key MetaData |
void |
setMappedBy(java.lang.String mappedby)
Mutator for mappedBy |
void |
setOrderMetaData(OrderMetaData orderMetaData)
Mutator for the order MetaData |
protected void |
setRelation(ClassLoaderResolver clr)
Convenience method that sets up the relation type of this field, and the reference to any related field when it is bidirectional. |
void |
setSequence(java.lang.String sequence)
If the value-strategy is sequence, the sequence attribute specifies the name of the sequence to use to automatically generate a value for the field. |
void |
setTable(java.lang.String table)
Mutator for the table name |
void |
setUniqueMetaData(UniqueMetaData uniqueMetaData)
Mutator for the unique MetaData |
void |
setValueMetaData(ValueMetaData valueMetaData)
Mutator for the value MetaData |
void |
setValueStrategy(IdentityStrategy valueStrategy)
The value-strategy attribute specifies the strategy used to generate values for the field. |
java.lang.String |
toString()
Accessor for a string representation of the object. |
java.lang.String |
toString(java.lang.String prefix,
java.lang.String indent)
Returns a string representation of the object using a prefix This can be used as part of a facility to output a MetaData file. |
Methods inherited from class org.jpox.metadata.ExtendableMetaData |
addExtension, addExtension, getExtension, getExtensions, getNoOfExtensions, getValueForExtension, getValuesForExtension, getValuesForExtensionStartingWith, hasExtension, removeExtension |
Methods inherited from class org.jpox.metadata.MetaData |
getParent, isCreated, isInitialised, isPopulated, isUsed, populate, setInitialised, setPopulated, setUsed |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected ColumnMetaData[] columnMetaData
protected ContainerMetaData container
protected EmbeddedMetaData embeddedMetaData
protected JoinMetaData joinMetaData
protected ElementMetaData elementMetaData
protected KeyMetaData keyMetaData
protected ValueMetaData valueMetaData
protected IndexMetaData indexMetaData
protected IndexedValue indexed
protected UniqueMetaData uniqueMetaData
protected final boolean uniqueConstraint
protected OrderMetaData orderMetaData
protected ForeignKeyMetaData foreignKeyMetaData
protected java.lang.Boolean defaultFetchGroup
protected java.lang.String column
protected java.lang.String mappedBy
protected java.lang.Boolean embedded
protected java.lang.Boolean dependent
protected java.lang.Boolean serialized
protected final java.lang.String loadFetchGroup
public static final int DEFAULT_RECURSION_DEPTH
public static final int UNDEFINED_RECURSION_DEPTH
protected int recursionDepth
protected final java.lang.String name
protected NullValue nullValue
protected FieldPersistenceModifier persistenceModifier
protected java.lang.Boolean primaryKey
protected java.lang.String table
protected IdentityStrategy valueStrategy
protected java.lang.String sequence
protected java.lang.String className
protected java.lang.String fieldType
protected java.lang.Class type
protected int modifiers
protected int fieldId
protected int relationType
protected AbstractPropertyMetaData relatedFieldMetaData
protected java.util.List columns
Constructor Detail |
public AbstractPropertyMetaData(MetaData parent, java.lang.String name)
parent
- Parent componentname
- Name of the fieldpublic AbstractPropertyMetaData(MetaData parent, AbstractPropertyMetaData fmd)
parent
- The parentfmd
- The field to copypublic AbstractPropertyMetaData(MetaData parent, java.lang.String name, java.lang.String pk, java.lang.String modifier, java.lang.String defaultFetchGroup, java.lang.String nullValue, java.lang.String embedded, java.lang.String serialized, java.lang.String dependent, java.lang.String mappedBy, java.lang.String column, java.lang.String table, java.lang.String deleteAction, java.lang.String indexed, java.lang.String unique, java.lang.String recursionDepth, java.lang.String loadFetchGroup, java.lang.String valueStrategy, java.lang.String foreignKey, java.lang.String sequence, java.lang.String fieldType)
parent
- parent MetaData instancename
- field namepk
- attribute primary-key valuemodifier
- attribute persistence-modifier valuedefaultFetchGroup
- attribute default-fetch-group valuenullValue
- attribute null-value valueembedded
- attribute embedded valueserialized
- attribute serialized valuedependent
- attribute dependent valuemappedBy
- attribute mapped-by valuecolumn
- attribute column valuetable
- attribute table valuedeleteAction
- attribute delete-action valueindexed
- Whether this is indexedunique
- Apply a unique constraintrecursionDepth
- The depth of fetch to use when recursingloadFetchGroup
- Name of the additional fetch group to use when loadingvalueStrategy
- attribute value-strategy valueforeignKey
- The foreign key namesequence
- attribute sequence valuefieldType
- Implementation type(s) for field.Method Detail |
public void mergeORMData(AbstractPropertyMetaData ormFmd)
ormFmd
- The ORM Field definitionpublic void populate(ClassLoaderResolver clr, java.lang.Class fieldType, int modifiers)
clr
- ClassLoaderResolver to use for any class loadingfieldType
- The type of the field being representedmodifiers
- The modifiers of the field being represented (Static, Abstract, Final, Volatile, etc)public void initialise()
initialise
in class MetaData
public boolean isFieldTypePersistenceCapable()
public boolean isFieldArrayTypePersistenceCapable()
public boolean isStatic()
public boolean isFinal()
public boolean isTransient()
public IdentityStrategy getValueStrategy()
public java.lang.String getSequence()
public java.lang.String getLoadFetchGroup()
public int getRecursionDepth()
public AbstractClassMetaData getAbstractClassMetaData()
public final OrderMetaData getOrderMetaData()
public java.lang.String getName()
public java.lang.String getFullFieldName()
public boolean fieldBelongsToClass()
public java.lang.String getClassName()
public java.lang.String getClassName(boolean fully_qualified)
fully_qualified
- Whether the name should be fully qualified.
public NullValue getNullValue()
public FieldPersistenceModifier getPersistenceModifier()
public boolean isDefaultFetchGroup()
public boolean isDependent()
public boolean isEmbedded()
public boolean isSerialized()
public boolean isPrimaryKey()
public java.lang.String getTable()
public int getFieldId()
public final java.lang.String getFieldType()
public int getAbsoluteFieldNumber()
public java.lang.Class getType()
public java.lang.String getTypeName()
public ContainerMetaData getContainer()
public ArrayMetaData getArray()
public CollectionMetaData getCollection()
public MapMetaData getMap()
public final java.lang.String getColumn()
public final java.lang.String getMappedBy()
public final ColumnMetaData[] getColumnMetaData()
getColumnMetaData
in interface ColumnMetaDataContainer
public final ElementMetaData getElementMetaData()
public final KeyMetaData getKeyMetaData()
public final ValueMetaData getValueMetaData()
public final EmbeddedMetaData getEmbeddedMetaData()
public final ForeignKeyMetaData getForeignKeyMetaData()
public final IndexMetaData getIndexMetaData()
public final UniqueMetaData getUniqueMetaData()
public final JoinMetaData getJoinMetaData()
public void addColumn(ColumnMetaData colmd)
addColumn
in interface ColumnMetaDataContainer
colmd
- the ColumnMetaData to addpublic boolean hasContainer()
public boolean hasArray()
public boolean hasCollection()
public boolean hasMap()
public boolean isJdoField()
public void setValueStrategy(IdentityStrategy valueStrategy)
valueStrategy
- the value strategypublic void setSequence(java.lang.String sequence)
sequence
- the sequence namepublic void setDependent(boolean dependent)
dependent
- Whether it is dependent.public void setMappedBy(java.lang.String mappedby)
mappedby
- The mapped-by field.public void setContainer(ContainerMetaData conmd)
conmd
- The MetaData of the container for this field.public final void setElementMetaData(ElementMetaData elementMetaData)
elementMetaData
- The elementMetaData to set.public final void setKeyMetaData(KeyMetaData keyMetaData)
keyMetaData
- The keyMetaData to set.public final void setOrderMetaData(OrderMetaData orderMetaData)
orderMetaData
- The orderMetaData to set.public final void setValueMetaData(ValueMetaData valueMetaData)
valueMetaData
- The valueMetaData to set.public final void setEmbeddedMetaData(EmbeddedMetaData embeddedMetaData)
embeddedMetaData
- The embeddedMetaData to set.public final void setForeignKeyMetaData(ForeignKeyMetaData foreignKeyMetaData)
foreignKeyMetaData
- The foreignKeyMetaData to set.public final void setIndexMetaData(IndexMetaData indexMetaData)
indexMetaData
- The indexMetaData to set.public final void setUniqueMetaData(UniqueMetaData uniqueMetaData)
uniqueMetaData
- The uniqueMetaData to set.public final void setJoinMetaData(JoinMetaData joinMetaData)
joinMetaData
- The joinMetaData to set.public void setTable(java.lang.String table)
table
- The table nameprotected void setRelation(ClassLoaderResolver clr)
clr
- ClassLoader resolverpublic int getRelationType(ClassLoaderResolver clr)
clr
- ClassLoader resolver
public AbstractPropertyMetaData getRelatedFieldMetaData(ClassLoaderResolver clr)
clr
- the ClassLoaderResolver
public java.lang.String toString()
toString
in class ExtendableMetaData
public java.lang.String toString(java.lang.String prefix, java.lang.String indent)
toString
in class ExtendableMetaData
prefix
- prefix stringindent
- indent string
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
o
- The object to compare against
public MetaDataManager getMetaDataManager()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |