Package org.datanucleus.store.rdbms.mapping.column

Class OracleBlobColumnMapping

java.lang.Object

org.datanucleus.store.rdbms.mapping.column.AbstractColumnMapping

org.datanucleus.store.rdbms.mapping.column.OracleBlobColumnMapping

All Implemented Interfaces:

ColumnMapping, ColumnMappingPostInsert, ColumnMappingPostUpdate

public class OracleBlobColumnMapping
extends AbstractColumnMapping
implements ColumnMappingPostInsert, ColumnMappingPostUpdate

Mapping for an Oracle BLOB column. Extends the standard JDBC handler so that we can insert an empty BLOB, and then update it (Oracle non-standard behaviour).

Field Summary

Fields inherited from class org.datanucleus.store.rdbms.mapping.column.AbstractColumnMapping

column, mapping, storeMgr

Constructor Summary

Constructors

Modifier	Constructor	Description
	OracleBlobColumnMapping(JavaTypeMapping mapping, RDBMSStoreManager storeMgr, Column col)	Constructor.
protected	OracleBlobColumnMapping(RDBMSStoreManager storeMgr, JavaTypeMapping mapping)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getInsertionInputParameter()	Accessor for the string to put in any retrieval datastore statement for this field.
int	getJDBCType()	Method to return the java.sql.Types type that this relates to.
Object	getObject(ResultSet rs, int param)	Returns the object to be loaded from the Orale BLOB.
String	getString(ResultSet resultSet, int exprIndex)	Obtains a value from resultSet at position specified by exprIndex.
String	getUpdateInputParameter()	Accessor for the string to put in any update datastore statements for this field.
boolean	includeInSQLFetchStatement()	Whether to include this mapping in a fetch statement.
void	insertPostProcessing(org.datanucleus.state.ObjectProvider op, Object value)	Perform any INSERT post processing on this column, using the provided value.
boolean	insertValuesOnInsert()	Accessor for whether this mapping requires values inserting on an INSERT.
static void	updateBlobColumn(org.datanucleus.state.ObjectProvider op, Table table, ColumnMapping mapping, byte[] bytes)	Convenience method to update the contents of a BLOB column.
void	updatePostProcessing(org.datanucleus.state.ObjectProvider op, Object value)	Perform any UPDATE post processing on this column, using the provided value.

Methods inherited from class org.datanucleus.store.rdbms.mapping.column.AbstractColumnMapping

equals, failureMessage, failureMessage, failureMessage, getBoolean, getByte, getChar, getColumn, getDatastoreAdapter, getDouble, getFloat, getInt, getJavaTypeMapping, getLong, getShort, getTypeInfo, hashCode, includeInFetchStatement, initTypeInfo, isBitBased, isBooleanBased, isDecimalBased, isIntegerBased, isNullable, isStringBased, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setObject, setShort, setString, useDefaultWhenNull

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleBlobColumnMapping

public OracleBlobColumnMapping(JavaTypeMapping mapping,
                               RDBMSStoreManager storeMgr,
                               Column col)

Constructor.

Parameters:

mapping - The Java mapping

storeMgr - Store Manager in use

col - Column

OracleBlobColumnMapping

protected OracleBlobColumnMapping(RDBMSStoreManager storeMgr,
                                  JavaTypeMapping mapping)

Constructor.

Parameters:

storeMgr - Store Manager

mapping - The Java mapping

Method Detail

getInsertionInputParameter

public String getInsertionInputParameter()

Description copied from class: AbstractColumnMapping

Accessor for the string to put in any retrieval datastore statement for this field. In RDBMS, this is typically a ? to be used in JDBC statements.

Specified by:

getInsertionInputParameter in interface ColumnMapping

Overrides:

getInsertionInputParameter in class AbstractColumnMapping

Returns:

The input parameter

See Also:

AbstractColumnMapping.getInsertionInputParameter()

insertValuesOnInsert

public boolean insertValuesOnInsert()

Accessor for whether this mapping requires values inserting on an INSERT.

Specified by:

insertValuesOnInsert in interface ColumnMapping

Overrides:

insertValuesOnInsert in class AbstractColumnMapping

Returns:

Whether values are to be inserted into this mapping on an INSERT

getObject

public Object getObject(ResultSet rs,
                        int param)

Returns the object to be loaded from the Orale BLOB.

Specified by:

getObject in interface ColumnMapping

Overrides:

getObject in class AbstractColumnMapping

Parameters:

rs - the ResultSet from the query

param - the index in the query

Returns:

the object loaded as a byte[]

Throws:

org.datanucleus.exceptions.NucleusDataStoreException - Thrown if an error occurs in datastore communication

getString

public String getString(ResultSet resultSet,
                        int exprIndex)

Description copied from interface: ColumnMapping

Obtains a value from resultSet at position specified by exprIndex.

Specified by:

getString in interface ColumnMapping

Overrides:

getString in class AbstractColumnMapping

Parameters:

resultSet - ResultSet

exprIndex - the position of the value in the result

Returns:

the value

See Also:

AbstractColumnMapping.getString(ResultSet, int)

getJDBCType

public int getJDBCType()

Description copied from class: AbstractColumnMapping

Method to return the java.sql.Types type that this relates to.

Specified by:

getJDBCType in class AbstractColumnMapping

Returns:

The JDBC "type"

getUpdateInputParameter

public String getUpdateInputParameter()

Description copied from class: AbstractColumnMapping

Accessor for the string to put in any update datastore statements for this field. In RDBMS, this is typically a ? to be used in JDBC statements.

Specified by:

getUpdateInputParameter in interface ColumnMapping

Overrides:

getUpdateInputParameter in class AbstractColumnMapping

Returns:

The input parameter.

See Also:

AbstractColumnMapping.getUpdateInputParameter()

includeInSQLFetchStatement

public boolean includeInSQLFetchStatement()

Whether to include this mapping in a fetch statement.

Returns:

Whether to include it when fetching the object

updatePostProcessing

public void updatePostProcessing(org.datanucleus.state.ObjectProvider op,
                                 Object value)

Description copied from interface: ColumnMappingPostUpdate

Perform any UPDATE post processing on this column, using the provided value.

Specified by:

updatePostProcessing in interface ColumnMappingPostUpdate

Parameters:

op - ObjectProvider for object being updated

value - The value to use on the UPDATE

insertPostProcessing

public void insertPostProcessing(org.datanucleus.state.ObjectProvider op,
                                 Object value)

Description copied from interface: ColumnMappingPostInsert

Perform any INSERT post processing on this column, using the provided value.

Specified by:

insertPostProcessing in interface ColumnMappingPostInsert

Parameters:

op - ObjectProvider for object being inserted

value - The value to use on the insert

updateBlobColumn

public static void updateBlobColumn(org.datanucleus.state.ObjectProvider op,
                                    Table table,
                                    ColumnMapping mapping,
                                    byte[] bytes)

Convenience method to update the contents of a BLOB column. Oracle requires that a BLOB is initialised with EMPTY_BLOB() and then you retrieve the column and update its BLOB value. Performs a statement

 SELECT {blobColumn} FROM TABLE WHERE ID=? FOR UPDATE
 

and then updates the Blob value returned.

Parameters:

op - ObjectProvider of the object

table - Table storing the BLOB column

mapping - Datastore mapping for the BLOB column

bytes - The bytes to store in the BLOB

Throws:

org.datanucleus.exceptions.NucleusObjectNotFoundException - thrown if an object isnt found

org.datanucleus.exceptions.NucleusDataStoreException - thrown if an error occurs in datastore communication