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

Class OracleClobColumnMapping

java.lang.Object

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

org.datanucleus.store.rdbms.mapping.column.LongVarcharColumnMapping

org.datanucleus.store.rdbms.mapping.column.ClobColumnMapping

org.datanucleus.store.rdbms.mapping.column.OracleClobColumnMapping

All Implemented Interfaces:

ColumnMapping, ColumnMappingPostInsert, ColumnMappingPostUpdate

public class OracleClobColumnMapping
extends ClobColumnMapping
implements ColumnMappingPostInsert, ColumnMappingPostUpdate

Mapping for an Oracle CLOB column. Extends the standard JDBC handler so that we can insert an empty CLOB, 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

Constructor	Description
OracleClobColumnMapping(JavaTypeMapping mapping, RDBMSStoreManager storeMgr, Column col)

Method Summary

Modifier and Type	Method	Description
String	getInsertionInputParameter()	Accessor for the string to put in any retrieval datastore statement for this field.
Object	getObject(ResultSet rs, int param)	Obtains a value from resultSet at position specified by exprIndex.
String	getString(ResultSet rs, int param)	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	includeInFetchStatement()	Whether this mapping is included in the 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	updateClobColumn(org.datanucleus.state.ObjectProvider op, Table table, ColumnMapping mapping, String value)	Convenience method to update the contents of a CLOB 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.ClobColumnMapping

getJDBCType, setObject, setString

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

isStringBased

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, initTypeInfo, isBitBased, isBooleanBased, isDecimalBased, isIntegerBased, isNullable, setBoolean, setByte, setChar, setDouble, setFloat, setInt, setLong, setShort, useDefaultWhenNull

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleClobColumnMapping

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

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

includeInFetchStatement

public boolean includeInFetchStatement()

Description copied from class: AbstractColumnMapping

Whether this mapping is included in the fetch statement.

Overrides:

includeInFetchStatement in class AbstractColumnMapping

Returns:

Whether to include in fetch statement

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.

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

getString

public String getString(ResultSet rs,
                        int param)

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 ClobColumnMapping

Parameters:

rs - ResultSet

param - the position of the value in the result

Returns:

the value

getObject

public Object getObject(ResultSet rs,
                        int param)

Description copied from interface: ColumnMapping

Obtains a value from resultSet at position specified by exprIndex.

Specified by:

getObject in interface ColumnMapping

Overrides:

getObject in class ClobColumnMapping

Parameters:

rs - ResultSet

param - the position of the value in the result

Returns:

the value

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

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

updateClobColumn

public static void updateClobColumn(org.datanucleus.state.ObjectProvider op,
                                    Table table,
                                    ColumnMapping mapping,
                                    String value)

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

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

and then updates the Clob value returned.

Parameters:

op - ObjectProvider of the object

table - Table storing the CLOB column

mapping - Datastore mapping for the CLOB column

value - The value to store in the CLOB

Throws:

org.datanucleus.exceptions.NucleusObjectNotFoundException - Thrown if an object is not found

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