org.jpox.store.mapped.mapping
Class AbstractContainerMapping

java.lang.Object
  org.jpox.store.mapped.mapping.JavaTypeMapping
      org.jpox.store.mapped.mapping.SingleFieldMapping
          org.jpox.store.mapped.mapping.AbstractContainerMapping

Direct Known Subclasses:

ArrayMapping, CollectionMapping, MapMapping

public abstract class AbstractContainerMapping
extends SingleFieldMapping

Mapping for a field that represents a container of objects, such as a List, a Set, a Collection, a Map, or an array. Has an owner table. Can be represented in the following ways :-

• Using a Join-Table, where the linkage between owner and elements/keys/values is stored in this table
• Using a Foreign-Key in the element/key/value
• Serialised into a single column in the owner table.
• Embedded into the Join-Table
• Serialised into a single-column in the Join-Table

The contents of the container are backed by a store, handling interfacing with the datastore.

Version:

$Revision: 1.50 $

Field Summary

protected java.lang.String	fieldName Name of the field that is the container.
protected MappedStoreManager	storeMgr Store Manager being used.

Fields inherited from class org.jpox.store.mapped.mapping.JavaTypeMapping

datastoreContainer, datastoreMappings, dba, fmd, LOCALISER, MAPPING_ARRAY_ELEMENT, MAPPING_COLLECTION_ELEMENT, MAPPING_FIELD, MAPPING_MAP_KEY, MAPPING_MAP_VALUE, referenceMapping, roleForField, type

Constructor Summary

AbstractContainerMapping()

Method Summary

protected boolean	containerIsStoredInSingleColumn() Convenience method to return if the container (collection or map) is stored in the owning table as a column.
DatastoreContainerObject	getDatastoreContainer() Accessor for the datastore class.
DatastoreMapping	getDataStoreMapping(int index) Accessor for a datastore mapping
DatastoreMapping[]	getDataStoreMappings() Accessor for the datastore mappings for this java type
java.lang.String	getJavaTypeForDatastoreMapping(int index) Accessor for the name of the java-type actually used when mapping the particular datastore field.
int	getNumberOfDatastoreFields() Accessor for the number of datastore fields
java.lang.Object	getObject(ObjectManager om, java.lang.Object resultSet, int[] exprIndex) Method to retrieve an object from the passed JDBC ResultSet.
java.lang.Object	getSampleValue(ClassLoaderResolver clr) Accessor for a sample value for this mapping.
int	hashCode() Hash code function.
boolean	includeInFetchStatement() This mapping is included in the select statement.
boolean	includeInInsertStatement() This mapping is included in the insert statement.
boolean	includeInUpdateStatement() This mapping is included in the update statement.
void	initialize(DatastoreAdapter dba, AbstractMemberMetaData fmd, DatastoreContainerObject container, ClassLoaderResolver clr) Initialize this JavaTypeMapping with the given DatastoreAdapter for the given FieldMetaData.
void	postFetch(StateManager sm) Method to be called after any fetch of the owner class element.
protected void	prepareDatastoreMapping() Method to prepare a field mapping for use in the datastore.
protected SCO	replaceFieldWithWrapper(StateManager ownerSM, java.lang.Object value, boolean forInsert, boolean forUpdate) Method to replace the field that this mapping represents with a SCO wrapper.
void	setObject(ObjectManager om, java.lang.Object preparedStatement, int[] exprIndex, java.lang.Object value) Method to set a field in the passed JDBC PreparedStatement using this mapping.

Methods inherited from class org.jpox.store.mapped.mapping.SingleFieldMapping

equals, getBoolean, getByte, getChar, getDefaultLength, getDouble, getFloat, getInt, getLong, getShort, getString, getValidValues, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setShort, setString

Methods inherited from class org.jpox.store.mapped.mapping.JavaTypeMapping

addDataStoreMapping, failureMessage, getFieldMetaData, getJavaType, getObject, getReferenceMapping, getRoleForField, getType, initialize, isNullable, isSerialised, newLiteral, newScalarExpression, setDefault, setFieldInformation, setObject, setReferenceMapping, setRoleForField

Methods inherited from class java.lang.Object

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

Field Detail

fieldName

protected java.lang.String fieldName

Name of the field that is the container.

storeMgr

protected MappedStoreManager storeMgr

Store Manager being used.

Constructor Detail

AbstractContainerMapping

public AbstractContainerMapping()

Method Detail

initialize

public void initialize(DatastoreAdapter dba,
                       AbstractMemberMetaData fmd,
                       DatastoreContainerObject container,
                       ClassLoaderResolver clr)

Initialize this JavaTypeMapping with the given DatastoreAdapter for the given FieldMetaData.

Overrides:

initialize in class SingleFieldMapping

Parameters:

dba - The Datastore Adapter that this Mapping should use.

