org.datanucleus.store.types

Class TypeManager

java.lang.Object

org.datanucleus.store.types.TypeManager

All Implemented Interfaces:

Serializable

public class TypeManager
extends Object
implements Serializable

Registry of java type support. Provides information applicable to all datastores for how a field of a class is treated; whether it is by default persistent, whether it is by default embedded, whether it is in the DFG, and if it has a wrapper for SCO operations. Also stores whether the type can be converted to/from a String (for datastores that don't provide storage natively). Uses the plugin mechanism extension-point "org.datanucleus.java_type".

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,TypeConverter>	autoApplyConvertersByType
protected ClassLoaderResolver	clr
protected Map<String,TypeConverter>	convertersByName Map of TypeConverter keyed by their symbolic name.
protected Map<String,org.datanucleus.store.types.TypeManager.JavaType>	javaTypes Map of java types, keyed by the class name.
protected NucleusContext	nucCtx
protected Map<Class,Map<Class,TypeConverter>>	typeConverterMap Map of (Map of TypeConverter keyed by the datastore type), keyed by the member type.

Constructor Summary

Constructors

Constructor and Description
TypeManager(NucleusContext nucCtx) Constructor, loading support for type mappings using the plugin mechanism.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addJavaType(org.datanucleus.store.types.TypeManager.JavaType type)
String[]	filterOutSupportedSecondClassNames(String[] inputClassNames) Convenience method to filter out any supported classes from a list.
protected org.datanucleus.store.types.TypeManager.JavaType	findJavaTypeForClass(Class cls) Convenience method to return the JavaType for the specified class.
protected org.datanucleus.store.types.TypeManager.JavaType	findJavaTypeForCollectionClass(Class cls, Class genericType) Convenience method to return the JavaType for the specified class.
TypeConverter	getAutoApplyTypeConverterFortype(Class memberType)
protected ClassLoaderResolver	getClassLoaderResolver()
static Class	getDatastoreTypeForTypeConverter(TypeConverter conv, Class memberType)
TypeConverter	getDefaultTypeConverterForType(Class memberType) Accessor for the default type converter for the provided Java type.
static Class	getMemberTypeForTypeConverter(TypeConverter conv, Class datastoreType)
Set<String>	getSupportedSecondClassTypes() Accessor for the supported second-class Types.
TypeConverter	getTypeConverterForName(String converterName) Accessor for the type converter with the provided name.
TypeConverter	getTypeConverterForType(Class memberType, Class datastoreType) Accessor for the type converter for the provided Java type and its datastore type.
Class	getTypeForSecondClassWrapper(String className) Accessor for a java type that the supplied class is a SCO wrapper for.
Class	getWrappedTypeBackedForType(String className) Accessor for the backing-store Second Class Wrapper class for the supplied class.
Class	getWrapperTypeForType(String className) Accessor for the SCO wrapper for the type
boolean	isDefaultEmbeddedType(Class c) Accessor for whether the type is by default embedded.
boolean	isDefaultFetchGroup(Class c) Accessor for whether the type is by default in the DFG.
boolean	isDefaultFetchGroupForCollection(Class c, Class genericType) Accessor for whether the generic collection type is by default in the DFG.
boolean	isDefaultPersistent(Class c) Accessor for whether the type is by default persistent.
boolean	isSecondClassMutableType(String className) Accessor for whether the type is SCO mutable.
boolean	isSecondClassWrapper(String className) Accessor for whether the type is a SCO wrapper itself.
boolean	isSupportedSecondClassType(String className) Accessor for whether a class is supported as being second class.
void	registerConverter(String name, TypeConverter converter) TypeConverters are registered either from the contents of "plugin.xml" (i.e the builtin types) where the name is of the form "dn.*", or from user-registered metadata (e.g JPA Annotations) where the name is the class name of the converter.
void	registerConverter(String name, TypeConverter converter, boolean autoApply, String autoApplyType) Register a TypeConverter with the TypeManager process.

Methods inherited from class java.lang.Object

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

Field Detail

nucCtx

protected NucleusContext nucCtx

clr

protected transient ClassLoaderResolver clr

javaTypes

protected Map<String,org.datanucleus.store.types.TypeManager.JavaType> javaTypes

Map of java types, keyed by the class name.

convertersByName

protected Map<String,TypeConverter> convertersByName

Map of TypeConverter keyed by their symbolic name.

autoApplyConvertersByType

protected Map<String,TypeConverter> autoApplyConvertersByType

typeConverterMap

protected Map<Class,Map<Class,TypeConverter>> typeConverterMap

Map of (Map of TypeConverter keyed by the datastore type), keyed by the member type.

Constructor Detail

TypeManager

public TypeManager(NucleusContext nucCtx)

Constructor, loading support for type mappings using the plugin mechanism.

Parameters:

nucCtx - NucleusContext

Method Detail

getClassLoaderResolver

protected ClassLoaderResolver getClassLoaderResolver()

getSupportedSecondClassTypes

public Set<String> getSupportedSecondClassTypes()

Accessor for the supported second-class Types. This may or may not be a complete list, just that it provides the principal ones.

Returns:

Set of supported types (fully qualified class names).

isSupportedSecondClassType

public boolean isSupportedSecondClassType(String className)

Accessor for whether a class is supported as being second class.

Parameters:

className - The class name

Returns:

Whether the class is supported (to some degree)

filterOutSupportedSecondClassNames

public String[] filterOutSupportedSecondClassNames(String[] inputClassNames)

Convenience method to filter out any supported classes from a list.

Parameters:

inputClassNames - Names of the classes

Returns:

Names of the classes (omitting supported types)

isDefaultPersistent

public boolean isDefaultPersistent(Class c)

Accessor for whether the type is by default persistent. TODO Support use of apiAdapter.isMemberDefaultPersistent to get strict JDO/JPA behaviour.

Parameters:

c - The type

Returns:

Whether persistent

isDefaultFetchGroup

public boolean isDefaultFetchGroup(Class c)

Accessor for whether the type is by default in the DFG.

Parameters:

c - The type

Returns:

Whether in the DFG

isDefaultFetchGroupForCollection

public boolean isDefaultFetchGroupForCollection(Class c,
                                       Class genericType)

Accessor for whether the generic collection type is by default in the DFG.

Parameters:

c - The type

genericType - The element generic type

Returns:

Whether in the DFG

isDefaultEmbeddedType

public boolean isDefaultEmbeddedType(Class c)

Accessor for whether the type is by default embedded.

Parameters:

c - The type

Returns:

Whether embedded

isSecondClassMutableType

public boolean isSecondClassMutableType(String className)

Accessor for whether the type is SCO mutable.

Parameters:

className - The type

Returns:

Whether SCO mutable

getWrapperTypeForType

public Class getWrapperTypeForType(String className)

Accessor for the SCO wrapper for the type

Parameters:

className - The type

Returns:

SCO wrapper

getWrappedTypeBackedForType

public Class getWrappedTypeBackedForType(String className)

Accessor for the backing-store Second Class Wrapper class for the supplied class. A type will have a SCO wrapper if it is SCO supported and is mutable. If there is no backed wrapper provided returns the simple wrapper.

Parameters:

className - The class name

Returns:

The second class wrapper

isSecondClassWrapper

public boolean isSecondClassWrapper(String className)

Accessor for whether the type is a SCO wrapper itself.

Parameters:

className - The type

Returns:

Whether is SCO wrapper

getTypeForSecondClassWrapper

public Class getTypeForSecondClassWrapper(String className)

Accessor for a java type that the supplied class is a SCO wrapper for. If the supplied class is not a SCO wrapper for anything then returns null.

Parameters:

className - Name of the class

Returns:

The java class that this is a wrapper for (or null)

getTypeConverterForName

public TypeConverter getTypeConverterForName(String converterName)

Accessor for the type converter with the provided name.

Parameters:

converterName - Name of the converter

Returns:

The converter

registerConverter

public void registerConverter(String name,
                     TypeConverter converter,
                     boolean autoApply,
                     String autoApplyType)

Register a TypeConverter with the TypeManager process.

Parameters:

name - The name to register the converter under

converter - The converter

autoApply - Whether this should be used as an auto-apply converter

registerConverter

public void registerConverter(String name,
                     TypeConverter converter)

TypeConverters are registered either from the contents of "plugin.xml" (i.e the builtin types) where the name is of the form "dn.*", or from user-registered metadata (e.g JPA Annotations) where the name is the class name of the converter.

Parameters:

name - The name to register the converter under

converter - The converter

getAutoApplyTypeConverterFortype

public TypeConverter getAutoApplyTypeConverterFortype(Class memberType)

getDefaultTypeConverterForType

public TypeConverter getDefaultTypeConverterForType(Class memberType)

Accessor for the default type converter for the provided Java type.

Parameters:

memberType - Java type for the member

Returns:

The default converter (if any)

getTypeConverterForType

public TypeConverter getTypeConverterForType(Class memberType,
                                    Class datastoreType)

Accessor for the type converter for the provided Java type and its datastore type.

Parameters:

memberType - Java type for the member

datastoreType - Java type for the datastore

Returns:

The converter (if any)

findJavaTypeForClass

protected org.datanucleus.store.types.TypeManager.JavaType findJavaTypeForClass(Class cls)

Convenience method to return the JavaType for the specified class. If this class has a defined JavaType then returns it. If not then tries to find a superclass that is castable to the specified type.

Parameters:

cls - The class required

Returns:

The JavaType

findJavaTypeForCollectionClass

protected org.datanucleus.store.types.TypeManager.JavaType findJavaTypeForCollectionClass(Class cls,
                                                                              Class genericType)

Convenience method to return the JavaType for the specified class. If this class has a defined JavaType then returns it. If not then tries to find a superclass that is castable to the specified type.

Parameters:

cls - The class required

Returns:

The JavaType

addJavaType

protected void addJavaType(org.datanucleus.store.types.TypeManager.JavaType type)

getMemberTypeForTypeConverter

public static Class getMemberTypeForTypeConverter(TypeConverter conv,
                                  Class datastoreType)

getDatastoreTypeForTypeConverter

public static Class getDatastoreTypeForTypeConverter(TypeConverter conv,
                                     Class memberType)