kodo.jdbc.meta
Class ContainerFieldMapping

java.lang.Object
  |
  +--kodo.meta.DelegatingExtensions
        |
        +--kodo.meta.DelegatingFieldMetaData
              |
              +--kodo.jdbc.meta.FieldMapping
                    |
                    +--kodo.jdbc.meta.ReferenceFieldMapping
                          |
                          +--kodo.jdbc.meta.ContainerFieldMapping

All Implemented Interfaces:

Comparable, Extensions, FieldMetaData, JDBCTypes, JDOTypes, Mapping

Direct Known Subclasses:

AbstractCollectionFieldMapping, AbstractMapFieldMapping

public abstract class ContainerFieldMapping

extends ReferenceFieldMapping

Base class for collection and map mappings. Handles container metadata and basic query functionality.

Field Summary

static String

CONTAINER_META Extension key used to mark whether collection/map mappings should use a metadata column to differentiate between null and empty containers.

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, TYPE, VALUE_DEPENDENT, VALUE_TYPE

Constructor Summary

ContainerFieldMapping(FieldMetaData meta)
Constructor.

Method Summary

void	appendIsEmpty(SQLBuffer sql, Joins joins) Append a where clause to the given statement checking if this value is empty.
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.
boolean	containsSelectTables(Select sel) Checks the select for the metadata column's table.
void	delete(KodoStateManager sm, RowManager rm) Delete the row for this object if the reference foreign key exists.
void	fromMappingInfo(MappingInfo info, boolean adapt) Deserialize this mapping from a simple MappingInfo instance parsed from XML or some other format.
int	getContainerMeta()
Column	getMetaDataColumn() Return the column holding the collection meta data.
void	insert(KodoStateManager sm, RowManager rm) Set values for the mapping into the proper rows.
void	join(Joins joins) Join this value to the class table.
void	load(KodoStateManager sm, JDBCStoreManager store, JDBCFetchConfiguration fetch, Result res) Loads the metadata.
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.
int	select(Select sel, KodoStateManager sm, JDBCStoreManager store, JDBCFetchConfiguration fetch, int eagerMode) Selects the metadata column if there is one and the metadata hasn't been loaded.
void	setContainerMeta(int meta)
void	setMetaDataColumn(Column col) Set the column holding the collection meta data.
boolean	supportsTwoPartSelect() Returns true if we have a metadata column to select.
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.

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 kodo.jdbc.meta.FieldMapping

delete, deleteEmbedded, deleteEmbedded, getColumns, getDataStoreValue, getDBDictionary, getDeclaredElementTypeMapping, getDeclaredElementTypeMetaData, getDeclaredKeyTypeMapping, getDeclaredKeyTypeMetaData, getDeclaredTypeMapping, getDeclaredTypeMetaData, getDefaults, getDeleteAction, getElementDeleteAction, getElementIndexed, getElementSize, getElementTypeMapping, getElementTypeMetaData, getFieldMappingName, getIndexed, getInverseOwnerMapping, getInverseOwnerMetaData, getKeyColumns, getKeyDataStoreValue, getKeyDeleteAction, getKeyIndexed, getKeySize, getKeyTypeMapping, getKeyTypeMetaData, getMappingRepository, getOwner, getOwnerMapping, getRefDeleteAction, getRefIndexed, getSize, getTypeMapping, getTypeMetaData, insert, invalidateResolve, isAutoIncrement, isCustomDelete, isCustomDeleteEmbedded, isCustomInsert, isCustomNullEmbedded, isCustomUpdate, isDeleteActionDeferred, isElementDeleteActionDeferred, isKeyDeleteActionDeferred, isRefDeleteActionDeferred, isResolved, joinKey, joinKeyRelation, joinRelation, load, loadKeyProjection, loadProjection, newInstance, nullEmbedded, resolve, reverseMap, selectEager, setAutoIncrement, setDeleteAction, setElementDeleteAction, setElementIndexed, setElementSize, setFieldMappingName, setIndexed, setKeyDeleteAction, setKeyIndexed, setKeySize, setOwner, setRefDeleteAction, setRefIndexed, setSize, update

Methods inherited from class kodo.meta.DelegatingFieldMetaData

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

Methods inherited from class kodo.meta.DelegatingExtensions

addExtension, addExtension, getBooleanExtension, getBooleanExtension, getDoubleExtension, getDoubleExtension, getEmbeddedExtensions, getEmbeddedExtensions, 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.jdbc.meta.Mapping

getMappingType

Methods inherited from interface kodo.meta.Extensions

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

