|
|||||||||||
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.EmbeddedMetaData
This element specifies the mapping for an embedded type. It contains multiple field elements, one for each field in the type. The null-indicator-column optionally identifies the name of the column used to indicate whether the embedded instance is null. By default, if the value of this column is null, then the embedded instance is null. This column might be mapped to a field of the embedded instance but might be a synthetic column for the sole purpose of indicating a null reference. The null-indicator-value specifies the value to indicate that the embedded instance is null. This is only used for non-nullable columns. If null-indicator-column is omitted, then the embedded instance is assumed always to exist.
<!ELEMENT embedded (extension*, (field|property)*, extension*)>
Field Summary | |
protected AbstractPropertyMetaData[] |
fieldMetaData
|
protected java.util.List |
fields
Fields of the embedded object. |
protected java.lang.String |
nullIndicatorColumn
Name of a column used for determining if the embedded object is null |
protected java.lang.String |
nullIndicatorValue
Value in the null column indicating that the embedded object is null |
protected java.lang.String |
ownerField
Name of the owner field in the embedded object. |
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 | |
EmbeddedMetaData(ExtendableMetaData parent,
java.lang.String ownerField,
java.lang.String nullColumn,
java.lang.String nullValue)
Constructor. |
|
EmbeddedMetaData(MetaData parent,
EmbeddedMetaData embmd)
Constructor to create a copy of the passed metadata using the provided parent. |
Method Summary | |
void |
addField(AbstractPropertyMetaData fmd)
Method to add a field to the embedded definition. |
AbstractPropertyMetaData[] |
getFieldMetaData()
Accessor for fieldMetaData |
java.lang.String |
getNullIndicatorColumn()
Accessor for the column to check for null values. |
java.lang.String |
getNullIndicatorValue()
Accessor for the value of the null indicator column when null |
java.lang.String |
getOwnerField()
Accessor for the owner field to contain the FK back to the owner |
void |
initialise()
Method to initialise the object, creating all internal convenience arrays. |
void |
populate(ClassLoaderResolver clr)
Method to populate the embedded MetaData. |
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 final java.util.List fields
protected final java.lang.String ownerField
protected final java.lang.String nullIndicatorColumn
protected final java.lang.String nullIndicatorValue
protected AbstractPropertyMetaData[] fieldMetaData
Constructor Detail |
public EmbeddedMetaData(MetaData parent, EmbeddedMetaData embmd)
parent
- The parentembmd
- The metadata to copypublic EmbeddedMetaData(ExtendableMetaData parent, java.lang.String ownerField, java.lang.String nullColumn, java.lang.String nullValue)
parent
- Owning metadataownerField
- The owner fieldnullColumn
- Column to use for determining null embedded objectnullValue
- Value of column to use for determining null embedded objectMethod Detail |
public void populate(ClassLoaderResolver clr)
clr
- The class loader to use where necessarypublic void initialise()
initialise
in class MetaData
public final AbstractPropertyMetaData[] getFieldMetaData()
public final java.lang.String getOwnerField()
public final java.lang.String getNullIndicatorColumn()
public final java.lang.String getNullIndicatorValue()
public void addField(AbstractPropertyMetaData fmd)
fmd
- Meta-Data for the field.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
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |