org.datanucleus.store.rdbms.mapping.java

Class SingleCollectionMapping

java.lang.Object

org.datanucleus.store.rdbms.mapping.java.JavaTypeMapping

org.datanucleus.store.rdbms.mapping.java.SingleCollectionMapping

All Implemented Interfaces:

MappingCallbacks

Direct Known Subclasses:

OptionalMapping

public class SingleCollectionMapping
extends JavaTypeMapping
implements MappingCallbacks

Maps single collection elements as 1-1 instead of 1-N, by wrapping and reusing the JavaTypeMappings and member metadata of the element types.

Field Summary

Fields inherited from class org.datanucleus.store.rdbms.mapping.java.JavaTypeMapping

absFieldNumber, datastoreMappings, mmd, referenceMapping, roleForMember, storeMgr, table, type

Constructor Summary

Constructors

Constructor and Description
SingleCollectionMapping()

Method Summary

Modifier and Type	Method and Description
DatastoreMapping	getDatastoreMapping(int index) Accessor for a datastore mapping
DatastoreMapping[]	getDatastoreMappings() Accessor for the datastore mappings for this java type
Class	getJavaType() Accessor for the java type being mapped.
String	getJavaTypeForDatastoreMapping(int index) Accessor for the name of the java-type actually used when mapping the particular datastore field.
int	getNumberOfDatastoreMappings() Accessor for the number of datastore mappings.
Object	getObject(org.datanucleus.ExecutionContext ec, ResultSet rs, int[] exprIndex) Obtains a value from datastoreResults at position specified by exprIndex.
Object	getObject(org.datanucleus.ExecutionContext ec, ResultSet rs, int[] exprIndex, org.datanucleus.state.ObjectProvider ownerOP, int ownerFieldNumber) Obtains a value from datastoreResults at position specified by exprIndex.
JavaTypeMapping	getWrappedMapping()
boolean	hasSimpleDatastoreRepresentation() Whether the mapping has a simple (single column) datastore representation.
boolean	includeInFetchStatement() Accessor for whether this mapping is to be included in any fetch statement.
void	initialize(org.datanucleus.metadata.AbstractMemberMetaData mmd, Table table, org.datanucleus.ClassLoaderResolver clr) Initialize this JavaTypeMapping for the supplied table and field/property metadata.
void	insertPostProcessing(org.datanucleus.state.ObjectProvider op) Hook so that we can handle any post-processing on the insert of a particular field.
void	postFetch(org.datanucleus.state.ObjectProvider op) Method called after the retrieval of the object, so that additional operations can be performed if necessary.
void	postInsert(org.datanucleus.state.ObjectProvider op) Method called after the insert of the object so that additional operations can be performed if necessary.
void	postUpdate(org.datanucleus.state.ObjectProvider op) Method called after the update of the object, so that additional operations can be performed if necessary.
void	preDelete(org.datanucleus.state.ObjectProvider op) Method called before the delete of objects, so that additional operations can be performed if necessary.
void	setMemberMetaData(org.datanucleus.metadata.AbstractMemberMetaData mmd) Method to set the metadata of the member for which this mapping applies.
void	setObject(org.datanucleus.ExecutionContext ec, PreparedStatement ps, int[] pos, Object container) Sets a value into datastoreStatement at position specified by exprIndex.

Methods inherited from class org.datanucleus.store.rdbms.mapping.java.JavaTypeMapping

addDatastoreMapping, equals, failureMessage, getAbsoluteFieldNumber, getBoolean, getByte, getChar, getColumnMetaDataForMember, getDouble, getFloat, getInt, getLong, getMemberMetaData, getReferenceMapping, getRoleForMember, getShort, getStoreManager, getString, getTable, getType, getValueForDatastoreMapping, hashCode, includeInInsertStatement, includeInUpdateStatement, initialize, isNullable, isSerialised, representableAsStringLiteralInStatement, setAbsFieldNumber, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setReferenceMapping, setRoleForMember, setShort, setString, setTable

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleCollectionMapping

public SingleCollectionMapping()

Method Detail

initialize

public void initialize(org.datanucleus.metadata.AbstractMemberMetaData mmd,
                       Table table,
                       org.datanucleus.ClassLoaderResolver clr)

Description copied from class: JavaTypeMapping

Initialize this JavaTypeMapping for the supplied table and field/property metadata. Subclasses should override this method to perform any datastore initialization operations. Assumes the "roleForMember" is already set

Overrides:

initialize in class JavaTypeMapping

Parameters:

mmd - MetaData for the field/property to be mapped (if any)

table - The table storing this mapping (if any)

clr - the ClassLoaderResolver

setMemberMetaData

public void setMemberMetaData(org.datanucleus.metadata.AbstractMemberMetaData mmd)

Description copied from class: JavaTypeMapping

