kodo.jdbc.meta
Class SQLDataOneToOneFieldMapping

java.lang.Object
  |
  +--kodo.meta.DelegatingExtensions
        |
        +--kodo.meta.DelegatingFieldMetaData
              |
              +--kodo.jdbc.meta.AbstractFieldMapping
                    |
                    +--kodo.jdbc.meta.ReferenceFieldMapping
                          |
                          +--kodo.jdbc.meta.ColumnFieldMapping
                                |
                                +--kodo.jdbc.meta.SQLDataOneToOneFieldMapping

All Implemented Interfaces:

Commentable, Comparable, Extensions, FieldMapping, FieldMetaData, JDBCTypes, JDOTypes, Mapping

public class SQLDataOneToOneFieldMapping

extends ColumnFieldMapping

Maps an embedded 1-1 relation by using SQLData and related methods to store and retrieve struct data. This mapping is limited to simple values, nested SQLData mappings, and non-inverse one-one relations.

Note that number wrappers cannot store null values as JDBC limits primitive field values.

Inner Class Summary

static class	SQLDataOneToOneFieldMapping.Data Class which provides SQLData access to struct data.
static class	SQLDataOneToOneFieldMapping.SQLEmbeddedClassMapping

Field Summary

static String

TYPE

Fields inherited from class kodo.jdbc.meta.ColumnFieldMapping

DO_NOT_SET

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

SQLDataOneToOneFieldMapping(FieldMetaData meta)
Constructor.

Method Summary

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.
protected int	getDataStoreTypeCode() Return the type code of the data type that will be stored in the data column.
Object	getDataStoreValue(Object val) Translate the given external field value to its datastore equivalent.
ClassMapping	getDeclaredTypeMapping()
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.
ClassMapping	getTypeMapping() Convenience method to make casting from getTypeMetaData() unnecessary.
ClassMetaData	getTypeMetaData() Return metadata for the field's type, if the type is persistent.
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, 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, 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	refSchemaComponents() Increment the reference count of all used schema components.
void	setEmbeddedMapping(kodo.jdbc.meta.EmbeddedClassMapping mapping) The embedded class 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, Row row) Update this column with the current value into the given row.

Methods inherited from class kodo.jdbc.meta.ColumnFieldMapping

addMappingInfoAttributes, appendIsNotNull, appendIsNull, checkNull, deleteEmbedded, getColumn, getColumns, getJDBCType, insert, join, load, nullEmbedded, select, setColumn, update

Methods inherited from class kodo.jdbc.meta.ReferenceFieldMapping

createRefForeignKey, delete, fromMappingInfo, getJoinedRow, getRefForeignKey, getRefJoins, getRefJoinType, getTable, join, setRefForeignKey, setRefForeignKey, setRefJoinType, wherePrimaryKey, whereRefForeignKey

Methods inherited from class kodo.jdbc.meta.AbstractFieldMapping

addExtensionKeys, appendIsEmpty, assertTable, delete, deleteEmbedded, getDBDictionary, getDeclaredElementTypeMapping, getDeclaredElementTypeMetaData, getDeclaredKeyTypeMapping, getDeclaredKeyTypeMetaData, getDeleteAction, getElementDeleteAction, getElementIndexed, getElementSize, getElementTypeMapping, getElementTypeMetaData, getFieldMappingName, getIndexed, getInverseMappings, getInverseMetaDatas, getInverseOwnerMapping, getInverseOwnerMetaData, getJDBCTypeCode, getKeyColumns, getKeyDataStoreValue, getKeyDeleteAction, getKeyIndexed, getKeySize, getKeyTypeMapping, getKeyTypeMetaData, getMappingRepository, getMetaData, getNonVirtualOwner, getOwner, getOwnerMapping, getOwnerTable, getRefDeleteAction, getRefIndexed, getSize, getSQLType, insert, invalidateResolve, isAutoIncrement, isCustomDelete, isCustomDeleteEmbedded, isCustomInsert, isCustomNullEmbedded, isCustomUpdate, isDeleteActionDeferred, isEagerJoinToMany, isElementDeleteActionDeferred, isKeyDeleteActionDeferred, isPCObjectRelation, isRefDeleteActionDeferred, isResolved, joinKey, joinKeyRelation, loadEagerJoin, loadEagerParallel, nullEmbedded, resolve, reverseMap, selectEagerJoin, selectEagerParallel, setAutoIncrement, setDeleteAction, setElementDeleteAction, setElementIndexed, setElementSize, setFieldMappingName, setIndexed, setJDBCTypeCode, setKeyDeleteAction, setKeyIndexed, setKeySize, setNonVirtualOwner, setOwner, setRefDeleteAction, setRefIndexed, setSize, setSQLType, supportsSelect, update, usesImplData, usesIntermediate

Methods inherited from class kodo.meta.DelegatingFieldMetaData

