org.exolab.castor.mapping

Class Mapping

public class Mapping extends Object

Utility class for loading mapping files and providing them to the XML marshaller, JDO engine etc. The mapping file can be loaded from a URL, input stream or SAX InputSource.

Multiple mapping files can be loaded with the same Mapping object. When loading master mapping files that include other mapping files it might be convenient to use Mapping or Mapping.

If the desired class loader is different than the one used by Castor (e.g. if Castor is installed as a Java extension), the Mapping object can be constructed with the proper class loader.

The following example loads two mapping files:

 Mapping mapping;

 mapping = new Mapping( getClass().getClassLoader() );
 mapping.loadMapping( "mapping.xml" );
 mapping.loadMapping( url );
 

Version: $Revision: 1.1.1.1 $ $Date: 2003/03/03 07:08:27 $

Author: Assaf Arkin

Nested Class Summary
classMapping.ClassMappingResolver
An IDResolver to allow us to resolve ClassMappings from included Mapping files
static classMapping.EngineMapping
Associates engine name (XML, JDO, etc) with the class of its mapping loader.
classMapping.MappingState
A class to keep track of the loaded mapping.
Field Summary
static Mapping.EngineMappingDAX
Use this object to obtain the mapping resolver for DAX from Mapping.
static Mapping.EngineMappingJDO
Use this object to obtain the mapping resolver for JDO from Mapping.
static Mapping.EngineMappingXML
Use this object to obtain the mapping resolver for XML from Mapping.
Constructor Summary
Mapping(ClassLoader loader)
Constructs a new mapping.
Mapping()
Constructs a new mapping.
Method Summary
ClassLoadergetClassLoader()
Returns the class loader used by this mapping object.
MappingResolvergetResolver(Mapping.EngineMapping engine)
Returns a mapping resolver for the suitable engine.
MappingResolvergetResolver(Mapping.EngineMapping engine, Object param)
Returns a mapping resolver for the suitable engine.
MappingRootgetRoot()
Returns a MappingRoot which contains all loaded mapping classes and key generators definition.
voidloadMapping(String url)
Loads the mapping from the specified URL.
voidloadMapping(URL url)
Loads the mapping from the specified URL.
voidloadMapping(InputSource source)
Loads the mapping from the specified input source.
voidsetAllowRedefinitions(boolean allow)
Enables or disables the ability to allow the redefinition of class mappings.
voidsetBaseURL(String url)
Sets the base URL for the mapping and related files.
voidsetEntityResolver(EntityResolver resolver)
Sets the entity resolver.
voidsetLogWriter(PrintWriter logWriter)
Sets the log writer.

Field Detail

DAX

public static final Mapping.EngineMapping DAX
Use this object to obtain the mapping resolver for DAX from Mapping.

JDO

public static final Mapping.EngineMapping JDO
Use this object to obtain the mapping resolver for JDO from Mapping.

XML

public static final Mapping.EngineMapping XML
Use this object to obtain the mapping resolver for XML from Mapping.

Constructor Detail

Mapping

public Mapping(ClassLoader loader)
Constructs a new mapping.

Parameters: loader The class loader to use, null for the default

Mapping

public Mapping()
Constructs a new mapping.

Method Detail

getClassLoader

public ClassLoader getClassLoader()
Returns the class loader used by this mapping object. The returned class loaded may be the one passed in the constructor, the one used to load Castor, or in some 1.1 JVMs null.

Returns: The class loader used by this mapping object (may be null)

getResolver

public MappingResolver getResolver(Mapping.EngineMapping engine)
Returns a mapping resolver for the suitable engine. The engine's specific mapping loader is created and used to create engine specific descriptors, returning a suitable mapping resolver. The mapping resolver is cached in memory and returned in subsequent method calls.

Parameters: engine The mapping engine

Returns: A mapping resolver

Throws: MappingException A mapping error occured preventing descriptors from being generated from the loaded mapping

See Also: JDO XML DAX

getResolver

public MappingResolver getResolver(Mapping.EngineMapping engine, Object param)
Returns a mapping resolver for the suitable engine. The engine's specific mapping loader is created and used to create engine specific descriptors, returning a suitable mapping resolver. The mapping resolver is cached in memory and returned in subsequent method calls.

Parameters: engine The mapping engine param Arbitrary parameter that is to be passed to resolver.loadMapping()

Returns: A mapping resolver

Throws: MappingException A mapping error occured preventing descriptors from being generated from the loaded mapping

See Also: JDO XML DAX

getRoot

public MappingRoot getRoot()
Returns a MappingRoot which contains all loaded mapping classes and key generators definition.

loadMapping

public void loadMapping(String url)
Loads the mapping from the specified URL. If an entity resolver was specified, will use the entity resolver to resolve the URL. This method is also used to load mappings referenced from another mapping or configuration file.

Parameters: url The URL of the mapping file

Throws: IOException An error occured when reading the mapping file MappingException The mapping file is invalid

loadMapping

public void loadMapping(URL url)
Loads the mapping from the specified URL.

Parameters: url The URL of the mapping file

Throws: IOException An error occured when reading the mapping file MappingException The mapping file is invalid

loadMapping

public void loadMapping(InputSource source)
Loads the mapping from the specified input source.

Parameters: source The input source

Throws: IOException An error occured when reading the mapping file MappingException The mapping file is invalid

setAllowRedefinitions

public void setAllowRedefinitions(boolean allow)
Enables or disables the ability to allow the redefinition of class mappings.

Parameters: allow a boolean that when true enables redefinitions.

setBaseURL

public void setBaseURL(String url)
Sets the base URL for the mapping and related files. If the base URL is known, files can be included using relative names. Any URL can be passed, if the URL can serve as a base URL it will be used. If url is an absolute path, it is converted to a file URL.

Parameters: url The base URL

setEntityResolver

public void setEntityResolver(EntityResolver resolver)
Sets the entity resolver. The entity resolver can be used to resolve external entities and cached documents that are used from within mapping files.

Parameters: resolver The entity resolver to use

setLogWriter

public void setLogWriter(PrintWriter logWriter)
Sets the log writer. If not null, errors and other messages will be directed to that log writer.

Parameters: logWriter The log writer to use

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com