Field Detail

CONTAINER_META

public static final String CONTAINER_META

Extension key used to mark whether collection/map mappings should use a metadata column to differentiate between null and empty containers. Set to true or false. Defaults to false.

Constructor Detail

ContainerFieldMapping

public ContainerFieldMapping(FieldMetaData meta)

Constructor. Supply underlying metadata.

Method Detail

getMetaDataColumn

public Column getMetaDataColumn()

Return the column holding the collection meta data.

setMetaDataColumn

public void setMetaDataColumn(Column col)

Set the column holding the collection meta data.

getContainerMeta

public int getContainerMeta()

setContainerMeta

public void setContainerMeta(int meta)

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 ReferenceFieldMapping

fromMappingInfo

public void fromMappingInfo(MappingInfo info,
                            boolean adapt)

Description copied from interface: Mapping

Deserialize this mapping from a simple MappingInfo 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.

Following copied from interface: kodo.jdbc.meta.Mapping

Throws:

MappingInfoNotFoundException - if the given info is invalid

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.

refSchemaComponents

public void refSchemaComponents()

Description copied from interface: Mapping

Increment the reference count of all used schema components.

Overrides:

refSchemaComponents in class ReferenceFieldMapping

appendIsEmpty

public void appendIsEmpty(SQLBuffer sql,
                          Joins joins)

Description copied from class: FieldMapping

Append a where clause to the given statement checking if this value is empty. Appends impossible-to-satisfy SQL by default.

Overrides:

appendIsEmpty in class FieldMapping

appendIsNull

public void appendIsNull(SQLBuffer sql,
                         Joins joins)

Description copied from class: FieldMapping

Append a where clause to the given statement checking if this value is null.

Overrides:

appendIsNull in class FieldMapping

appendIsNotNull

public void appendIsNotNull(SQLBuffer sql,
                            Joins joins)

Description copied from class: FieldMapping

Append a where clause to the given statement checking if this value is not null.

Overrides:

appendIsNotNull in class FieldMapping

join

public void join(Joins joins)

Description copied from class: FieldMapping

Join this value to the class table. Does nothing by default.

Overrides:

join in class FieldMapping

containsSelectTables

public boolean containsSelectTables(Select sel)

Checks the select for the metadata column's table.

Overrides:

containsSelectTables in class FieldMapping

supportsTwoPartSelect

public boolean supportsTwoPartSelect()

Returns true if we have a metadata column to select.

Overrides:

supportsTwoPartSelect in class FieldMapping

select

public int select(Select sel,
                  KodoStateManager sm,
                  JDBCStoreManager store,
                  JDBCFetchConfiguration fetch,
                  int eagerMode)

Selects the metadata column if there is one and the metadata hasn't been loaded.

Overrides:

select in class FieldMapping

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

Parameters:

sel - the select to add to

sm - the instance being loaded, or null if not initialized yet or selecting for multiple instances

store - the current store manager

fetch - fetch configuration

eagerMode - the eager fetch mode to use; this may be more restrictive than the mode of the fetch configuration

Returns:

> 0 if this mapping requires the selected data (if any), 0 if it selected data but does not require it, or < 0 if no data was selected

load

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

Loads the metadata.

Overrides:

load in class FieldMapping

insert

public void insert(KodoStateManager sm,
                   RowManager rm)
            throws SQLException

Description copied from interface: Mapping

Set values for the mapping into the proper rows. For class mappings, this method will be called only after the corresponding method has been called for all fields of this mapping.

update

public void update(KodoStateManager sm,
                   RowManager rm)
            throws SQLException

Description copied from interface: Mapping

Set values for the mapping into the proper rows.

Following copied from interface: kodo.jdbc.meta.Mapping

See Also:

Mapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)

delete

public void delete(KodoStateManager sm,
                   RowManager rm)
            throws SQLException

Description copied from class: ReferenceFieldMapping

Delete the row for this object if the reference foreign key exists.

Overrides:

delete in class ReferenceFieldMapping

Following copied from interface: kodo.jdbc.meta.Mapping

See Also:

Mapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)

nullEmbedded

public void nullEmbedded(KodoStateManager sm,
                         RowManager rm)
                  throws SQLException

Description copied from class: FieldMapping

Null values for the mapping. This method is used when embedded values are nulled or replaced. The given state manager will be the owner of the object whose fields are now being nulled.

Overrides:

nullEmbedded in class FieldMapping

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

See Also:

Mapping.insert(kodo.runtime.KodoStateManager, kodo.jdbc.sql.RowManager)