Class XMLMappingLoader

java.lang.Object

org.exolab.castor.mapping.loader.AbstractMappingLoader2

org.exolab.castor.mapping.loader.AbstractMappingLoader

org.exolab.castor.xml.XMLMappingLoader

All Implemented Interfaces:

MappingLoader

public final class XMLMappingLoader
extends AbstractMappingLoader

An XML implementation of mapping helper. Creates XML class descriptors from the mapping file.

Version:

$Revision: 9176 $ $Date: 2006-02-23 01:37:50 -0700 (Thu, 23 Feb 2006) $

Author:

Keith Visco, Assaf Arkin

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMappingLoader

AbstractMappingLoader.TypeInfoReference

Modifier and Type	Class	Description
class	AbstractMappingLoader.TypeInfoReference	A class used to by the createFieldHandler method in order to save the reference of the TypeInfo that was used.

Field Summary

Fields inherited from class AbstractMappingLoader

NAME

Modifier and Type	Field	Description
protected static final String	NAME	Method name to get string value of a type-safe enumerations.

Constructor Summary

Constructors

Constructor	Description
XMLMappingLoader(ClassLoader loader)	Creates a new XMLMappingLoader.

Method Summary

Modifier and Type	Method	Description
protected ClassDescriptor	createClassDescriptor(ClassMapping classMapping)	To create the class descriptor for the given class mapping.
protected FieldDescriptorImpl	createFieldDesc(Class javaClass, FieldMapping fieldMap)	Creates a single field descriptor.
protected final FieldDescriptor	findIdentityByName(List fldList, String idName, Class javaClass)
BindingType	getBindingType()
protected TypeInfo	getTypeInfo(Class fieldType, CollectionHandler colHandler, FieldMapping fieldMap)
void	loadMapping(MappingRoot mapping, Object param)	Loads the mapping from the specified mapping object if not loaded previously.
protected final void	resolveRelations(ClassDescriptor clsDesc)
void	setLoadPackageMappings(boolean loadPackageMappings)	Sets whether or not to look for and load package specific mapping files (".castor.xml" files).

Methods inherited from class AbstractMappingLoader

checkFieldNameDuplicates, createClassDescriptors, createFieldDescriptors, createFieldHandler, createFieldHandlers, divideFieldDescriptors, findAccessor, getDepended, getExtended, getIdColumnIndex, getIdentityColumnNames, getInternalContext, getOrigin, getSourceType, isPrimitive, resolveType, setInternalContext

