|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
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.AbstractFieldMapping | +--kodo.jdbc.meta.ReferenceFieldMapping | +--kodo.jdbc.meta.OneToOneFieldMapping
Maps a relation to another object.
Field Summary | |
static int |
INVERSE_COLUMNS
|
static int |
INVERSE_FIELD
|
static int |
INVERSE_NONE
|
static String |
TYPE
|
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.jdbc.meta.FieldMapping |
AUTO_INCREMENT, DELETE_ACTION, ELEMENT_DELETE_ACTION, ELEMENT_INDEXED, ELEMENT_SIZE, EXTENSION_KEYS, FIELD_MAP, INDEXED, JDBC_TYPE, KEY_DELETE_ACTION, KEY_INDEXED, KEY_SIZE, REF_DELETE_ACTION, REF_INDEXED, SIZE, SQL_TYPE, VALUE_DELETE_ACTION, VALUE_INDEXED, VALUE_SIZE |
Fields inherited from interface kodo.meta.FieldMetaData |
DEPENDENT, EAGER_FETCH_MODE, ELEMENT_DEPENDENT, ELEMENT_TYPE, EXTERNAL_VALUES, EXTERNALIZER, FACTORY, FETCH_GROUP, INVERSE_LOGICAL, INVERSE_OWNER, KEY_DEPENDENT, KEY_TYPE, LOCK_GROUP, LOCK_GROUP_DEFAULT, LOCK_GROUP_NONE, LRS, MANAGE_NONE, MANAGE_PERSISTENT, MANAGE_TRANSACTIONAL, NULL_DEFAULT, NULL_EXCEPTION, NULL_NONE, NULL_UNSET, SEQUENCE_ASSIGNED, VALUE_DEPENDENT, VALUE_TYPE |
Constructor Summary | |
OneToOneFieldMapping(FieldMetaData meta)
Constructor. |
Method Summary | |
void |
addMappingInfoAttributes(Collection attrs)
Add all mapping attributes names used by this mapping to the given collection. |
void |
appendIsNotNull(SQLBuffer sql,
Select sel,
Joins joins)
Append a where clause to the given statement checking if this value is not null. |
void |
appendIsNull(SQLBuffer sql,
Select sel,
Joins joins)
Append a where clause to the given statement checking if this value is null. |
void |
delete(KodoStateManager sm,
RowManager rm)
Delete the row for this object if the reference foreign key exists. |
void |
deleteEmbedded(KodoStateManager sm,
RowManager rm)
Delete values for the mapping. |
void |
fromMappingInfo(MappingInfo info,
boolean adapt)
The default implementation will raise warnings for any mapping attributes that are declared but not in the list of the valid attributes for this mapping. |
boolean |
getClassCriteria()
Whether to use the exepected type of the related object as a criteria when selecting it. |
Column[] |
getColumns()
Return the data columns for this mapping. |
Object |
getDataStoreValue(Object val)
Translate the given external field value to its datastore equivalent. |
ForeignKey |
getForeignKey()
Return the foreign key to the related table. |
int |
getInverseType()
Return the type of inverse this 1-1 has. |
String |
getMappingType()
Return the abbreviated name of this mapping, or the full class name if it is a custom mapping. |
void |
insert(KodoStateManager sm,
RowManager rm)
Set values for the mapping into the proper rows. |
Joins |
join(Joins joins)
Join this value to the class table. |
Joins |
joinRelation(Joins joins)
Join this value's table to the table for the related first class object type, if any. |
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. |
void |
loadEagerJoin(KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch,
Result res)
Load the joined eager result. |
Object |
loadKeyProjection(JDBCStoreManager store,
JDBCFetchConfiguration fetch,
Result res,
Joins joins)
Load this field's key value using the given result. |
Object |
loadProjection(JDBCStoreManager store,
JDBCFetchConfiguration fetch,
Result res,
Joins joins)
Load this field value using the given result. |
boolean |
map()
Map a new instance of this mapping type. |
void |
nullEmbedded(KodoStateManager sm,
RowManager rm)
Null values for the mapping. |
void |
refSchemaComponents()
Increment the reference count of all used schema components. |
void |
reverseMap(SchemaGroup schema,
ReverseMappingTool tool)
Create mappings from the schema, using the given tool. |
int |
select(Select sel,
KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch,
int eagerMode)
Select the virtual row columns of this mapping. |
int |
selectEagerJoin(Select sel,
KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch,
int eagerMode)
Use eager joins to select related objects. |
void |
setClassCriteria(boolean clsCriteria)
Whether to use the exepected type of the related object as a criteria when selecting it. |
void |
setForeignKey(ForeignKey fk)
Set the foreign key to the other table. |
boolean |
supportsSelect(Select sel,
int type,
KodoStateManager sm,
JDBCStoreManager store,
JDBCFetchConfiguration fetch)
Return true if this mapping can perform the given select type. |
void |
toMappingInfo(MappingInfo info)
Serialize this mapping to a simple MappingInfo instance
for transfer to XML or some other format. |
void |
update(KodoStateManager sm,
RowManager rm)
Set values for the mapping into the proper rows. |
boolean |
usesIntermediate()
Override to return true (i.e. |
Methods inherited from class kodo.jdbc.meta.ReferenceFieldMapping |
createRefForeignKey, fromMappingInfo, getJoinedRow, getRefForeignKey, getRefJoins, getRefJoinType, getTable, join, setRefForeignKey, setRefForeignKey, setRefJoinType, wherePrimaryKey, whereRefForeignKey |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.lang.Comparable |
compareTo |
Methods inherited from interface kodo.meta.Commentable |
getComments |
Field Detail |
public static final String TYPE
public static final int INVERSE_NONE
public static final int INVERSE_FIELD
public static final int INVERSE_COLUMNS
Constructor Detail |
public OneToOneFieldMapping(FieldMetaData meta)
Method Detail |
public ForeignKey getForeignKey()
public void setForeignKey(ForeignKey fk)
public int getInverseType()
public boolean getClassCriteria()
public void setClassCriteria(boolean clsCriteria)
public String getMappingType()
Mapping
public boolean usesIntermediate()
usesIntermediate
in class AbstractFieldMapping
kodo.meta.FieldMetaData
KodoStateManager.setIntermediate(int,Object)
public void toMappingInfo(MappingInfo info)
Mapping
MappingInfo
instance
for transfer to XML or some other format.toMappingInfo
in class ReferenceFieldMapping
public void fromMappingInfo(MappingInfo info, boolean adapt)
AbstractFieldMapping
fromMappingInfo
in class AbstractFieldMapping
kodo.jdbc.meta.AbstractFieldMapping
AbstractFieldMapping.addMappingInfoAttributes(java.util.Collection)
public void addMappingInfoAttributes(Collection attrs)
Mapping
addMappingInfoAttributes
in class ReferenceFieldMapping
public boolean map()
Mapping
public void reverseMap(SchemaGroup schema, ReverseMappingTool tool)
Mapping
reverseMap
in class AbstractFieldMapping
public void refSchemaComponents()
Mapping
refSchemaComponents
in class ReferenceFieldMapping
public Column[] getColumns()
FieldMapping
public Object getDataStoreValue(Object val)
FieldMapping
getDataStoreValue
in class AbstractFieldMapping
public void appendIsNull(SQLBuffer sql, Select sel, Joins joins)
FieldMapping
public void appendIsNotNull(SQLBuffer sql, Select sel, Joins joins)
FieldMapping
public Joins join(Joins joins)
FieldMapping
join
in class AbstractFieldMapping
public Joins joinRelation(Joins joins)
FieldMapping
joinRelation
in class AbstractFieldMapping
public boolean supportsSelect(Select sel, int type, KodoStateManager sm, JDBCStoreManager store, JDBCFetchConfiguration fetch)
FieldMapping
Select#JOINLESS
and the given select instance already has this field's table selected.
The given state manager may be null if selecting multiple instances.supportsSelect
in class AbstractFieldMapping
public int selectEagerJoin(Select sel, KodoStateManager sm, JDBCStoreManager store, JDBCFetchConfiguration fetch, int eagerMode)
FieldMapping
selectEagerJoin
in class AbstractFieldMapping
kodo.jdbc.meta.FieldMapping
FieldMapping.select(kodo.jdbc.sql.Select, kodo.runtime.KodoStateManager, kodo.jdbc.runtime.JDBCStoreManager, kodo.jdbc.runtime.JDBCFetchConfiguration, int)
public int select(Select sel, KodoStateManager sm, JDBCStoreManager store, JDBCFetchConfiguration fetch, int eagerMode)
FieldMapping
kodo.jdbc.meta.FieldMapping
sel
- 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 configurationpublic void loadEagerJoin(KodoStateManager sm, JDBCStoreManager store, JDBCFetchConfiguration fetch, Result res) throws SQLException
FieldMapping
loadEagerJoin
in class AbstractFieldMapping
public void load(KodoStateManager sm, JDBCStoreManager store, JDBCFetchConfiguration fetch, Result res) throws SQLException
FieldMapping
public void load(KodoStateManager sm, JDBCStoreManager store, JDBCFetchConfiguration fetch) throws SQLException
FieldMapping
public Object loadProjection(JDBCStoreManager store, JDBCFetchConfiguration fetch, Result res, Joins joins) throws SQLException
FieldMapping
FieldMapping.getColumns()
.public Object loadKeyProjection(JDBCStoreManager store, JDBCFetchConfiguration fetch, Result res, Joins joins) throws SQLException
FieldMapping
FieldMapping.getKeyColumns()
.loadKeyProjection
in class AbstractFieldMapping
public void insert(KodoStateManager sm, RowManager rm) throws SQLException
Mapping
public void update(KodoStateManager sm, RowManager rm) throws SQLException
Mapping
kodo.jdbc.meta.Mapping
Mapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)
public void delete(KodoStateManager sm, RowManager rm) throws SQLException
ReferenceFieldMapping
delete
in class ReferenceFieldMapping
kodo.jdbc.meta.Mapping
Mapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)
public void nullEmbedded(KodoStateManager sm, RowManager rm) throws SQLException
FieldMapping
nullEmbedded
in class AbstractFieldMapping
kodo.jdbc.meta.FieldMapping
Mapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)
public void deleteEmbedded(KodoStateManager sm, RowManager rm) throws SQLException
FieldMapping
deleteEmbedded
in class AbstractFieldMapping
kodo.jdbc.meta.FieldMapping
Mapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)
|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |