org.datanucleus.store.rdbms.mapping

Interface MappingManager

All Known Implementing Classes:

OracleRDBMSMappingManager, RDBMSMappingManager

public interface MappingManager

Representation of a MappingManager, mapping a java mapping type to a datastore mapping type. Allows a java mapping type to map to multiple datastore mapping types. Allows a default datastore mapping type be assigned to each java mapping type.

Method Summary

Modifier and Type	Method and Description
Column	createColumn(org.datanucleus.metadata.AbstractMemberMetaData fmd, Table table, JavaTypeMapping mapping, org.datanucleus.metadata.ColumnMetaData colmd, Column referenceCol, org.datanucleus.ClassLoaderResolver clr) Method to create a column for a persistable mapping.
Column	createColumn(JavaTypeMapping mapping, String javaType, org.datanucleus.metadata.ColumnMetaData colmd) Method to create a datastore field (column) in a container (table).
Column	createColumn(JavaTypeMapping mapping, String javaType, int datastoreFieldIndex) Method to create a datastore field (column) in a container (table).
DatastoreMapping	createDatastoreMapping(JavaTypeMapping mapping, org.datanucleus.metadata.AbstractMemberMetaData fmd, int index, Column column) Method to create the datastore mapping for a java type mapping at a particular index.
DatastoreMapping	createDatastoreMapping(JavaTypeMapping mapping, Column column, String javaType) Method to create the datastore mapping for a particular column and java type.
JavaTypeMapping	getMapping(Class c) Accessor for a mapping, for a java type.
JavaTypeMapping	getMapping(Class c, boolean serialised, boolean embedded, String fieldName) Accessor for a mapping, for a java type.
JavaTypeMapping	getMapping(Table table, org.datanucleus.metadata.AbstractMemberMetaData mmd, org.datanucleus.ClassLoaderResolver clr, org.datanucleus.metadata.FieldRole fieldRole) Accessor for the mapping for the field of the specified table.
JavaTypeMapping	getMappingWithDatastoreMapping(Class c, boolean serialised, boolean embedded, org.datanucleus.ClassLoaderResolver clr) Accessor for a mapping, for a java type complete with the datastore mapping.
void	loadDatastoreMapping(org.datanucleus.plugin.PluginManager mgr, org.datanucleus.ClassLoaderResolver clr, String vendorId) Initialise the datastore mapping.

Method Detail

loadDatastoreMapping

void loadDatastoreMapping(org.datanucleus.plugin.PluginManager mgr,
                          org.datanucleus.ClassLoaderResolver clr,
                          String vendorId)

Initialise the datastore mapping.

Parameters:

mgr - the PlyginManager

clr - the ClassLoaderResolver

vendorId - the datastore vendor id

createDatastoreMapping

DatastoreMapping createDatastoreMapping(JavaTypeMapping mapping,
                                        org.datanucleus.metadata.AbstractMemberMetaData fmd,
                                        int index,
                                        Column column)

Method to create the datastore mapping for a java type mapping at a particular index.

Parameters:

mapping - The java mapping

fmd - MetaData for the field

index - Index of the datastore field

column - The column

Returns:

The datastore mapping

createDatastoreMapping

DatastoreMapping createDatastoreMapping(JavaTypeMapping mapping,
                                        Column column,
                                        String javaType)

Method to create the datastore mapping for a particular column and java type.

Parameters:

mapping - The java mapping

column - The column

javaType - The java type (isnt this stored in the java mapping ?)

Returns:

The datastore mapping

getMapping

JavaTypeMapping getMapping(Class c)

Accessor for a mapping, for a java type. Same as calling "getMapping(c, false, false, (String)null);"

Parameters:

c - The java type

Returns:

The mapping

getMapping

JavaTypeMapping getMapping(Class c,
                           boolean serialised,
                           boolean embedded,
                           String fieldName)

Accessor for a mapping, for a java type.

Parameters:

c - The java type

serialised - Whether the type is serialised

embedded - Whether the type is embedded

fieldName - Name of the field (for logging only)

Returns:

The mapping

getMappingWithDatastoreMapping

JavaTypeMapping getMappingWithDatastoreMapping(Class c,
                                               boolean serialised,
                                               boolean embedded,
                                               org.datanucleus.ClassLoaderResolver clr)

Accessor for a mapping, for a java type complete with the datastore mapping.

Parameters:

c - The java type

serialised - Whether the type is serialised

embedded - Whether the type is embedded

clr - ClassLoader resolver

Returns:

The mapping

getMapping

JavaTypeMapping getMapping(Table table,
                           org.datanucleus.metadata.AbstractMemberMetaData mmd,
                           org.datanucleus.ClassLoaderResolver clr,
                           org.datanucleus.metadata.FieldRole fieldRole)

Accessor for the mapping for the field of the specified table. Can be used for fields of a class, elements of a collection of a class, elements of an array of a class, keys of a map of a class, values of a map of a class. This is controlled by the final argument "roleForMember".

Parameters:

table - Table to add the mapping to

mmd - MetaData for the field/property to map

clr - The ClassLoaderResolver

fieldRole - Role that this mapping plays for the field/property

Returns:

The mapping for the field.

createColumn

Column createColumn(JavaTypeMapping mapping,
                    String javaType,
                    int datastoreFieldIndex)

Method to create a datastore field (column) in a container (table).

Parameters:

mapping - The java mapping

javaType - The java type

datastoreFieldIndex - The index of the datastore field to create

Returns:

The datastore field

createColumn

Column createColumn(JavaTypeMapping mapping,
                    String javaType,
                    org.datanucleus.metadata.ColumnMetaData colmd)

Method to create a datastore field (column) in a container (table). To be used for serialised PC element/key/value in a join table.

Parameters:

mapping - The java mapping

javaType - The java type

colmd - MetaData for the column to create

Returns:

The column

createColumn

Column createColumn(org.datanucleus.metadata.AbstractMemberMetaData fmd,
                    Table table,
                    JavaTypeMapping mapping,
                    org.datanucleus.metadata.ColumnMetaData colmd,
                    Column referenceCol,
                    org.datanucleus.ClassLoaderResolver clr)

Method to create a column for a persistable mapping.

Parameters:

fmd - MetaData for the field

table - Table in the datastore

mapping - The java mapping

colmd - MetaData for the column to create

referenceCol - The column to reference

clr - ClassLoader resolver

Returns:

The column