org.jpox.store.mapped.mapping
Class GregorianCalendarMapping

java.lang.Object
  org.jpox.store.mapped.mapping.JavaTypeMapping
      org.jpox.store.mapped.mapping.SingleFieldMultiMapping
          org.jpox.store.mapped.mapping.GregorianCalendarMapping

public class GregorianCalendarMapping
extends SingleFieldMultiMapping

Maps the class fields of a GregorianCalendar to datastore fields. JPOX traditionally supported this as mapping to 2 datastore fields (timestamp millisecs and timezone). It also supports as mapping to a single datastore field (timestamp).

Version:

$Revision: 1.24 $

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

GregorianCalendarMapping()

Method Summary

java.lang.Class	getJavaType() Accessor for the java type being mapped.
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) Obtains a value from datastoreResults at position specified by exprIndex.
java.lang.Object	getSampleValue(ClassLoaderResolver clr) Return a sample value of the mapping type to be used for internal evaluation of type and conversion.
void	initialize(DatastoreAdapter dba, AbstractMemberMetaData fmd, DatastoreContainerObject container, ClassLoaderResolver clr) Initialize this JavaTypeMapping with the given DatastoreAdapter for the given FieldMetaData.
ScalarExpression	newLiteral(QueryExpression qs, java.lang.Object value) Creates a literal from an value.
ScalarExpression	newScalarExpression(QueryExpression qs, LogicSetExpression te) Creates a expression from a field name/table.
void	setObject(ObjectManager om, java.lang.Object preparedStatement, int[] exprIndex, java.lang.Object value) Sets a value into datastoreStatement at position specified by exprIndex.

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

addDatastoreField

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

addDataStoreMapping, failureMessage, getBoolean, getByte, getChar, getDatastoreContainer, getDataStoreMapping, getDataStoreMappings, getDouble, getFieldMetaData, getFloat, getInt, getLong, getNumberOfDatastoreFields, getObject, getReferenceMapping, getRoleForField, getShort, getString, getType, includeInFetchStatement, includeInInsertStatement, includeInUpdateStatement, initialize, isNullable, isSerialised, setBoolean, setByte, setChar, setDefault, setDouble, setFieldInformation, setFloat, setInt, setLong, setObject, setReferenceMapping, setRoleForField, setShort, setString

Methods inherited from class java.lang.Object

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

Constructor Detail

GregorianCalendarMapping

public GregorianCalendarMapping()

Method Detail

initialize

public void initialize(DatastoreAdapter dba,
                       AbstractMemberMetaData fmd,
                       DatastoreContainerObject container,
                       ClassLoaderResolver clr)

Initialize this JavaTypeMapping with the given DatastoreAdapter for the given FieldMetaData.

Overrides:

initialize in class JavaTypeMapping

Parameters:

dba - The Datastore Adapter that this Mapping should use.

fmd - FieldMetaData for the field to be mapped (if any)

container - The datastore container storing this mapping (if any)

clr - the ClassLoaderResolver

getJavaType

public java.lang.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

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 SingleFieldMultiMapping

Parameters:

index - requested datastore field index.

Returns:

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

getSampleValue

public java.lang.Object getSampleValue(ClassLoaderResolver clr)

Description copied from class: JavaTypeMapping

Return a sample value of the mapping type to be used for internal evaluation of type and conversion.

Specified by:

getSampleValue in class JavaTypeMapping

Parameters:

clr - TODO

Returns:

The sample value.

setObject

public void setObject(ObjectManager om,
                      java.lang.Object preparedStatement,
                      int[] exprIndex,
                      java.lang.Object value)

Description copied from class: JavaTypeMapping

Sets a value into datastoreStatement at position specified by exprIndex.

Overrides:

setObject in class JavaTypeMapping

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

getObject

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

Description copied from class: JavaTypeMapping

Obtains a value from datastoreResults at position specified by exprIndex.

Overrides:

getObject in class JavaTypeMapping

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

newLiteral

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

Description copied from class: JavaTypeMapping

Creates a literal from an value. A string literal is enclosed in single quotes. for example: "literal". A string literal that includes a single quote is represented by two single quotes. for example: "literal''s". An exact numeric literal is a numeric value without a decimal point, such as 57, -957, +62. An approximate numeric literal is a numeric value in scientific notation, such as 7E3, -57.9E2, or a numeric value with a decimal, such as 7., -95.7, +6.2.

Specified by:

newLiteral in class JavaTypeMapping

Parameters:

qs - The Query statement

value - The object

Returns:

A Scalar Expression

newScalarExpression

public ScalarExpression newScalarExpression(QueryExpression qs,
                                            LogicSetExpression te)

Description copied from class: JavaTypeMapping

Creates a expression from a field name/table. e.g. tablename.fieldname; tablealias.fieldalias

Specified by:

newScalarExpression in class JavaTypeMapping

Parameters:

qs - The Query statement

te - the alias for the table

Returns:

A Scalar Expression