compareTo, equals, getComments, getComparator, getDeclaredElementType, getDeclaredElementTypeCode, getDeclaredIndex, getDeclaredKeyType, getDeclaredKeyTypeCode, getDeclaredPrimaryKeyIndex, getDeclaredType, getDeclaredTypeCode, getDelegate, getEagerFetchMode, getElementType, getElementTypeCode, getElementTypeName, getExternalizer, getExternalValue, getExternalValues, getFactory, getFetchGroup, getFieldFlag, getFieldValue, getFullName, getIndex, getInnermostDelegate, getInverseLogical, getInverseOwner, getKeyType, getKeyTypeCode, getKeyTypeName, getListingIndex, getLockGroup, getManagement, getName, getNullValue, getPrimaryKeyIndex, getProxyType, getType, getTypeCode, getTypeName, hashCode, isDefaultFetchGroupExplicit, isDependent, isElementDependent, isElementEmbedded, isEmbedded, isExplicit, isExternalized, isInDefaultFetchGroup, isKeyDependent, isKeyEmbedded, isLRS, isPrimaryKey, isSequenceAssigned, isTransient, setComparator, setDeclaredElementType, setDeclaredElementTypeCode, setDeclaredIndex, setDeclaredKeyType, setDeclaredKeyTypeCode, setDeclaredPrimaryKeyIndex, setDeclaredType, setDeclaredTypeCode, setDependent, setEagerFetchMode, setElementDependent, setElementEmbedded, setElementTypeName, setEmbedded, setExplicit, setExternalizer, setExternalValues, setFactory, setFetchGroup, setInDefaultFetchGroup, setIndex, setInverseLogical, setInverseOwner, setKeyDependent, setKeyEmbedded, setKeyTypeName, setListingIndex, setLockGroup, setLRS, setManagement, setName, setNullValue, setPrimaryKey, setProxyType, setSequenceAssigned, setTransient, setTypeName, toString

Methods inherited from class kodo.meta.DelegatingExtensions

addExtension, addExtension, getBooleanExtension, getBooleanExtension, getDoubleExtension, getDoubleExtension, getEmbeddedExtensions, getEmbeddedExtensions, getExtensionComments, getExtensionKeys, getExtensionKeys, getExtensionVendors, getIntExtension, getIntExtension, getObjectExtension, getObjectExtension, getStringExtension, getStringExtension, hasExtension, hasExtension, isEmpty, removeEmbeddedExtensions, removeEmbeddedExtensions, removeExtension, removeExtension

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface kodo.meta.FieldMetaData

getComparator, getDeclaredElementType, getDeclaredElementTypeCode, getDeclaredIndex, getDeclaredKeyType, getDeclaredKeyTypeCode, getDeclaredPrimaryKeyIndex, getDeclaredType, getDeclaredTypeCode, getEagerFetchMode, getElementType, getElementTypeCode, getElementTypeName, getExternalizer, getExternalValue, getExternalValues, getFactory, getFetchGroup, getFieldFlag, getFieldValue, getFullName, getIndex, getInverseLogical, getInverseOwner, getKeyType, getKeyTypeCode, getKeyTypeName, getListingIndex, getLockGroup, getManagement, getName, getNullValue, getPrimaryKeyIndex, getProxyType, getType, getTypeCode, getTypeName, isDefaultFetchGroupExplicit, isDependent, isElementDependent, isElementEmbedded, isEmbedded, isExplicit, isExternalized, isInDefaultFetchGroup, isKeyDependent, isKeyEmbedded, isLRS, isPrimaryKey, isSequenceAssigned, isTransient, setComparator, setDeclaredElementType, setDeclaredElementTypeCode, setDeclaredIndex, setDeclaredKeyType, setDeclaredKeyTypeCode, setDeclaredPrimaryKeyIndex, setDeclaredType, setDeclaredTypeCode, setDependent, setEagerFetchMode, setElementDependent, setElementEmbedded, setElementTypeName, setEmbedded, setExplicit, setExternalizer, setExternalValues, setFactory, setFetchGroup, setInDefaultFetchGroup, setIndex, setInverseLogical, setInverseOwner, setKeyDependent, setKeyEmbedded, setKeyTypeName, setListingIndex, setLockGroup, setLRS, setManagement, setName, setNullValue, setPrimaryKey, setProxyType, setSequenceAssigned, setTransient, setTypeName

Methods inherited from interface kodo.meta.Extensions

addExtension, addExtension, getBooleanExtension, getBooleanExtension, getDoubleExtension, getDoubleExtension, getEmbeddedExtensions, getEmbeddedExtensions, getExtensionComments, getExtensionKeys, getExtensionKeys, getExtensionVendors, getIntExtension, getIntExtension, getObjectExtension, getObjectExtension, getStringExtension, getStringExtension, hasExtension, hasExtension, isEmpty, removeEmbeddedExtensions, removeEmbeddedExtensions, removeExtension, removeExtension

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface kodo.meta.Commentable

