| java.lang.Object
 org.jpox.metadata.MetaData
org.jpox.metadata.EmbeddedMetaData
| EmbeddedMetaData | | public class EmbeddedMetaData extends MetaData (Code) | | 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.
since:
1.1
version:
$Revision: 1.42 $ |
| members | | final protected List members(Code) | | Fields/properties of the embedded object.
|
| nullIndicatorColumn | | final protected String nullIndicatorColumn(Code) | | Name of a column used for determining if the embedded object is null
|
| nullIndicatorValue | | final protected String nullIndicatorValue(Code) | | Value in the null column indicating that the embedded object is null
|
| ownerMember | | final protected String ownerMember(Code) | | Name of the owner field/property in the embedded object.
|
| EmbeddedMetaData | | public EmbeddedMetaData(MetaData parent, EmbeddedMetaData embmd)(Code) | | Constructor to create a copy of the passed metadata using the provided parent.
Parameters:
parent - The parent
Parameters:
embmd - The metadata to copy |
| EmbeddedMetaData | | public EmbeddedMetaData(MetaData parent, String ownerField, String nullColumn, String nullValue)(Code) | | Constructor.
Parameters:
parent - Owning metadata
Parameters:
ownerField - The owner field
Parameters:
nullColumn - Column to use for determining null embedded object
Parameters:
nullValue - Value of column to use for determining null embedded object |
| addMember | | public void addMember(AbstractMemberMetaData mmd)(Code) | | Method to add a field/property to the embedded definition.
Rejects the addition of duplicate named fields/properties.
Parameters:
mmd - Meta-Data for the field/property. |
| getNullIndicatorColumn | | final public String getNullIndicatorColumn()(Code) | | Accessor for the column to check for null values.
The column name |
| getNullIndicatorValue | | final public String getNullIndicatorValue()(Code) | | Accessor for the value of the null indicator column when null
The value |
| getOwnerMember | | final public String getOwnerMember()(Code) | | Accessor for the owner field/property to contain the FK back to the owner
The owner field/property |
| initialise | | public void initialise()(Code) | | Method to initialise the object, creating all internal convenience
arrays.
|
| populate | | public void populate(ClassLoaderResolver clr, ClassLoader primary)(Code) | | Method to populate the embedded MetaData.
This performs checks on the validity of the field types for embedding.
Parameters:
clr - The class loader to use where necessary
Parameters:
primary - the primary ClassLoader to use (or null) |
| toString | | public String toString(String prefix, String indent)(Code) | | Returns a string representation of the object using a prefix
This can be used as part of a facility to output a MetaData file.
Parameters:
prefix - prefix string
Parameters:
indent - indent string a string representation of the object. |
|
|