Method to set the metadata of the member for which this mapping applies. For use where the mapping was created for a particular type (using the initialize(StoreManager, String) and we now have the member that it applies for.

Overrides:

setMemberMetaData in class JavaTypeMapping

Parameters:

mmd - Field/Property MetaData

getWrappedMapping

public JavaTypeMapping getWrappedMapping()

includeInFetchStatement

public boolean includeInFetchStatement()

Description copied from class: JavaTypeMapping

Accessor for whether this mapping is to be included in any fetch statement.

Overrides:

includeInFetchStatement in class JavaTypeMapping

Returns:

Whether to include this mapping in a fetch statement

hasSimpleDatastoreRepresentation

public boolean hasSimpleDatastoreRepresentation()

Description copied from class: JavaTypeMapping

Whether the mapping has a simple (single column) datastore representation.

Overrides:

hasSimpleDatastoreRepresentation in class JavaTypeMapping

Returns:

Whether it has a simple datastore representation (single column)

setObject

public void setObject(org.datanucleus.ExecutionContext ec,
                      PreparedStatement ps,
                      int[] pos,
                      Object container)

Description copied from class: JavaTypeMapping

Sets a value into datastoreStatement at position specified by exprIndex.

Overrides:

setObject in class JavaTypeMapping

Parameters:

ec - ExecutionContext

ps - PreparedStatement

pos - the position of the value in the statement

container - the value

getObject

public Object getObject(org.datanucleus.ExecutionContext ec,
                        ResultSet rs,
                        int[] exprIndex)

Description copied from class: JavaTypeMapping

Obtains a value from datastoreResults at position specified by exprIndex.

Overrides:

getObject in class JavaTypeMapping

Parameters:

ec - ExecutionContext

rs - ResultSet

exprIndex - the position of the value in the result

Returns:

the value

getObject

public Object getObject(org.datanucleus.ExecutionContext ec,
                        ResultSet rs,
                        int[] exprIndex,
                        org.datanucleus.state.ObjectProvider ownerOP,
                        int ownerFieldNumber)

Description copied from class: JavaTypeMapping

Obtains a value from datastoreResults at position specified by exprIndex.

Overrides:

getObject in class JavaTypeMapping

Parameters:

ec - ExecutionContext

rs - an object returned from the datastore with values

exprIndex - the position of the value in the result

ownerOP - the owner ObjectProvider

ownerFieldNumber - the owner absolute field number

Returns:

the value

getNumberOfDatastoreMappings

public int getNumberOfDatastoreMappings()

Description copied from class: JavaTypeMapping

Accessor for the number of datastore mappings. This typically equates to the number of columns

Overrides:

getNumberOfDatastoreMappings in class JavaTypeMapping

Returns:

the number of datastore mappings

getDatastoreMappings

public DatastoreMapping[] getDatastoreMappings()

Description copied from class: JavaTypeMapping

Accessor for the datastore mappings for this java type

Overrides:

getDatastoreMappings in class JavaTypeMapping

Returns:

The datastore mapping(s)

getDatastoreMapping

public DatastoreMapping getDatastoreMapping(int index)

Description copied from class: JavaTypeMapping

Accessor for a datastore mapping

Overrides:

getDatastoreMapping in class JavaTypeMapping

Parameters:

index - The id of the mapping

Returns:

The datastore mapping

getJavaTypeForDatastoreMapping

public String getJavaTypeForDatastoreMapping(int index)

Description copied from class: JavaTypeMapping

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. The default implementation throws an UnsupportedOperationException.

Overrides:

getJavaTypeForDatastoreMapping in class JavaTypeMapping

Parameters:

index - requested datastore field index.

Returns:

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

insertPostProcessing

public void insertPostProcessing(org.datanucleus.state.ObjectProvider op)

Description copied from interface: MappingCallbacks

Hook so that we can handle any post-processing on the insert of a particular field. For example with Oracle we need to insert "EMPTY_CLOB" and then immediately after do a SELECT of it and update the contents of the CLOB/BLOB.

Specified by:

insertPostProcessing in interface MappingCallbacks

Parameters:

op - ObjectProvider

postInsert

public void postInsert(org.datanucleus.state.ObjectProvider op)

Description copied from interface: MappingCallbacks

Method called after the insert of the object so that additional operations can be performed if necessary.

Specified by:

postInsert in interface MappingCallbacks

Parameters:

op - ObjectProvider of the owner

postFetch

public void postFetch(org.datanucleus.state.ObjectProvider op)

Description copied from interface: MappingCallbacks

Method called after the retrieval of the object, so that additional operations can be performed if necessary.

Specified by:

postFetch in interface MappingCallbacks

Parameters:

op - ObjectProvider of the owner

postUpdate

public void postUpdate(org.datanucleus.state.ObjectProvider op)

Description copied from interface: MappingCallbacks

Method called after the update of the object, so that additional operations can be performed if necessary.

Specified by:

postUpdate in interface MappingCallbacks

Parameters:

op - ObjectProvider of the owner

preDelete

public void preDelete(org.datanucleus.state.ObjectProvider op)

Description copied from interface: MappingCallbacks

Method called before the delete of objects, so that additional operations can be performed if necessary.

Specified by:

preDelete in interface MappingCallbacks

Parameters:

op - ObjectProvider of the owner

getJavaType

public Class getJavaType()

Description copied from class: JavaTypeMapping

Accessor for the java type being mapped. This is the java type that the mapping represents. Some examples :

• if the field is of type "MyClass" then the mapping will be OIDMapping (or subclass) the javaType will be OID, and the type will be MyClass.
• if the field is of type "int" then the mapping will be IntegerMapping, the javaType will be Integer, and the type will be int.

The "java type" is the java-type name used in the plugin.xml mapping file

Specified by:

getJavaType in class JavaTypeMapping

Returns:

The java type