getComments

Field Detail

TYPE

public static final String TYPE

Constructor Detail

SQLDataOneToOneFieldMapping

public SQLDataOneToOneFieldMapping(FieldMetaData meta)

Constructor. Supply underlying metadata.

Method Detail

getDataStoreTypeCode

protected int getDataStoreTypeCode()

Description copied from class: ColumnFieldMapping

Return the type code of the data type that will be stored in the data column. Returns this.getTypeCode () by default.

Overrides:

getDataStoreTypeCode in class ColumnFieldMapping

getEmbeddedMapping

public kodo.jdbc.meta.EmbeddedClassMapping getEmbeddedMapping()

The embedded class mapping.

setEmbeddedMapping

public void setEmbeddedMapping(kodo.jdbc.meta.EmbeddedClassMapping mapping)

The embedded class mapping.

getTypeMetaData

public ClassMetaData getTypeMetaData()

Description copied from interface: FieldMetaData

Return metadata for the field's type, if the type is persistent.

Overrides:

getTypeMetaData in class AbstractFieldMapping

getTypeMapping

public ClassMapping getTypeMapping()

Description copied from interface: FieldMapping

Convenience method to make casting from FieldMetaData.getTypeMetaData() unnecessary.

Overrides:

getTypeMapping in class AbstractFieldMapping

getDeclaredTypeMetaData

public ClassMetaData getDeclaredTypeMetaData()

Description copied from interface: FieldMetaData

Return metadata for the field's type, if the type is persistent.

Overrides:

getDeclaredTypeMetaData in class AbstractFieldMapping

getDeclaredTypeMapping

public ClassMapping getDeclaredTypeMapping()

Overrides:

getDeclaredTypeMapping in class AbstractFieldMapping

getMappingType

public String getMappingType()

Description copied from interface: Mapping

Return the abbreviated name of this mapping, or the full class name if it is a custom mapping.

refSchemaComponents

public void refSchemaComponents()

Description copied from interface: Mapping

Increment the reference count of all used schema components.

Overrides:

refSchemaComponents in class ColumnFieldMapping

toMappingInfo

public void toMappingInfo(MappingInfo info)

Description copied from interface: Mapping

Serialize this mapping to a simple MappingInfo instance for transfer to XML or some other format.

Overrides:

toMappingInfo in class ColumnFieldMapping

fromMappingInfo

public void fromMappingInfo(MappingInfo info,
                            boolean adapt)

Description copied from class: AbstractFieldMapping

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.

Overrides:

fromMappingInfo in class ColumnFieldMapping

Following copied from class: kodo.jdbc.meta.AbstractFieldMapping

See Also:

AbstractFieldMapping.addMappingInfoAttributes(java.util.Collection)

map

public boolean map()

Description copied from interface: Mapping

Map a new instance of this mapping type. If the underlying metadata cannot be mapped using this type, return false.

Overrides:

map in class ColumnFieldMapping

getDataStoreValue

public Object getDataStoreValue(Object val)

Description copied from interface: FieldMapping

Translate the given external field value to its datastore equivalent. If the mapping occupies multiple columns in the datastore, return an object array, else return a single object. Simply returns the given object by default.

Overrides:

getDataStoreValue in class AbstractFieldMapping

joinRelation

public Joins joinRelation(Joins joins)

Description copied from interface: FieldMapping

Join this value's table to the table for the related first class object type, if any. Does nothing by default.

Overrides:

joinRelation in class AbstractFieldMapping

load

public void load(KodoStateManager sm,
                 JDBCStoreManager store,
                 JDBCFetchConfiguration fetch,
                 Result res)
          throws SQLException

Description copied from interface: FieldMapping

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.

loadProjection

public Object loadProjection(JDBCStoreManager store,
                             JDBCFetchConfiguration fetch,
                             Result res,
                             Joins joins)
                      throws SQLException

Description copied from interface: FieldMapping

Load this field value using the given result. This method will only be called if this field does not represent a FCO relation. The result will contain the columns from FieldMapping.getColumns().

loadKeyProjection

public Object loadKeyProjection(JDBCStoreManager store,
                                JDBCFetchConfiguration fetch,
                                Result res,
                                Joins joins)
                         throws SQLException

Description copied from interface: FieldMapping

Load this field's key value using the given result. This method will only be called if the key on this field does not represent a FCO relation. The result will contain the columns from FieldMapping.getKeyColumns().

Overrides:

loadKeyProjection in class AbstractFieldMapping

update

public void update(KodoStateManager sm,
                   Row row)
            throws SQLException

Description copied from class: ColumnFieldMapping

Update this column with the current value into the given row.

Overrides:

update in class ColumnFieldMapping