org.jpox.store.mapped.mapping
Class ObjectAsStringMapping

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

All Implemented Interfaces:

SimpleDatastoreRepresentation

Direct Known Subclasses:

CurrencyMapping, LocaleMapping, TimeZoneMapping, URIMapping, URLMapping, UUIDMapping

public abstract class ObjectAsStringMapping
extends SingleFieldMapping
implements SimpleDatastoreRepresentation

Abstract SCO mapping for a java type that will be stored as a String type.

Version:

$Revision: 1.8 $

Field Summary

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

ObjectAsStringMapping()

Method Summary

abstract java.lang.Class	getJavaType() Method to return the Java type.
java.lang.String	getJavaTypeForDatastoreMapping(int index) Accessor for the name of the java-type actually used when mapping the particular datastore field.
java.lang.Object	getObject(ObjectManager om, java.lang.Object resultSet, int[] exprIndex) Method to get the object from the datastore and convert to an object.
ScalarExpression	newLiteral(QueryExpression qs, java.lang.Object value) Method to create a literal of this type for use in a JDOQL query.
ScalarExpression	newScalarExpression(QueryExpression qs, LogicSetExpression te) Method to create a new expression for this mapping for use in a JDOQL Query.
protected abstract java.lang.String	objectToString(java.lang.Object object) Method to set the datastore value based on the object value.
void	setObject(ObjectManager om, java.lang.Object preparedStatement, int[] exprIndex, java.lang.Object value) Method to set the object when updating the the datastore.
protected abstract java.lang.Object	stringToObject(java.lang.String datastoreValue) Method to extract the objects value from the datastore object.

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

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

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

addDataStoreMapping, failureMessage, getDatastoreContainer, getDataStoreMapping, getDataStoreMappings, getFieldMetaData, getNumberOfDatastoreFields, getObject, getReferenceMapping, getRoleForField, getSampleValue, getType, includeInFetchStatement, includeInInsertStatement, includeInUpdateStatement, initialize, isNullable, isSerialised, setDefault, setFieldInformation, setObject, setReferenceMapping, setRoleForField

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectAsStringMapping

public ObjectAsStringMapping()

Method Detail

newLiteral

public ScalarExpression newLiteral(QueryExpression qs,
                                   java.lang.Object value)

Method to create a literal of this type for use in a JDOQL query.

Specified by:

newLiteral in class JavaTypeMapping

Parameters:

qs - The QueryExpression

value - The value of the literal

Returns:

The Literal

newScalarExpression

public ScalarExpression newScalarExpression(QueryExpression qs,
                                            LogicSetExpression te)

Method to create a new expression for this mapping for use in a JDOQL Query.

Specified by:

newScalarExpression in class JavaTypeMapping

Parameters:

qs - The QueryExpression

te - Expression for the datastore container

Returns:

The JDOQL expression

getJavaType

public abstract java.lang.Class getJavaType()

Method to return the Java type.

Specified by:

getJavaType in class JavaTypeMapping

Returns:

The Java type being represented.

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 the object when updating the the datastore.

Overrides:

setObject in class SingleFieldMapping

Parameters:

om - the ObjectManager

preparedStatement - a datastore object that executes statements in the database

exprIndex - the position of the value in the statement

value - the value

See Also:

SingleFieldMapping.setObject(org.jpox.ObjectManager, java.lang.Object, int[], java.lang.Object)

getObject

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

Method to get the object from the datastore and convert to an object.

Overrides:

getObject in class SingleFieldMapping

Parameters:

om - the ObjectManager

resultSet - an object returned from the datastore with values

exprIndex - the position of the value in the result

Returns:

the value

See Also:

SingleFieldMapping.getObject(org.jpox.ObjectManager, java.lang.Object, int[])

objectToString

protected abstract java.lang.String objectToString(java.lang.Object object)

Method to set the datastore value based on the object value.

Parameters:

object - The object

Returns:

The value to pass to the datastore

stringToObject

protected abstract java.lang.Object stringToObject(java.lang.String datastoreValue)

Method to extract the objects value from the datastore object.

Parameters:

datastoreValue - Value obtained from the datastore

Returns:

The value of this object (derived from the datastore value)