|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jpox.store.mapping.JavaTypeMapping
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
Field Summary | |
protected DatastoreMapping[] |
datastoreMappings
The Datastore mappings for this Java type. |
protected DatastoreAdapter |
dba
Adapter for the datastore to map to |
protected AbstractPropertyMetaData |
fmd
The field definition, when the type relates specifically to a field. |
protected static Localiser |
LOCALISER
Localised messages |
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 java.lang.String |
type
Type being mapped |
Constructor Summary | |
protected |
JavaTypeMapping(AbstractPropertyMetaData fmd,
DatastoreAdapter dba,
java.lang.String type)
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(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
byte |
getByte(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
char |
getChar(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
abstract DatastoreContainerObject |
getDatastoreContainer()
Accessor for the datastore class (e.g SQL Table) that this is mapped into |
DatastoreMapping |
getDataStoreMapping(int index)
Accessor for a datastore mapping |
DatastoreMapping[] |
getDataStoreMappings()
Accessor for the datastore mappings for this java type |
double |
getDouble(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
AbstractPropertyMetaData |
getFieldMetaData()
Accessor for the FieldMetaData of the field to be mapped |
float |
getFloat(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
int |
getInt(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
abstract java.lang.Class |
getJavaType()
Accessor for the java type being mapped |
long |
getLong(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
int |
getNumberOfDatastoreFields()
Acessor for the number of datastore fields (e.g. |
java.lang.Object |
getObject(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
java.lang.Object |
getObject(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex,
StateManager ownerSM,
int ownerFieldNumber)
Obtains a value from resultSet
at position specified by exprIndex . |
JavaTypeMapping |
getReferenceMapping()
|
abstract java.lang.Object |
getSampleValue()
Return a sample value of the mapping type to be used for internal evaluation of type and conversion. |
short |
getShort(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
java.lang.String |
getString(PersistenceManager pm,
java.lang.Object resultSet,
int[] exprIndex)
Obtains a value from resultSet
at position specified by exprIndex . |
java.lang.String |
getType()
Return the name of the class that this Mapping maps. |
abstract boolean |
includeInFetchStatement()
Whether this mapping is included in the fetch statement. |
abstract boolean |
includeInInsertStatement()
This mapping is included in the insert statement. |
abstract boolean |
includeInUpdateStatement()
This mapping is included in the update statement. |
boolean |
isNullable()
Accessor for whether this mapping is nullable |
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(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
boolean value)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setByte(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
byte value)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setChar(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
char value)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setDefault(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex)
Convenience setter to provide a default value for this field. |
void |
setDouble(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
double value)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setFloat(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
float value)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setInt(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
int value)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setLong(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
long value)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setObject(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
java.lang.Object value)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setObject(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
java.lang.Object value,
StateManager ownerSM,
int ownerFieldNumber)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setReferenceMapping(JavaTypeMapping referenceMapping)
|
void |
setShort(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
short value)
Sets a value into preparedStatement
at position specified by exprIndex . |
void |
setString(PersistenceManager pm,
java.lang.Object preparedStatement,
int[] exprIndex,
java.lang.String value)
Sets a value into preparedStatement
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 |
protected static final Localiser LOCALISER
protected final AbstractPropertyMetaData fmd
protected DatastoreMapping[] datastoreMappings
protected final DatastoreAdapter dba
protected final java.lang.String type
protected JavaTypeMapping referenceMapping
Constructor Detail |
protected JavaTypeMapping(AbstractPropertyMetaData fmd, DatastoreAdapter dba, java.lang.String type)
fmd
- FieldMetaData for the field to be mappeddba
- The Datastore Adapter that this Mapping should use.type
- The Class that this mapping maps to the database.Method Detail |
public boolean isNullable()
public DatastoreMapping[] getDataStoreMappings()
public abstract DatastoreContainerObject getDatastoreContainer()
public DatastoreMapping getDataStoreMapping(int index)
index
- The id of the mapping
public JavaTypeMapping getReferenceMapping()
public void setReferenceMapping(JavaTypeMapping referenceMapping)
public void addDataStoreMapping(DatastoreMapping datastoreMapping)
datastoreMapping
- The datastore mappingpublic int getNumberOfDatastoreFields()
public AbstractPropertyMetaData getFieldMetaData()
public abstract java.lang.Class getJavaType()
public java.lang.String getType()
public abstract java.lang.Object getSampleValue()
public abstract boolean includeInFetchStatement()
public abstract boolean includeInUpdateStatement()
public abstract boolean includeInInsertStatement()
public abstract ScalarExpression newLiteral(QueryExpression qs, java.lang.Object value)
qs
- The Query statementvalue
- The object
public abstract ScalarExpression newScalarExpression(QueryExpression qs, LogicSetExpression te)
qs
- The Query statementte
- the alias for the table
protected java.lang.String failureMessage(java.lang.String method)
method
- The method that failed.
public void setDefault(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex)
pm
- The Persistence ManagerpreparedStatement
- Prepared StatementexprIndex
- The indices in the statementpublic void setBoolean(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, boolean value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic boolean getBoolean(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
public void setChar(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, char value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic char getChar(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
public void setByte(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, byte value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic byte getByte(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
public void setShort(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, short value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic short getShort(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
public void setInt(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, int value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic int getInt(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
public void setLong(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, long value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic long getLong(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
public void setFloat(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, float value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic float getFloat(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
public void setDouble(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, double value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic double getDouble(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
public void setString(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, java.lang.String value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic java.lang.String getString(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
public void setObject(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, java.lang.Object value, StateManager ownerSM, int ownerFieldNumber)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valueownerSM
- the owner StateManagerownerFieldNumber
- the owner absolute field numberpublic void setObject(PersistenceManager pm, java.lang.Object preparedStatement, int[] exprIndex, java.lang.Object value)
value
into preparedStatement
at position specified by exprIndex
.
pm
- the PersistenceManagerpreparedStatement
- a datastore object that executes statements in the databaseexprIndex
- the position of the value in the statementvalue
- the valuepublic java.lang.Object getObject(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex, StateManager ownerSM, int ownerFieldNumber)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the resultownerSM
- the owner StateManagerownerFieldNumber
- the owner absolute field number
public java.lang.Object getObject(PersistenceManager pm, java.lang.Object resultSet, int[] exprIndex)
resultSet
at position specified by exprIndex
.
pm
- the PersistenceManagerresultSet
- an object returned from the datastore with valuesexprIndex
- the position of the value in the result
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |