org.datanucleus.store.rdbms.mapping

Class RDBMSMappingManager

java.lang.Object

org.datanucleus.store.rdbms.mapping.RDBMSMappingManager

All Implemented Interfaces:

MappingManager

Direct Known Subclasses:

OracleRDBMSMappingManager

public class RDBMSMappingManager
extends Object
implements MappingManager

Mapping manager for RDBMS datastores. Provides mappings from standard Java types (defined in org.datanucleus.store.rdbms.mapping.java) to datastore mappings for JDBC types (defined in org.datanucleus.store.rdbms.mapping.datastore).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RDBMSMappingManager.MappingConverterDetails
protected class	RDBMSMappingManager.RDBMSTypeMapping

Field Summary

Fields

Modifier and Type	Field and Description
protected org.datanucleus.ClassLoaderResolver	clr
protected org.datanucleus.util.MultiMap	datastoreMappingsByJavaType
protected org.datanucleus.util.MultiMap	datastoreMappingsByJDBCType
protected org.datanucleus.util.MultiMap	datastoreMappingsBySQLType
protected RDBMSStoreManager	storeMgr

Constructor Summary

Constructors

Constructor and Description
RDBMSMappingManager(RDBMSStoreManager storeMgr) Constructor for a mapping manager for an RDBMS datastore.

Method Summary

Modifier and Type	Method and Description
Column	createColumn(org.datanucleus.metadata.AbstractMemberMetaData mmd, Table table, JavaTypeMapping mapping, org.datanucleus.metadata.ColumnMetaData colmd, Column reference, org.datanucleus.ClassLoaderResolver clr) Method to create a datastore field for a persistable mapping.
Column	createColumn(JavaTypeMapping mapping, String javaType, org.datanucleus.metadata.ColumnMetaData colmd) Method to create a datastore field for a Java type mapping.
Column	createColumn(JavaTypeMapping mapping, String javaType, int datastoreFieldIndex) Method to create a column for a Java type mapping.
DatastoreMapping	createDatastoreMapping(JavaTypeMapping mapping, org.datanucleus.metadata.AbstractMemberMetaData mmd, 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.
void	deregisterDatastoreMappingsForJDBCType(String jdbcTypeName) Utility to deregister all mappings for a JDBC type.
protected Class	getDatastoreMappingClass(String fieldName, String javaType, String jdbcType, String sqlType, org.datanucleus.ClassLoaderResolver clr) Accessor for a datastore mapping class for the specified java type (and optional jdbc type or sql type).
protected RDBMSMappingManager.MappingConverterDetails	getDefaultJavaTypeMapping(Class javaType, org.datanucleus.metadata.ColumnMetaData[] colmds) Method to return the default java type mapping class for a specified java type.
protected JavaTypeMapping	getElementMapping(Table table, org.datanucleus.metadata.AbstractMemberMetaData mmd, org.datanucleus.metadata.FieldRole fieldRole, org.datanucleus.ClassLoaderResolver clr) Convenience accessor for the element mapping for the element of a collection/array of elements.
protected JavaTypeMapping	getKeyMapping(Table table, org.datanucleus.metadata.AbstractMemberMetaData mmd, org.datanucleus.ClassLoaderResolver clr) Convenience accessor for the mapping of the key of a map.
JavaTypeMapping	getMapping(Class javaType) Accessor for the mapping for the specified class.
JavaTypeMapping	getMapping(Class javaType, boolean serialised, boolean embedded, String fieldName) Accessor for the mapping for the specified class.
JavaTypeMapping	getMapping(Table table, org.datanucleus.metadata.AbstractMemberMetaData mmd, org.datanucleus.ClassLoaderResolver clr, org.datanucleus.metadata.FieldRole fieldRole) Accessor for the mapping for the member of the specified table.
protected RDBMSMappingManager.MappingConverterDetails	getMappingClass(Class javaType, boolean serialised, boolean embedded, org.datanucleus.metadata.ColumnMetaData[] colmds, String fieldName) Accessor for the mapping class for the specified type.
JavaTypeMapping	getMappingWithDatastoreMapping(Class javaType, boolean serialised, boolean embedded, org.datanucleus.ClassLoaderResolver clr) Accessor for the mapping for the specified class.
protected Class	getOverrideMappingClass(Class mappingClass, org.datanucleus.metadata.AbstractMemberMetaData mmd, org.datanucleus.metadata.FieldRole fieldRole) Convenience method to allow overriding of particular mapping classes.
protected JavaTypeMapping	getValueMapping(Table table, org.datanucleus.metadata.AbstractMemberMetaData mmd, org.datanucleus.ClassLoaderResolver clr) Convenience accessor for the mapping of the value for a map.
void	loadDatastoreMapping(org.datanucleus.plugin.PluginManager mgr, org.datanucleus.ClassLoaderResolver clr, String vendorId) Load all datastore mappings defined in the associated plugins.
void	registerDatastoreMapping(String javaTypeName, Class datastoreMappingType, String jdbcType, String sqlType, boolean dflt) Utility to register a datastore mapping for a java type, and the SQL/JDBC types it can be mapped to.

Methods inherited from class java.lang.Object

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

Field Detail

storeMgr

protected final RDBMSStoreManager storeMgr

clr

protected final org.datanucleus.ClassLoaderResolver clr

datastoreMappingsByJavaType

protected org.datanucleus.util.MultiMap datastoreMappingsByJavaType

datastoreMappingsByJDBCType

protected org.datanucleus.util.MultiMap datastoreMappingsByJDBCType

datastoreMappingsBySQLType

protected org.datanucleus.util.MultiMap datastoreMappingsBySQLType

Constructor Detail

RDBMSMappingManager

public RDBMSMappingManager(RDBMSStoreManager storeMgr)

Constructor for a mapping manager for an RDBMS datastore.

Parameters:

storeMgr - The StoreManager

Method Detail

loadDatastoreMapping

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

Load all datastore mappings defined in the associated plugins. We handle RDBMS datastore mappings so refer to rdbms-mapping-class, jdbc-type, sql-type in particular.

Specified by:

loadDatastoreMapping in interface MappingManager

Parameters:

mgr - the PluginManager

clr - the ClassLoaderResolver

vendorId - the datastore vendor id

getMappingWithDatastoreMapping

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

Accessor for the mapping for the specified class. Usually only called by JDOQL query expressions. If the type has its own table returns the id mapping of the table. If the type doesn't have its own table then creates the mapping and, if it has a simple datastore representation, creates the datastore mapping. The JavaTypeMapping has no metadata/table associated.

Specified by:

getMappingWithDatastoreMapping in interface MappingManager

Parameters:

javaType - Java type

serialised - Whether the type is serialised

embedded - Whether the type is embedded

clr - ClassLoader resolver

Returns:

The mapping for the class.

getMapping

public JavaTypeMapping getMapping(Class javaType)

Accessor for the mapping for the specified class. This simply creates a JavaTypeMapping for the java type and returns it. The mapping has no underlying datastore mapping(s) and no associated field/table.

Specified by:

getMapping in interface MappingManager

Parameters:

javaType - Java type

Returns:

The mapping for the class.

getMapping

public JavaTypeMapping getMapping(Class javaType,
                                  boolean serialised,
                                  boolean embedded,
                                  String fieldName)

Accessor for the mapping for the specified class. This simply creates a JavaTypeMapping for the java type and returns it. The mapping has no underlying datastore mapping(s) and no associated field/table.

Specified by:

getMapping in interface MappingManager

Parameters:

javaType - Java type

serialised - Whether the type is serialised

embedded - Whether the type is embedded

fieldName - Name of the field (for logging)

Returns:

The mapping for the class.

getMapping

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

Accessor for the mapping for the member of the specified table. Can be used for members of a class, element of a collection of a class, element 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 role argument.

Specified by:

getMapping in interface MappingManager

Parameters:

table - Table to add the mapping to

mmd - MetaData for the member to map

clr - The ClassLoaderResolver

fieldRole - Role that this mapping plays for the field

Returns:

The mapping for the member.

getMappingClass

protected RDBMSMappingManager.MappingConverterDetails getMappingClass(Class javaType,
                                                                      boolean serialised,
                                                                      boolean embedded,
                                                                      org.datanucleus.metadata.ColumnMetaData[] colmds,
                                                                      String fieldName)

Accessor for the mapping class for the specified type. Provides special handling for interface types and for classes that are being embedded in a field. Refers others to its mapping manager lookup.

Parameters:

javaType - Class to query

serialised - Whether the field is serialised

embedded - Whether the field is embedded

colmds - Metadata for column(s) (optional)

fieldName - The full field name (for logging only)

Returns:

The mapping class for the class

getElementMapping

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

Convenience accessor for the element mapping for the element of a collection/array of elements. Currently only used where the collection/array elements are serialised/embedded into a join table.

Parameters:

table - The table

mmd - MetaData for the collection member containing the collection/array of PCs

fieldRole - role of this mapping for this member

clr - ClassLoader resolver

Returns:

The mapping

getKeyMapping

protected JavaTypeMapping getKeyMapping(Table table,
                                        org.datanucleus.metadata.AbstractMemberMetaData mmd,
                                        org.datanucleus.ClassLoaderResolver clr)

Convenience accessor for the mapping of the key of a map. Currently only used where the keys are serialised/embedded into a join table.

Parameters:

table - The container

mmd - MetaData for the field containing the map that this key is for

clr - ClassLoader resolver

Returns:

The mapping

getValueMapping

protected JavaTypeMapping getValueMapping(Table table,
                                          org.datanucleus.metadata.AbstractMemberMetaData mmd,
                                          org.datanucleus.ClassLoaderResolver clr)

Convenience accessor for the mapping of the value for a map. Currently only used where the value are serialised/embedded into a join table.

Parameters:

table - The container

mmd - MetaData for the field/property containing the map that this value is for

clr - ClassLoader resolver

Returns:

The mapping

getDefaultJavaTypeMapping

protected RDBMSMappingManager.MappingConverterDetails getDefaultJavaTypeMapping(Class javaType,
                                                                                org.datanucleus.metadata.ColumnMetaData[] colmds)

Method to return the default java type mapping class for a specified java type.

Parameters:

javaType - java type

colmds - Metadata for the column(s) (optional)

Returns:

The mapping class to use (by default)

registerDatastoreMapping

public void registerDatastoreMapping(String javaTypeName,
                                     Class datastoreMappingType,
                                     String jdbcType,
                                     String sqlType,
                                     boolean dflt)

Utility to register a datastore mapping for a java type, and the SQL/JDBC types it can be mapped to. This can also be called to change the default setting of a mapping - just supply the same values of java/JDBC/SQL types and a different default value

Parameters:

javaTypeName - Name of the java type

datastoreMappingType - The datastore mapping

jdbcType - The JDBC type that can be used

sqlType - The SQL type that can be used

dflt - Whether this type should be used as the default mapping for this Java type

deregisterDatastoreMappingsForJDBCType

public void deregisterDatastoreMappingsForJDBCType(String jdbcTypeName)

Utility to deregister all mappings for a JDBC type.

Parameters:

jdbcTypeName - The JDBC type name

getOverrideMappingClass

protected Class getOverrideMappingClass(Class mappingClass,
                                        org.datanucleus.metadata.AbstractMemberMetaData mmd,
                                        org.datanucleus.metadata.FieldRole fieldRole)

Convenience method to allow overriding of particular mapping classes. This is currently only required for Oracle due to non-standard BLOB handlers.

Parameters:

mappingClass - The mapping class selected

mmd - Meta data for the member (if appropriate)

fieldRole - Role for the field (e.g collection element)

Returns:

The mapping class to use

getDatastoreMappingClass

protected Class getDatastoreMappingClass(String fieldName,
                                         String javaType,
                                         String jdbcType,
                                         String sqlType,
                                         org.datanucleus.ClassLoaderResolver clr)

Accessor for a datastore mapping class for the specified java type (and optional jdbc type or sql type).

Parameters:

fieldName - Name of the field (if known)

javaType - The java type

jdbcType - The JDBC type

sqlType - The SQL Type

clr - ClassLoader resolver to use

Returns:

The datastore mapping class

createDatastoreMapping

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

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

Specified by:

createDatastoreMapping in interface MappingManager

Parameters:

mapping - The java mapping

mmd - MetaData for the field/property

index - Index of the column

column - The column

Returns:

The datastore mapping

createDatastoreMapping

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

Method to create the datastore mapping for a particular column and java type. If the column is specified it is linked to the created datastore mapping.

Specified by:

createDatastoreMapping in interface MappingManager

Parameters:

mapping - The java mapping

column - The column (can be null)

javaType - The java type

Returns:

The datastore mapping

createColumn

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

Method to create a column for a Java type mapping. This is NOT used for persistable mappings - see method below.

Specified by:

createColumn in interface MappingManager

Parameters:

mapping - Java type mapping for the field

javaType - The type of field being stored in this column

datastoreFieldIndex - Index of the datastore field to use

Returns:

The datastore field

createColumn

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

Method to create a datastore field for a Java type mapping. This is used for serialised PC elements/keys/values in a join table. TODO Merge this with the method above.

Specified by:

createColumn in interface MappingManager

Parameters:

mapping - Java type mapping for the field

javaType - The type of field being stored in this column

colmd - MetaData for the column

Returns:

The column

createColumn

public Column createColumn(org.datanucleus.metadata.AbstractMemberMetaData mmd,
                           Table table,
                           JavaTypeMapping mapping,
                           org.datanucleus.metadata.ColumnMetaData colmd,
                           Column reference,
                           org.datanucleus.ClassLoaderResolver clr)

Method to create a datastore field for a persistable mapping.

Specified by:

createColumn in interface MappingManager

Parameters:

mmd - MetaData for the field whose mapping it is

table - Datastore class where we create the datastore field

mapping - The Java type for this field

colmd - The columnMetaData for this datastore field

reference - The datastore field we are referencing

clr - ClassLoader resolver

Returns:

The column