Modifier and Type	Method	Description
protected final void	checkFieldNameDuplicates(FieldDescriptor[] fields, Class<?> cls)	Checks all given fields for name equality and throws a MappingException if at least two fields have the same name.
protected final void	createClassDescriptors(MappingRoot mapping)
protected final FieldDescriptorImpl[]	createFieldDescriptors(ClassMapping clsMap, Class<?> javaClass)	Create field descriptors.
protected final FieldHandler	createFieldHandler(Class<?> javaClass, Class<?> fldType, FieldMapping fldMap, AbstractMappingLoader.TypeInfoReference typeInfoRef)	Creates the FieldHandler for the given FieldMapping.
protected void	createFieldHandlers(MappingRoot mapping)	Load field handler definitions, check for duplicate definitions and instantiate the appropriate FieldHandler implementations.
protected final FieldDescriptor[]	divideFieldDescriptors(FieldDescriptor[] fields, String[] ids, FieldDescriptor[] identities)
static final Method	findAccessor(Class<?> javaClass, String methodName, Class<?> fieldType, boolean getMethod)	Returns the named accessor.
protected final ClassDescriptor	getDepended(ClassMapping clsMap, Class<?> javaClass)	Gets the ClassDescriptor the given classMapping depends on.
protected final ClassDescriptor	getExtended(ClassMapping clsMap, Class<?> javaClass)	Gets the ClassDescriptor the given classMapping extends.
protected int	getIdColumnIndex(FieldDescriptor field, String[] ids)	Finds the index in the given idColumnNames that has the same name as the given field.
static final String[]	getIdentityColumnNames(String[] ids, ClassMapping clsMap)	Returns a list of column names that are part of the identity.
InternalContext	getInternalContext()
protected final ClassMapping	getOrigin(ClassMapping clsMap)	Gets the top-most (i.e.
final String	getSourceType()
protected static final boolean	isPrimitive(Class<?> type)	Returns true if the given class should be treated as a primitive type
protected final Class<?>	resolveType(String typeName)	Returns the Java class for the named type.
void	setInternalContext(InternalContext internalContext)

Methods inherited from class AbstractMappingLoader2

addDescriptor, clear, getClassLoader, getDescriptor, getDescriptors, isAllowRedefinition, loadMapping, setAllowRedefinitions, setClassLoader

Modifier and Type	Method	Description
protected final void	addDescriptor(ClassDescriptor descriptor)	Adds a class descriptor.
final void	clear()
final ClassLoader	getClassLoader()	Returns the class loader associated with this mapping loader if one was specified.
final ClassDescriptor	getDescriptor(String classname)	Returns the ClassDescriptor for the class with the given name.
final List<ClassDescriptor>	getDescriptors()	Returns a List of ClassDescriptors of all known descriptors.
final boolean	isAllowRedefinition()	Is the ability to allow redefinitions enabled or disabled?
protected final boolean	loadMapping()	Return if mapping should be loaded with this MappingLoader instance or if another mapping have been loaded previously.
final void	setAllowRedefinitions(boolean allow)	Enables or disables the ability to allow the redefinition of class mappings.
final void	setClassLoader(ClassLoader loader)

Methods inherited from class Object

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

Constructor Details

XMLMappingLoader

public XMLMappingLoader(ClassLoader loader)

Creates a new XMLMappingLoader. Joachim 2007-08-19: called via ClassLoader from XMLMappingLoaderFactory.getMappingLoader() must not be modified!!!

Parameters:

loader - the class loader to use

Method Details

getBindingType

public BindingType getBindingType()

loadMapping

public void loadMapping(MappingRoot mapping,
 Object param)
                 throws MappingException

Loads the mapping from the specified mapping object if not loaded previously.

Specified by:

loadMapping in class AbstractMappingLoader

Parameters:

mapping - The mapping information.

param - Arbitrary parameter that can be used by subclasses.

Throws:

MappingException - The mapping file is invalid.

createClassDescriptor

protected ClassDescriptor createClassDescriptor(ClassMapping classMapping)
                                         throws MappingException

To create the class descriptor for the given class mapping. Throws IllegalStateException if the class has no valid internal context.

Specified by:

createClassDescriptor in class AbstractMappingLoader

Parameters:

classMapping - the class mapping information to process

Returns:

the ClassDescriptor created for the class mapping

Throws:

MappingException - ...

findIdentityByName

protected final FieldDescriptor findIdentityByName(List fldList,
 String idName,
 Class javaClass)

resolveRelations

protected final void resolveRelations(ClassDescriptor clsDesc)

Specified by:

resolveRelations in class AbstractMappingLoader

createFieldDesc

protected FieldDescriptorImpl createFieldDesc(Class javaClass,
 FieldMapping fieldMap)
                                       throws MappingException

Description copied from class: AbstractMappingLoader

Creates a single field descriptor. The field mapping is used to create a new stock FieldDescriptor. Implementations may extend this class to create a more suitable descriptor.

Overrides:

createFieldDesc in class AbstractMappingLoader

Parameters:

javaClass - The class to which the field belongs.

fieldMap - The field mapping information.

Returns:

The field descriptor.

Throws:

MappingException - The field or its accessor methods are not found, not accessible, not of the specified type, etc.

setLoadPackageMappings

public void setLoadPackageMappings(boolean loadPackageMappings)

Sets whether or not to look for and load package specific mapping files (".castor.xml" files).

Parameters:

loadPackageMappings - a boolean that enables or disables the loading of package specific mapping files

getTypeInfo

protected TypeInfo getTypeInfo(Class fieldType,
 CollectionHandler colHandler,
 FieldMapping fieldMap)
                        throws MappingException

Overrides:

getTypeInfo in class AbstractMappingLoader

Throws:

MappingException