fmd - FieldMetaData for the field to be mapped (if any)

container - The datastore container storing this mapping (if any)

clr - the ClassLoaderResolver

prepareDatastoreMapping

protected void prepareDatastoreMapping()

Method to prepare a field mapping for use in the datastore. This creates the column in the table.

Overrides:

prepareDatastoreMapping in class SingleFieldMapping

getJavaTypeForDatastoreMapping

public java.lang.String getJavaTypeForDatastoreMapping(int index)

Accessor for the name of the java-type actually used when mapping the particular datastore field. This java-type must have an entry in the datastore mappings.

Overrides:

getJavaTypeForDatastoreMapping in class SingleFieldMapping

Parameters:

index - requested datastore field index.

Returns:

the name of java-type for the requested datastore field.

setObject

public void setObject(ObjectManager om,
                      java.lang.Object preparedStatement,
                      int[] exprIndex,
                      java.lang.Object value)

Method to set a field in the passed JDBC PreparedStatement using this mapping. Only valid when the collection is serialised.

Overrides:

setObject in class SingleFieldMapping

Parameters:

om - The Object Manager

preparedStatement - The JDBC Prepared Statement to be populated

exprIndex - The parameter positions in the JDBC statement to populate.

value - The value to populate into it

getObject

public java.lang.Object getObject(ObjectManager om,
                                  java.lang.Object resultSet,
                                  int[] exprIndex)

Method to retrieve an object from the passed JDBC ResultSet. Only valid when the collection is serialised.

Overrides:

getObject in class SingleFieldMapping

Parameters:

om - Object Manager

resultSet - The JDBC ResultSet

exprIndex - The JDBC parameter position(s) to extract the object from

Returns:

The collection object

getDatastoreContainer

public DatastoreContainerObject getDatastoreContainer()

Accessor for the datastore class.

Overrides:

getDatastoreContainer in class JavaTypeMapping

Returns:

The datastore class

getNumberOfDatastoreFields

public int getNumberOfDatastoreFields()

Accessor for the number of datastore fields

Overrides:

getNumberOfDatastoreFields in class JavaTypeMapping

Returns:

The number of datastore fields

getDataStoreMapping

public DatastoreMapping getDataStoreMapping(int index)

Accessor for a datastore mapping

Overrides:

getDataStoreMapping in class JavaTypeMapping

Parameters:

index - The id of the mapping

Returns:

The datastore mapping

getDataStoreMappings

public DatastoreMapping[] getDataStoreMappings()

Accessor for the datastore mappings for this java type

Overrides:

getDataStoreMappings in class JavaTypeMapping

Returns:

The datastore mapping(s)

containerIsStoredInSingleColumn

protected boolean containerIsStoredInSingleColumn()

Convenience method to return if the container (collection or map) is stored in the owning table as a column. The container is stored in a single column in the following situations :-

• The FieldMetaData has 'serialized="true"'
• The collection has embedded-element="true" but no join table (and so serialised)
• The map has embedded-key/value="true" but no join table (and so serialised)
• The array has embedded-element="true" but no join table (and so serialised)
• The array has no join table and non-PC elements (and so serialised)

Returns:

Whether it is stored in a single column in the main table.

includeInFetchStatement

public boolean includeInFetchStatement()

This mapping is included in the select statement.

Overrides:

includeInFetchStatement in class JavaTypeMapping

Returns:

Whether to include in select statement

includeInUpdateStatement

public boolean includeInUpdateStatement()

This mapping is included in the update statement.

Overrides:

includeInUpdateStatement in class JavaTypeMapping

Returns:

Whether to include in update statement

includeInInsertStatement

public boolean includeInInsertStatement()

This mapping is included in the insert statement.

Overrides:

includeInInsertStatement in class JavaTypeMapping

Returns:

Whether to include in insert statement

hashCode

public int hashCode()

Hash code function.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code for this object

getSampleValue

public java.lang.Object getSampleValue(ClassLoaderResolver clr)

Accessor for a sample value for this mapping.

Specified by:

getSampleValue in class JavaTypeMapping

Parameters:

clr - TODO

Returns:

The sample value

replaceFieldWithWrapper

protected SCO replaceFieldWithWrapper(StateManager ownerSM,
                                      java.lang.Object value,
                                      boolean forInsert,
                                      boolean forUpdate)

Method to replace the field that this mapping represents with a SCO wrapper. The wrapper will be suitable for the passed instantiated type and if it is null will be for the declared type of the field.

Parameters:

ownerSM - State Manager for the owning object

value - The value to create the wrapper with

forInsert - Whether to insert the SCO with this value

forUpdate - Whether to update the SCO with this value

Returns:

The SCO wrapper object that the field was replaced with

postFetch

public void postFetch(StateManager sm)

Method to be called after any fetch of the owner class element.

Parameters:

sm - StateManager of the owner