JavaTypeMapping (JPOX-Core 1.2-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jpox.store.mapping
Class JavaTypeMapping

java.lang.Object
  org.jpox.store.mapping.JavaTypeMapping

Direct Known Subclasses:: MultiMapping, SingleFieldMapping, SingleFieldMultiMapping

public abstract class JavaTypeMapping
extends java.lang.Object
extends java.lang.Object

Representation of the mapping of a Java type. The java type maps to one or more datastore mappings. This means that a field in a java class can be mapped to many columns in a table (in an RDBMS). A JavaTypeMapping can exist in 2 forms

Constructed for the java type on its own to represent a literal in a JDOQL query, and consequently has no metadata/container information
Constructed for a field managed by a datastore container, and so has metadata/container information

Version:: $Revision: 1.33 $

Field Summary
`protected DatastoreContainerObject`	`datastoreContainer` The Datastore Container storing this mapping.
`protected DatastoreMapping[]`	`datastoreMappings` The Datastore mappings for this Java type.
`protected DatastoreAdapter`	`dba` Adapter for the datastore being used.
`protected AbstractMemberMetaData`	`fmd` The field definition, when the type relates specifically to a field.
`protected static Localiser`	`LOCALISER` Localiser for messages
`static int`	`MAPPING_ARRAY_ELEMENT` Role signifying that the mapping is for an array element in a join table
`static int`	`MAPPING_COLLECTION_ELEMENT` Role signifying that the mapping is for a collection element in a join table
`static int`	`MAPPING_FIELD` Role signifying that the mapping is for a field in the primary class table
`static int`	`MAPPING_MAP_KEY` Role signifying that the mapping is for a map key in a join table
`static int`	`MAPPING_MAP_VALUE` Role signifying that the mapping is for a value in a join table
`protected JavaTypeMapping`	`referenceMapping` Mapping of the reference on the end of the association - Only used when this mapping does not have datastore fields, but the other side of the association has
`protected int`	`roleForField` Role of the mapping for the field.
`protected java.lang.String`	`type` Actual type being mapped

Constructor Summary
`protected`	`JavaTypeMapping()` Create a new empty JavaTypeMapping.
`protected`	`JavaTypeMapping(DatastoreAdapter dba, java.lang.String type, AbstractMemberMetaData fmd, DatastoreContainerObject container)` Create a new Mapping with the given DatastoreAdapter for the given type.

Method Summary
`void`	`addDataStoreMapping(DatastoreMapping datastoreMapping)` Method to add a datastore mapping
`protected java.lang.String`	`failureMessage(java.lang.String method)` Utility to output any error message.
`boolean`	`getBoolean(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`byte`	`getByte(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`char`	`getChar(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`DatastoreContainerObject`	`getDatastoreContainer()` Accessor for the datastore class (e.g in an RDBMS context, the Table).
`DatastoreMapping`	`getDataStoreMapping(int index)` Accessor for a datastore mapping
`DatastoreMapping[]`	`getDataStoreMappings()` Accessor for the datastore mappings for this java type
`double`	`getDouble(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`AbstractMemberMetaData`	`getFieldMetaData()` Accessor for the FieldMetaData of the field to be mapped.
`float`	`getFloat(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`int`	`getInt(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`abstract 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.
`long`	`getLong(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`int`	`getNumberOfDatastoreFields()` Acessor for the number of datastore fields (e.g.
`java.lang.Object`	`getObject(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`java.lang.Object`	`getObject(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex, StateManager ownerSM, int ownerFieldNumber)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`JavaTypeMapping`	`getReferenceMapping()` Accessor for the mapping at the other end of a relation when this field is part of a 1-1, 1-N, M-N relation.
`int`	`getRoleForField()` Accessor for the role of the is mapping for the field.
`abstract java.lang.Object`	`getSampleValue(ClassLoaderResolver clr)` Return a sample value of the mapping type to be used for internal evaluation of type and conversion.
`short`	`getShort(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`java.lang.String`	`getString(ObjectManager om, java.lang.Object datastoreResults, int[] exprIndex)` Obtains a value from `datastoreResults` at position specified by `exprIndex`.
`java.lang.String`	`getType()` Accessor for the class name of the object that is being mapped here.
`boolean`	`includeInFetchStatement()` Accessor for whether this mapping is to be included in any fetch statement.
`boolean`	`includeInInsertStatement()` Accessor for whether this mapping is to be included in the insert statement.
`boolean`	`includeInUpdateStatement()` Accessor for whether this mapping is to be included in the update statement.
`void`	`initialize(DatastoreAdapter dba, AbstractMemberMetaData fmd, DatastoreContainerObject container, ClassLoaderResolver clr)` Initialize this JavaTypeMapping with the given DatastoreAdapter for the given FieldMetaData.
`void`	`initialize(DatastoreAdapter dba, java.lang.String type)` Initialize this JavaTypeMapping with the given DatastoreAdapter for the given type.
`boolean`	`isNullable()` Accessor for whether this mapping is nullable
`boolean`	`isSerialised()` Convenience method to return if the (part of the) field being represented by this mapping is serialised.
`abstract ScalarExpression`	`newLiteral(QueryExpression qs, java.lang.Object value)` Creates a literal from an value.
`abstract ScalarExpression`	`newScalarExpression(QueryExpression qs, LogicSetExpression te)` Creates a expression from a field name/table.
`void`	`setBoolean(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, boolean value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setByte(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, byte value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setChar(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, char value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setDefault(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex)` Convenience setter to provide a default value for this field.
`void`	`setDouble(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, double value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setFieldInformation(AbstractMemberMetaData fmd, DatastoreContainerObject container)` Convenience method for use where the mapping was created for a particular type (using the initialize(DatastoreAdapter, String) and we now have the field that it applies for.
`void`	`setFloat(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, float value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setInt(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, int value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setLong(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, long value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setObject(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, java.lang.Object value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setObject(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, java.lang.Object value, StateManager ownerSM, int ownerFieldNumber)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setReferenceMapping(JavaTypeMapping referenceMapping)` Method to set the mapping at the other end of the relation.
`void`	`setRoleForField(int role)` Method to set the role for the field.
`void`	`setShort(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, short value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.
`void`	`setString(ObjectManager om, java.lang.Object datastoreStatement, int[] exprIndex, java.lang.String value)` Sets a `value` into `datastoreStatement` at position specified by `exprIndex`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

LOCALISER

protected static final Localiser LOCALISER

Localiser for messages

MAPPING_FIELD

public static final int MAPPING_FIELD

Role signifying that the mapping is for a field in the primary class table

See Also:: Constant Field Values

MAPPING_COLLECTION_ELEMENT

public static final int MAPPING_COLLECTION_ELEMENT

Role signifying that the mapping is for a collection element in a join table

See Also:: Constant Field Values

MAPPING_ARRAY_ELEMENT

public static final int MAPPING_ARRAY_ELEMENT

Role signifying that the mapping is for an array element in a join table

See Also:: Constant Field Values

MAPPING_MAP_KEY

public static final int MAPPING_MAP_KEY

Role signifying that the mapping is for a map key in a join table

See Also:: Constant Field Values

MAPPING_MAP_VALUE

public static final int MAPPING_MAP_VALUE

Role signifying that the mapping is for a value in a join table

See Also:: Constant Field Values

fmd

protected AbstractMemberMetaData fmd

The field definition, when the type relates specifically to a field. When this mapping is for a query literal then the metadata will be null.

roleForField

protected int roleForField

Role of the mapping for the field. Whether it is for the field as a whole, or element of a collection field (in a join table), or key/value of a map field (in a join table).

datastoreMappings

protected DatastoreMapping[] datastoreMappings

The Datastore mappings for this Java type.

datastoreContainer

protected DatastoreContainerObject datastoreContainer

The Datastore Container storing this mapping.

dba

protected DatastoreAdapter dba

Adapter for the datastore being used.

type

protected java.lang.String type

Actual type being mapped

referenceMapping

protected JavaTypeMapping referenceMapping

Mapping of the reference on the end of the association - Only used when this mapping does not have datastore fields, but the other side of the association has

Constructor Detail

JavaTypeMapping

protected JavaTypeMapping()

Create a new empty JavaTypeMapping. The caller must call one of the initialize methods to initialize the instance with the DatastoreAdapter and its type.

The combination of this empty constructor and one of the initialize method is used instead of parameterized constructors for efficientcy purpose, both in execution time and code maintainability. See MappingFactory for how they are used.

Concrete subclasses must have a public accesstable empty constructor.

JavaTypeMapping

protected JavaTypeMapping(DatastoreAdapter dba,
                          java.lang.String type,
                          AbstractMemberMetaData fmd,
                          DatastoreContainerObject container)

Create a new Mapping with the given DatastoreAdapter for the given type.

Parameters:: dba - The Datastore Adapter that this Mapping should use.; type - The Class that this mapping maps to the database.; fmd - FieldMetaData for the field to be mapped (if any); container - The datastore container storing this mapping (if any)

Method Detail

initialize

public void initialize(DatastoreAdapter dba,
                       java.lang.String type)

Initialize this JavaTypeMapping with the given DatastoreAdapter for the given type. This will not set the "fmd" and "datastoreContainer" parameters. If these are required for usage of the mapping then you should call "setFieldInformation(AbstractMemberMetaData, DatastoreContainerObject)" below

Parameters:: dba - The Datastore Adapter that this Mapping should use.; type - The Class that this mapping maps to the database.
See Also:: MappingFactory.createMapping(Class, DatastoreAdapter, String)

initialize

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

Initialize this JavaTypeMapping with the given DatastoreAdapter for the given FieldMetaData. Subclasses should override this method to perform any datastore initialization operations.

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

setFieldInformation

public void setFieldInformation(AbstractMemberMetaData fmd,
                                DatastoreContainerObject container)

Convenience method for use where the mapping was created for a particular type (using the initialize(DatastoreAdapter, String) and we now have the field that it applies for.

Parameters:: fmd - Field MetaData; container - Container (table) that the mapping is for

setRoleForField

public void setRoleForField(int role)

Method to set the role for the field. Should be called before initialize().

Parameters:: role - Role for field.

isSerialised

public boolean isSerialised()

Convenience method to return if the (part of the) field being represented by this mapping is serialised.

Returns:: Whether to use Java serialisation

isNullable

public boolean isNullable()

Accessor for whether this mapping is nullable

Returns:: Whether it is nullable

getDataStoreMappings

public DatastoreMapping[] getDataStoreMappings()

Accessor for the datastore mappings for this java type

Returns:: The datastore mapping(s)

getDatastoreContainer

public DatastoreContainerObject getDatastoreContainer()

Accessor for the datastore class (e.g in an RDBMS context, the Table). Will be null if this mapping is for a literal in a query.

Returns:: The datastore class containing this mapped field.

getDataStoreMapping

public DatastoreMapping getDataStoreMapping(int index)

Accessor for a datastore mapping

Parameters:: index - The id of the mapping
Returns:: The datastore mapping

getReferenceMapping

public JavaTypeMapping getReferenceMapping()

Accessor for the mapping at the other end of a relation when this field is part of a 1-1, 1-N, M-N relation. Will be null otherwise.

Returns:: The mapping at the other end.

setReferenceMapping

public void setReferenceMapping(JavaTypeMapping referenceMapping)

Method to set the mapping at the other end of the relation. Not to be used when this field is not part of a relation.

Parameters:: referenceMapping - The mapping at the other end

addDataStoreMapping

public void addDataStoreMapping(DatastoreMapping datastoreMapping)

Method to add a datastore mapping

Parameters:: datastoreMapping - The datastore mapping

getNumberOfDatastoreFields

public int getNumberOfDatastoreFields()

Acessor for the number of datastore fields (e.g. RDBMS number of columns)

Returns:: the number of datastore fields

getFieldMetaData

public AbstractMemberMetaData getFieldMetaData()

Accessor for the FieldMetaData of the field to be mapped. Will be null if this mapping is for a literal in a query.

Returns:: Returns the FieldMetaData.

getRoleForField

public int getRoleForField()

Accessor for the role of the is mapping for the field.

Returns:: Role of this mapping for the field

getJavaType

public abstract java.lang.Class getJavaType()

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

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. The default implementation throws an UnsupportedOperationException. TODO Merge this with getJavaType().

Parameters:: index - requested datastore field index.
Returns:: the name of java-type for the requested datastore field.

getType

public java.lang.String getType()

Accessor for the class name of the object that is being mapped here. There are mainly two situations:

For a JavaTypeMapping that maps a PersistentCapable class field, this will return the type of the field. For example with a field of type "MyClass" this will return "MyClass"
For a JavaTypeMapping that maps a variable or parameter in a query, this will return the type declared in the query.

Returns:: The actual type that this Mapping maps.

getSampleValue

public abstract java.lang.Object getSampleValue(ClassLoaderResolver clr)

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

Parameters:: clr - TODO
Returns:: The sample value.

includeInFetchStatement

public boolean includeInFetchStatement()

Accessor for whether this mapping is to be included in any fetch statement.

Returns:: Whether to include this mapping in a fetch statement

includeInUpdateStatement

public boolean includeInUpdateStatement()

Accessor for whether this mapping is to be included in the update statement.

Returns:: Whether to include in update statement

includeInInsertStatement

public boolean includeInInsertStatement()

Accessor for whether this mapping is to be included in the insert statement.

Returns:: Whether to include in insert statement

newLiteral

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

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.

Parameters:: qs - The Query statement; value - The object
Returns:: A Scalar Expression

newScalarExpression

public abstract ScalarExpression newScalarExpression(QueryExpression qs,
                                                     LogicSetExpression te)

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

Parameters:: qs - The Query statement; te - the alias for the table
Returns:: A Scalar Expression

failureMessage

protected java.lang.String failureMessage(java.lang.String method)

Utility to output any error message.

Parameters:: method - The method that failed.
Returns:: the localised failure message

setDefault

public void setDefault(ObjectManager om,
                       java.lang.Object datastoreStatement,
                       int[] exprIndex)

Convenience setter to provide a default value for this field. If the field is nullable, a null is provided, otherwise the sample value.

Parameters:: om - The ObjectManager; datastoreStatement - Prepared Statement; exprIndex - The indices in the statement

setBoolean

public void setBoolean(ObjectManager om,
                       java.lang.Object datastoreStatement,
                       int[] exprIndex,
                       boolean value)

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value

getBoolean

public boolean getBoolean(ObjectManager om,
                          java.lang.Object datastoreResults,
                          int[] exprIndex)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

setChar

public void setChar(ObjectManager om,
                    java.lang.Object datastoreStatement,
                    int[] exprIndex,
                    char value)

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value

getChar

public char getChar(ObjectManager om,
                    java.lang.Object datastoreResults,
                    int[] exprIndex)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

setByte

public void setByte(ObjectManager om,
                    java.lang.Object datastoreStatement,
                    int[] exprIndex,
                    byte value)

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value

getByte

public byte getByte(ObjectManager om,
                    java.lang.Object datastoreResults,
                    int[] exprIndex)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

setShort

public void setShort(ObjectManager om,
                     java.lang.Object datastoreStatement,
                     int[] exprIndex,
                     short value)

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value

getShort

public short getShort(ObjectManager om,
                      java.lang.Object datastoreResults,
                      int[] exprIndex)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

setInt

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

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value

getInt

public int getInt(ObjectManager om,
                  java.lang.Object datastoreResults,
                  int[] exprIndex)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

setLong

public void setLong(ObjectManager om,
                    java.lang.Object datastoreStatement,
                    int[] exprIndex,
                    long value)

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value

getLong

public long getLong(ObjectManager om,
                    java.lang.Object datastoreResults,
                    int[] exprIndex)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

setFloat

public void setFloat(ObjectManager om,
                     java.lang.Object datastoreStatement,
                     int[] exprIndex,
                     float value)

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value

getFloat

public float getFloat(ObjectManager om,
                      java.lang.Object datastoreResults,
                      int[] exprIndex)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

setDouble

public void setDouble(ObjectManager om,
                      java.lang.Object datastoreStatement,
                      int[] exprIndex,
                      double value)

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value

getDouble

public double getDouble(ObjectManager om,
                        java.lang.Object datastoreResults,
                        int[] exprIndex)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

setString

public void setString(ObjectManager om,
                      java.lang.Object datastoreStatement,
                      int[] exprIndex,
                      java.lang.String value)

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value

getString

public java.lang.String getString(ObjectManager om,
                                  java.lang.Object datastoreResults,
                                  int[] exprIndex)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

setObject

public void setObject(ObjectManager om,
                      java.lang.Object datastoreStatement,
                      int[] exprIndex,
                      java.lang.Object value,
                      StateManager ownerSM,
                      int ownerFieldNumber)

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - a datastore object that executes statements in the database; exprIndex - the position of the value in the statement; value - the value; ownerSM - the owner StateManager; ownerFieldNumber - the owner absolute field number

setObject

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

Sets a value into datastoreStatement at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreStatement - 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 datastoreResults,
                                  int[] exprIndex,
                                  StateManager ownerSM,
                                  int ownerFieldNumber)

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result; ownerSM - the owner StateManager; ownerFieldNumber - the owner absolute field number
Returns:: the value

getObject

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

Obtains a value from datastoreResults at position specified by exprIndex.

Parameters:: om - the ObjectManager; datastoreResults - an object returned from the datastore with values; exprIndex - the position of the value in the result
Returns:: the value

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jpox.store.mapping Class JavaTypeMapping

LOCALISER

MAPPING_FIELD

MAPPING_COLLECTION_ELEMENT

MAPPING_ARRAY_ELEMENT

MAPPING_MAP_KEY

MAPPING_MAP_VALUE

fmd

roleForField

datastoreMappings

datastoreContainer

dba

type

referenceMapping

JavaTypeMapping

JavaTypeMapping

initialize

initialize

setFieldInformation

setRoleForField

isSerialised

isNullable

getDataStoreMappings

getDatastoreContainer

getDataStoreMapping

getReferenceMapping

setReferenceMapping

addDataStoreMapping

getNumberOfDatastoreFields

getFieldMetaData

getRoleForField

getJavaType

getJavaTypeForDatastoreMapping

getType

getSampleValue

includeInFetchStatement

includeInUpdateStatement

includeInInsertStatement

newLiteral

newScalarExpression

failureMessage

setDefault

setBoolean

getBoolean

setChar

getChar

setByte

getByte

setShort

getShort

setInt

getInt

setLong

getLong

setFloat

getFloat

setDouble

getDouble

setString

getString

setObject

setObject

getObject

getObject

org.jpox.store.mapping
Class JavaTypeMapping