Class VersionMapping

java.lang.Object

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

org.datanucleus.store.rdbms.mapping.java.SingleFieldMapping

org.datanucleus.store.rdbms.mapping.java.VersionMapping

Direct Known Subclasses:

VersionMapping.VersionLongMapping, VersionMapping.VersionTimestampMapping

public class VersionMapping
extends SingleFieldMapping

Mapping class for mapping version state/timestamp columns in the database. This class is for internal use only. It should not be used in user mappings.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VersionMapping.VersionLongMapping	Version using a Long delegate.
static final class	VersionMapping.VersionTimestampMapping	Version using a Timestamp delegate.

Field Summary

Fields

Modifier and Type	Field	Description
private final JavaTypeMapping	delegate

Fields inherited from class SingleFieldMapping

EXTENSION_CHECK_CONSTRAINT_VALUES

Fields inherited from class JavaTypeMapping

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

Constructor Summary

Constructors

Constructor	Description
VersionMapping(Table table, JavaTypeMapping delegate)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addColumnMapping(ColumnMapping colMapping)	Method to add a column mapping
ColumnMapping	getColumnMapping(int index)	Accessor for a column mapping
ColumnMapping[]	getColumnMappings()	Accessor for the column mappings for this java type
Class	getJavaType()	Accessor for the java type being mapped.
int	getNumberOfColumnMappings()	Accessor for the number of column mappings.
Object	getObject(org.datanucleus.ExecutionContext ec, ResultSet resultSet, int[] exprIndex)	Obtains a value from datastoreResults at position specified by exprIndex.
boolean	includeInFetchStatement()	Accessor for whether this mapping is to be included in any fetch statement.
void	setObject(org.datanucleus.ExecutionContext ec, PreparedStatement ps, int[] exprIndex, Object value)	Sets a value into datastoreStatement at position specified by exprIndex.

Methods inherited from class SingleFieldMapping

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

Methods inherited from class JavaTypeMapping

equals, failureMessage, getAbsoluteFieldNumber, getColumnMetaDataForMember, getMemberMetaData, getObject, getReferenceMapping, getRoleForMember, getStoreManager, getTable, getType, getValueForColumnMapping, hashCode, hasSimpleDatastoreRepresentation, includeInInsertStatement, includeInUpdateStatement, initialize, isNullable, isSerialised, performSetPostProcessing, representableAsStringLiteralInStatement, requiresSetPostProcessing, setAbsFieldNumber, setMemberMetaData, setObject, setReferenceMapping, setRoleForMember, setTable

Methods inherited from class Object

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

Field Details

delegate

private final JavaTypeMapping delegate

Constructor Details

VersionMapping

public VersionMapping(Table table,
 JavaTypeMapping delegate)

Constructor.

Parameters:

table - Datastore table

delegate - The JavaTypeMapping to delegate the storage

Method Details

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

getNumberOfColumnMappings

public int getNumberOfColumnMappings()

Description copied from class: JavaTypeMapping

Accessor for the number of column mappings.

Overrides:

getNumberOfColumnMappings in class JavaTypeMapping

Returns:

the number of column mappings

getColumnMapping

public ColumnMapping getColumnMapping(int index)

Description copied from class: JavaTypeMapping

Accessor for a column mapping

Overrides:

getColumnMapping in class JavaTypeMapping

Parameters:

index - The id of the column

Returns:

The column mapping

getColumnMappings

public ColumnMapping[] getColumnMappings()

Description copied from class: JavaTypeMapping

Accessor for the column mappings for this java type

Overrides:

getColumnMappings in class JavaTypeMapping

Returns:

The column mapping(s)

addColumnMapping

public void addColumnMapping(ColumnMapping colMapping)

Description copied from class: JavaTypeMapping

Method to add a column mapping

Overrides:

addColumnMapping in class JavaTypeMapping

Parameters:

colMapping - The column mapping

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

setObject

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

Description copied from class: JavaTypeMapping

Sets a value into datastoreStatement at position specified by exprIndex.

Overrides:

setObject in class SingleFieldMapping

Parameters:

ec - ExecutionContext

ps - PreparedStatement

exprIndex - the position of the value in the statement

value - the value

getObject

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

Description copied from class: JavaTypeMapping

Obtains a value from datastoreResults at position specified by exprIndex.

Overrides:

getObject in class SingleFieldMapping

Parameters:

ec - ExecutionContext

resultSet - ResultSet

exprIndex - the position of the value in the result

Returns:

the value