|
SolarMetric Kodo JDO 3.0.3 generated on February 20 2004 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--kodo.meta.DelegatingExtensions
|
+--kodo.meta.DelegatingFieldMetaData
|
+--kodo.jdbc.meta.FieldMapping
|
+--kodo.jdbc.meta.ReferenceFieldMapping
|
+--kodo.jdbc.meta.EmbeddedOneToOneFieldMapping
Maps an embedded 1-1 relation.
| Field Summary | |
static String |
NULL_IND
Extension key used to specify the field of the embedded class to use as a null-indicator for the embedded object. |
static String |
TYPE
|
| Fields inherited from class kodo.jdbc.meta.FieldMapping |
AUTO_INCREMENT, DELETE_ACTION, ELEMENT_DELETE_ACTION, ELEMENT_INDEXED, ELEMENT_SIZE, FIELD_MAP, INDEXED, KEY_DELETE_ACTION, KEY_INDEXED, KEY_SIZE, REF_DELETE_ACTION, REF_INDEXED, SIZE, VALUE_DELETE_ACTION, VALUE_INDEXED, VALUE_SIZE |
| Fields inherited from interface kodo.jdbc.meta.JDBCTypes |
TYPE_ASCII_STREAM, TYPE_BINARY_STREAM, TYPE_BLOB, TYPE_BYTES, TYPE_CHAR_STREAM, TYPE_CLOB, TYPE_JDBC_DEFAULT, TYPE_REF, TYPE_SQL_ARRAY, TYPE_SQL_DATE, TYPE_SQL_OBJECT, TYPE_TIME, TYPE_TIMESTAMP |
| Fields inherited from interface kodo.meta.JDOTypes |
TYPE_ARRAY, TYPE_BIGDECIMAL, TYPE_BIGINTEGER, TYPE_BOOLEAN, TYPE_BOOLEAN_OBJ, TYPE_BYTE, TYPE_BYTE_OBJ, TYPE_CHAR, TYPE_CHAR_OBJ, TYPE_COLLECTION, TYPE_DATE, TYPE_DOUBLE, TYPE_DOUBLE_OBJ, TYPE_FCO, TYPE_FLOAT, TYPE_FLOAT_OBJ, TYPE_INT, TYPE_INT_OBJ, TYPE_LOCALE, TYPE_LONG, TYPE_LONG_OBJ, TYPE_MAP, TYPE_NUMBER, TYPE_OBJECT, TYPE_PC_OBJECT, TYPE_SHORT, TYPE_SHORT_OBJ, TYPE_STRING |
| Fields inherited from interface kodo.meta.FieldMetaData |
DEPENDENT, ELEMENT_DEPENDENT, ELEMENT_TYPE, EXTERNALIZER, FACTORY, FETCH_GROUP, INVERSE_OWNER, KEY_DEPENDENT, KEY_TYPE, LRS, MANAGE_NONE, MANAGE_PERSISTENT, MANAGE_TRANSACTIONAL, NULL_DEFAULT, NULL_EXCEPTION, NULL_NONE, VALUE_DEPENDENT, VALUE_TYPE |
| Constructor Summary | |
EmbeddedOneToOneFieldMapping(FieldMetaData meta)
Constructor. |
|
| Method Summary | |
void |
appendIsNotNull(SQLBuffer sql,
Joins joins)
Append a where clause to the given statement checking if this value is not null. |
void |
appendIsNull(SQLBuffer sql,
Joins joins)
Append a where clause to the given statement checking if this value is null. |
void |
delete(KodoStateManager sm,
JDBCStoreManager store)
Override this method to customize flushing this mapping. |
void |
delete(KodoStateManager sm,
RowManager rm)
Delete the row for this object if the reference foreign key exists. |
void |
deleteEmbedded(KodoStateManager sm,
JDBCStoreManager store)
Override this method to customize deleting the given mapping (used with embedded values only). |
void |
deleteEmbedded(KodoStateManager sm,
RowManager rm)
Delete values for the mapping. |
void |
fromMappingInfo(MappingInfo info,
boolean adapt)
Deserialize this mapping from a simple MappingInfo
instance parsed from XML or some other format. |
Column[] |
getColumns()
Return the data columns for this mapping. |
Object |
getDataStoreValue(Object val)
Translate the given external field value to its datastore equivalent. |
ClassMapping |
getDeclaredTypeMapping()
Convenience method to make casting from getDeclaredTypeMetaData()
unnecessary. |
ClassMetaData |
getDeclaredTypeMetaData()
Return metadata for the field's type, if the type is persistent. |
kodo.jdbc.meta.EmbeddedClassMapping |
getEmbeddedMapping()
The embedded class mapping. |
String |
getMappingType()
Return the abbreviated name of this mapping, or the full class name if it is a custom mapping. |
String |
getNullIndicator()
|
Column |
getNullIndicatorColumn()
Return the column used as a null indicator for the embedded value. |
ClassMapping |
getTypeMapping()
Convenience method to make casting from getTypeMetaData()
unnecessary. |
ClassMetaData |
getTypeMetaData()
Return metadata for the field's type, if the type is persistent. |
void |
insert(KodoStateManager sm,
JDBCStoreManager store)
Override this method to customize flushing this mapping. |
void |
insert(KodoStateManager sm,
RowManager rm)
Set values for the mapping into the proper rows. |
Boolean |
isCustomDelete(KodoStateManager sm)
Return Boolean.FALSE if this mapping does not customize the
delete process, Boolean.TRUE if it does, or null if it does
customize the delete, but also relies on the standard delete method
being called. |
Boolean |
isCustomDeleteEmbedded(KodoStateManager sm)
Return Boolean.FALSE if this mapping does not customize the
delete process, Boolean.TRUE if it does, or null if it does
customize the delete, but also relies on the standard delete method
being called. |
Boolean |
isCustomInsert(KodoStateManager sm)
Return Boolean.FALSE if this mapping does not customize the
insert process, Boolean.TRUE if it does, or null if it does
customize the insert, but also relies on the standard insert method
being called. |
Boolean |
isCustomNullEmbedded(KodoStateManager sm)
Return Boolean.FALSE if this mapping does not customize the
nulling process, Boolean.TRUE if it does, or null if it does
customize the nulling, but also relies on the standard nulling method
being called. |
Boolean |
isCustomUpdate(KodoStateManager sm)
Return Boolean.FALSE if this mapping does not customize the
update process, Boolean.TRUE if it does, or null if it does
customize the update, but also relies on the standard update method
being called. |
boolean |
isSynthetic()
Whether the null indicator column is managed by this mapping. |
void |
join(Joins joins)
Join this value to the class table. |
void |
load(KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch)
Load secondary data using a connection from the store manager. |
void |
load(KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch,
Result res)
Load virtual row data; the given result is not guaranteed to contain data for this field, so the field mapping should make sure the result contains its needed column data before loading. |
Object |
loadKeyProjection(JDBCStoreManager store,
JDBCFetchConfiguration fetch,
Result res)
Load this field's key value using the given result. |
Object |
loadProjection(JDBCStoreManager store,
JDBCFetchConfiguration fetch,
Result res)
Load this field value using the given result. |
boolean |
map()
Map a new instance of this mapping type. |
void |
nullEmbedded(KodoStateManager sm,
JDBCStoreManager store)
Override this method to customize nulling the given mapping (used with embedded values only). |
void |
nullEmbedded(KodoStateManager sm,
RowManager rm)
Null values for the mapping. |
void |
refSchemaComponents()
Increment the reference count of all used schema components. |
int |
select(Select sel,
KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch,
int eagerMode)
Select the virtual row columns of this mapping. |
void |
setEmbeddedMapping(kodo.jdbc.meta.EmbeddedClassMapping mapping)
The embedded class mapping. |
void |
setNullIndicator(String nullInd)
|
void |
setNullIndicatorColumn(Column nullInd)
Set the column used as a null indicator for the embedded value. |
void |
setSynthetic(boolean synthetic)
Whether the null indicator column is managed by this mapping. |
void |
toMappingInfo(MappingInfo info)
Serialize this mapping to a simple MappingInfo instance
for transfer to XML or some other format. |
void |
update(KodoStateManager sm,
JDBCStoreManager store)
Override this method to customize flushing this mapping. |
void |
update(KodoStateManager sm,
RowManager rm)
Set values for the mapping into the proper rows. |
| Methods inherited from class kodo.jdbc.meta.ReferenceFieldMapping |
createRefForeignKey, fromMappingInfo, getJoinedRow, getRefForeignKey, getRefJoinType, getSelectJoins, getTable, join, setRefForeignKey, setRefForeignKey, setRefJoinType, wherePrimaryKey, whereRefForeignKey |
| Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final String NULL_IND
synthetic to have the system add a special column used
just for null indicators. Defaults to synthetic.public static final String TYPE
| Constructor Detail |
public EmbeddedOneToOneFieldMapping(FieldMetaData meta)
| Method Detail |
public Column getNullIndicatorColumn()
public void setNullIndicatorColumn(Column nullInd)
public boolean isSynthetic()
public void setSynthetic(boolean synthetic)
public kodo.jdbc.meta.EmbeddedClassMapping getEmbeddedMapping()
public void setEmbeddedMapping(kodo.jdbc.meta.EmbeddedClassMapping mapping)
public String getNullIndicator()
public void setNullIndicator(String nullInd)
public ClassMetaData getTypeMetaData()
FieldMetaDatagetTypeMetaData in class FieldMappingpublic ClassMapping getTypeMapping()
FieldMappingFieldMapping.getTypeMetaData()
unnecessary.getTypeMapping in class FieldMappingpublic ClassMetaData getDeclaredTypeMetaData()
FieldMetaDatagetDeclaredTypeMetaData in class FieldMappingpublic ClassMapping getDeclaredTypeMapping()
FieldMappingFieldMapping.getDeclaredTypeMetaData()
unnecessary.getDeclaredTypeMapping in class FieldMappingpublic String getMappingType()
Mappingpublic void toMappingInfo(MappingInfo info)
MappingMappingInfo instance
for transfer to XML or some other format.toMappingInfo in class ReferenceFieldMapping
public void fromMappingInfo(MappingInfo info,
boolean adapt)
MappingMappingInfo
instance parsed from XML or some other format. If the info is
incompatible and adapt is true, try to adapt to the new
info. This method must validate
the given mapping information using the SchemaGroup.findTable(kodo.jdbc.schema.Table)
method to find any needed tables, the Table.getColumn(java.lang.String) method
to retrieve columns from those tables, and the
Column.isCompatible(int, int) method to check all column types.
This validation is important, as some schema groups use these methods
to build themselves up dynamically rather than reading schema
information from the database.kodo.jdbc.meta.MappingMappingInfoNotFoundException - if the given info is invalidpublic boolean map()
Mappingpublic void refSchemaComponents()
MappingrefSchemaComponents in class ReferenceFieldMappingpublic Column[] getColumns()
FieldMappinggetColumns in class FieldMapping
public void appendIsNull(SQLBuffer sql,
Joins joins)
FieldMappingappendIsNull in class FieldMapping
public void appendIsNotNull(SQLBuffer sql,
Joins joins)
FieldMappingappendIsNotNull in class FieldMappingpublic void join(Joins joins)
FieldMappingjoin in class FieldMappingpublic Object getDataStoreValue(Object val)
FieldMappinggetDataStoreValue in class FieldMapping
public int select(Select sel,
KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch,
int eagerMode)
FieldMappingselect in class FieldMappingkodo.jdbc.meta.FieldMappingsel - the select to add tosm - the instance being loaded, or null if not
initialized yet or selecting for multiple instancesstore - the current store managerfetch - fetch configurationeagerMode - the eager fetch mode to use; this may be more
restrictive than the mode of the fetch configuration
public void load(KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch,
Result res)
throws SQLException
FieldMappingload in class FieldMapping
public void load(KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch)
throws SQLException
FieldMappingload in class FieldMapping
public Object loadProjection(JDBCStoreManager store,
JDBCFetchConfiguration fetch,
Result res)
throws SQLException
FieldMappingFieldMapping.getColumns().loadProjection in class FieldMapping
public Object loadKeyProjection(JDBCStoreManager store,
JDBCFetchConfiguration fetch,
Result res)
throws SQLException
FieldMappingFieldMapping.getKeyColumns(). Returns null by default.loadKeyProjection in class FieldMappingpublic Boolean isCustomInsert(KodoStateManager sm)
MappingBoolean.FALSE if this mapping does not customize the
insert process, Boolean.TRUE if it does, or null if it does
customize the insert, but also relies on the standard insert method
being called. Implement the
#insert(KodoStateManager,JDBCStoreManager,Connection) method
to implement the custom insertion behavior.isCustomInsert in class FieldMapping
public void insert(KodoStateManager sm,
RowManager rm)
throws SQLException
Mapping
public void insert(KodoStateManager sm,
JDBCStoreManager store)
throws SQLException
Mappinginsert in class FieldMappingpublic Boolean isCustomUpdate(KodoStateManager sm)
MappingBoolean.FALSE if this mapping does not customize the
update process, Boolean.TRUE if it does, or null if it does
customize the update, but also relies on the standard update method
being called. Implement the
#update(KodoStateManager,JDBCStoreManager,Connection) method
to override the default update behavior.isCustomUpdate in class FieldMapping
public void update(KodoStateManager sm,
RowManager rm)
throws SQLException
Mappingkodo.jdbc.meta.MappingMapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)
public void update(KodoStateManager sm,
JDBCStoreManager store)
throws SQLException
Mappingupdate in class FieldMappingpublic Boolean isCustomDelete(KodoStateManager sm)
MappingBoolean.FALSE if this mapping does not customize the
delete process, Boolean.TRUE if it does, or null if it does
customize the delete, but also relies on the standard delete method
being called. Implement the
#delete(KodoStateManager,JDBCStoreManager,Connection) method
to override the default deletion behavior.isCustomDelete in class FieldMapping
public void delete(KodoStateManager sm,
RowManager rm)
throws SQLException
ReferenceFieldMappingdelete in class ReferenceFieldMappingkodo.jdbc.meta.MappingMapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)
public void delete(KodoStateManager sm,
JDBCStoreManager store)
throws SQLException
Mappingdelete in class FieldMappingpublic Boolean isCustomNullEmbedded(KodoStateManager sm)
FieldMappingBoolean.FALSE if this mapping does not customize the
nulling process, Boolean.TRUE if it does, or null if it does
customize the nulling, but also relies on the standard nulling method
being called. Implement the
#nullEmbedded(KodoStateManager,JDBCStoreManager,Connection)
method to override the default update behavior.isCustomNullEmbedded in class FieldMapping
public void nullEmbedded(KodoStateManager sm,
RowManager rm)
throws SQLException
FieldMappingnullEmbedded in class FieldMappingkodo.jdbc.meta.FieldMappingMapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)
public void nullEmbedded(KodoStateManager sm,
JDBCStoreManager store)
throws SQLException
FieldMappingnullEmbedded in class FieldMappingpublic Boolean isCustomDeleteEmbedded(KodoStateManager sm)
FieldMappingBoolean.FALSE if this mapping does not customize the
delete process, Boolean.TRUE if it does, or null if it does
customize the delete, but also relies on the standard delete method
being called. Implement the
#deleteEmbedded(KodoStateManager,JDBCStoreManager,Connection)
method to override the default update behavior.isCustomDeleteEmbedded in class FieldMapping
public void deleteEmbedded(KodoStateManager sm,
RowManager rm)
throws SQLException
FieldMappingdeleteEmbedded in class FieldMappingkodo.jdbc.meta.FieldMappingMapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)
public void deleteEmbedded(KodoStateManager sm,
JDBCStoreManager store)
throws SQLException
FieldMappingdeleteEmbedded in class FieldMapping
|
SolarMetric Kodo JDO 3.0.3 generated on February 20 2004 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||