org.exolab.castor.xml
Class Marshaller

java.lang.Object
  org.exolab.castor.xml.MarshalFramework
      org.exolab.castor.xml.Marshaller

public class Marshaller

extends org.exolab.castor.xml.MarshalFramework

A Marshaller to allowing serializing Java Object's to XML Note: This class is not thread safe, and not intended to be, so please create a new Marshaller for each thread if it is to be used in a multithreaded environment.

Version:

$Revision: 1.13 $ $Date: 2004/03/08 07:35:56 $

Author:

Keith Visco

Nested Class Summary

static class

MarshalFramework.InheritanceMatch Used to store the information when we find a possible inheritance.

Field Summary

static boolean	enableDebug A static flag used to enable debugging when using the static marshal methods.
static java.lang.String	XML_LANG_ATTR The xml:lang attribute name
static java.lang.String	XML_SPACE_ATTR The xml:space attribute name
static java.lang.String	XSI_NAMESPACE The XSI Namespace URI
static java.lang.String	XSI_NO_NAMESPACE_SCHEMA_LOCATION The name of the no namespace schema location attribute
static java.lang.String	XSI_SCHEMA_LOCATION The name of the Schema location attribute

Constructor Summary

Marshaller(org.xml.sax.ContentHandler handler)
Creates a new Marshaller with the given SAX ContentHandler.

Marshaller(org.xml.sax.DocumentHandler handler)
Creates a new Marshaller with the given DocumentHandler.

Marshaller(org.w3c.dom.Node node)
Creates a new Marshaller for the given DOM Node.

Marshaller(java.io.Writer out)
Creates a new Marshaller with the given writer.

Method Summary

void	addProcessingInstruction(java.lang.String target, java.lang.String data) Adds the given processing instruction data to the set of processing instructions to output during marshalling.
CollectionHandler	getCollectionHandler(java.lang.Class clazz) Returns the CollectionHandler associated with the given collection, or null if no such handler exists.
boolean	getMarshalExtendedType() If True the marshaller will use the 'xsi:type' attribute to marshall a field value that extended the defined field type.
boolean	getNSPrefixAtRoot() Deprecated.
java.lang.String	getRootElement() Returns the name of the root element to use
static boolean	isCollection(java.lang.Class clazz) Returns true if the given Class is a considered a collection by the marshalling framework.
void	marshal(java.lang.Object object) Marshals the given Object as XML using the DocumentHandler for this Marshaller.
static void	marshal(java.lang.Object object, org.xml.sax.ContentHandler handler) Marshals the given Object as XML using the given ContentHandler to send events to.
static void	marshal(java.lang.Object object, org.xml.sax.DocumentHandler handler) Marshals the given Object as XML using the given DocumentHandler to send events to.
static void	marshal(java.lang.Object object, org.w3c.dom.Node node) Marshals the given Object as XML using the given DOM Node to send events to.
static void	marshal(java.lang.Object object, java.io.Writer out) Marshals the given Object as XML using the given writer
static boolean	namespaceEquals(java.lang.String ns1, java.lang.String ns2) Compares the given namespaces (as strings) for equality.
static MarshalFramework.InheritanceMatch[]	searchInheritance(java.lang.String name, java.lang.String namespace, XMLClassDescriptor classDesc, ClassDescriptorResolver cdResolver) Search there is a field descriptor which can accept one of the class descriptor which match the given name and namespace.
void	setDebug(boolean debug) Sets the flag to turn on and off debugging
void	setDoctype(java.lang.String publicId, java.lang.String systemId) Sets the document type definition for the serializer.
void	setEncoding(java.lang.String encoding) Sets the encoding for the serializer.
void	setLogWriter(java.io.PrintWriter printWriter) Sets the PrintWriter used for logging
void	setMapping(Mapping mapping) Sets the given mapping to be used by the marshalling Framework.
void	setMarshalAsDocument(boolean asDocument) Sets whether or not to marshal as a document which includes the XML declaration, and if necessary the DOCTYPE declaration.
void	setMarshalExtendedType(boolean marshalExtendedType) If True the marshaller will use the 'xsi:type' attribute to marshall a field value that extended the defined field type.
void	setMarshalListener(MarshalListener listener) Sets an optional MarshalListener to recieve pre and post marshal notification for each Object in the tree.
void	setNamespaceMapping(java.lang.String nsPrefix, java.lang.String nsURI) Sets the mapping for the given Namespace prefix
void	setNoNamespaceSchemaLocation(java.lang.String schemaLocation) Sets the value for the xsi:noNamespaceSchemaLocation attribute.
void	setNSPrefixAtRoot(boolean nsPrefixAtRoot) Deprecated.
void	setResolver(ClassDescriptorResolver cdr) Sets the ClassDescriptorResolver to use during unmarshalling
void	setRootElement(java.lang.String rootElement) Sets the name of the root element to use
void	setSchemaLocation(java.lang.String schemaLocation) Sets the value for the xsi:schemaLocation attribute.
void	setSuppressXSIType(boolean suppressXSIType) Sets whether or not the xsi:type attribute should appear on the marshalled document.
void	setValidation(boolean validate) Sets whether or not to validate the object model before marshalling.

Methods inherited from class java.lang.Object

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

Field Detail

enableDebug

public static boolean enableDebug

A static flag used to enable debugging when using the static marshal methods.

XSI_NAMESPACE

public static final java.lang.String XSI_NAMESPACE

The XSI Namespace URI

See Also:

Constant Field Values

XSI_SCHEMA_LOCATION

public static final java.lang.String XSI_SCHEMA_LOCATION

The name of the Schema location attribute

See Also:

Constant Field Values

XSI_NO_NAMESPACE_SCHEMA_LOCATION

public static final java.lang.String XSI_NO_NAMESPACE_SCHEMA_LOCATION

The name of the no namespace schema location attribute

See Also:

Constant Field Values

XML_LANG_ATTR

public static final java.lang.String XML_LANG_ATTR

The xml:lang attribute name

See Also:

Constant Field Values

XML_SPACE_ATTR

public static final java.lang.String XML_SPACE_ATTR

The xml:space attribute name

See Also:

Constant Field Values

Constructor Detail

Marshaller

public Marshaller(org.xml.sax.DocumentHandler handler)

Creates a new Marshaller with the given DocumentHandler.

Parameters:

handler - the DocumentHandler to "marshal" to.

Marshaller

public Marshaller(org.xml.sax.ContentHandler handler)
           throws java.io.IOException

Creates a new Marshaller with the given SAX ContentHandler.

Parameters:

handler - the ContentHandler to "marshal" to.

Marshaller

public Marshaller(java.io.Writer out)
           throws java.io.IOException

Creates a new Marshaller with the given writer.

Parameters:

out - the Writer to serialize to

Marshaller

public Marshaller(org.w3c.dom.Node node)

Creates a new Marshaller for the given DOM Node.

Parameters:

node - the DOM node to marshal into.

Method Detail

addProcessingInstruction

public void addProcessingInstruction(java.lang.String target,
                                     java.lang.String data)

Adds the given processing instruction data to the set of processing instructions to output during marshalling.

Parameters:

target - the processing instruction target

data - the processing instruction data

setDoctype

public void setDoctype(java.lang.String publicId,
                       java.lang.String systemId)

Sets the document type definition for the serializer. Note that this method cannot be called if you've passed in your own DocumentHandler.

Parameters:

publicId - the public identifier

systemId - the system identifier

setMarshalAsDocument

public void setMarshalAsDocument(boolean asDocument)

Sets whether or not to marshal as a document which includes the XML declaration, and if necessary the DOCTYPE declaration. By default the Marshaller will marshal as a well formed XML fragment (no XML declaration or DOCTYPE).

Parameters:

asDocument - a boolean, when true, indicating to marshal as a complete XML document.

setMapping

public void setMapping(Mapping mapping)
                throws MappingException

Sets the given mapping to be used by the marshalling Framework. If a ClassDescriptorResolver exists This mapping will be added to the existing Resolver. Otherwise a new ClassDescriptorResolver will be created.

Parameters:

mapping - the mapping to using during marshalling

Throws:

MappingException

setMarshalListener

public void setMarshalListener(MarshalListener listener)

Sets an optional MarshalListener to recieve pre and post marshal notification for each Object in the tree. MarshalListener is only for complex objects that map into elements, simpleTypes and types that map into attributes do not cause any pre and post event notifications. Current only one (1) listener is allowed. If you need register multiple listeners, you will have to create your own master listener that will forward the event notifications and manage the multiple listeners.

Parameters:

listener - the MarshalListener to set.

setNamespaceMapping

public void setNamespaceMapping(java.lang.String nsPrefix,
                                java.lang.String nsURI)

Sets the mapping for the given Namespace prefix

Parameters:

nsPrefix - the namespace prefix

nsURI - the namespace that the prefix resolves to

setRootElement

public void setRootElement(java.lang.String rootElement)

Sets the name of the root element to use

getRootElement

public java.lang.String getRootElement()

Returns the name of the root element to use

Returns:

Returns the name of the root element to use

setNSPrefixAtRoot

public void setNSPrefixAtRoot(boolean nsPrefixAtRoot)

Deprecated.

Set to True to declare the given namespace mappings at the root node. Default is False.

Parameters:

nsPrefixAtRoot -

getNSPrefixAtRoot

public boolean getNSPrefixAtRoot()

Deprecated.

Returns True if the given namespace mappings will be declared at the root node.

Returns:

Returns True if the given namespace mappings will be declared at the root node.

setResolver

public void setResolver(ClassDescriptorResolver cdr)

Sets the ClassDescriptorResolver to use during unmarshalling

Parameters:

cdr - the ClassDescriptorResolver to use

See Also:


Note: This method will nullify any Mapping currently being used by this Marshaller

setValidation

public void setValidation(boolean validate)

Sets whether or not to validate the object model before marshalling. By default validation is enabled. This method is really for debugging. I do not recommend turning off validation, since you could marshal a document, which you can then not unmarshal. If you know the object model is guaranteed to be valid, disabling validation will improve performace.

Parameters:

validate - the boolean indicating whether or not to validate the object model before marshalling.

setMarshalExtendedType

public void setMarshalExtendedType(boolean marshalExtendedType)

If True the marshaller will use the 'xsi:type' attribute to marshall a field value that extended the defined field type. Default is True.

getMarshalExtendedType

public boolean getMarshalExtendedType()

If True the marshaller will use the 'xsi:type' attribute to marshall a field value that extended the defined field type. Default is True.

Returns:

If True the marshaller will use the 'xsi:type' attribute to marshall a field value that extended the defined field type. Default is True.

marshal

public static void marshal(java.lang.Object object,
                           java.io.Writer out)
                    throws MarshalException,
                           ValidationException

Marshals the given Object as XML using the given writer

Parameters:

out - the writer to marshal to

Throws:

MarshalException

ValidationException

marshal

public static void marshal(java.lang.Object object,
                           org.xml.sax.DocumentHandler handler)
                    throws MarshalException,
                           ValidationException

Marshals the given Object as XML using the given DocumentHandler to send events to.

Parameters:

handler - the DocumentHandler to marshal to

Throws:

MarshalException

ValidationException

marshal

public static void marshal(java.lang.Object object,
                           org.xml.sax.ContentHandler handler)
                    throws MarshalException,
                           ValidationException,
                           java.io.IOException

Marshals the given Object as XML using the given ContentHandler to send events to.

Parameters:

handler - the ContentHandler to marshal to

Throws:

MarshalException

ValidationException

java.io.IOException

marshal

public static void marshal(java.lang.Object object,
                           org.w3c.dom.Node node)
                    throws MarshalException,
                           ValidationException

Marshals the given Object as XML using the given DOM Node to send events to.

Parameters:

node - the DOM Node to marshal to

Throws:

MarshalException

ValidationException

marshal

public void marshal(java.lang.Object object)
             throws MarshalException,
                    ValidationException

Marshals the given Object as XML using the DocumentHandler for this Marshaller.

Throws:

MarshalException

ValidationException

setDebug

public void setDebug(boolean debug)

Sets the flag to turn on and off debugging

Parameters:

debug - the flag indicating whether or not debug information should be generated

setLogWriter

public void setLogWriter(java.io.PrintWriter printWriter)

Sets the PrintWriter used for logging

Parameters:

printWriter - the PrintWriter to use for logging

setEncoding

public void setEncoding(java.lang.String encoding)

Sets the encoding for the serializer. Note that this method cannot be called if you've passed in your own DocumentHandler.

Parameters:

encoding - the encoding to set

setNoNamespaceSchemaLocation

public void setNoNamespaceSchemaLocation(java.lang.String schemaLocation)

Sets the value for the xsi:noNamespaceSchemaLocation attribute. When set, this attribute will appear on the root element of the marshalled document.

Parameters:

schemaLocation - the URI location of the schema to which the marshalled document is an instance of.

setSchemaLocation

public void setSchemaLocation(java.lang.String schemaLocation)

Sets the value for the xsi:schemaLocation attribute. When set, this attribute will appear on the root element of the marshalled document.

Parameters:

schemaLocation - the URI location of the schema to which the marshalled document is an instance of.

setSuppressXSIType

public void setSuppressXSIType(boolean suppressXSIType)

Sets whether or not the xsi:type attribute should appear on the marshalled document.

Parameters:

suppressXSIType - a boolean that when true will prevent xsi:type attribute from being used in the marshalling process.

isCollection

public static boolean isCollection(java.lang.Class clazz)

Returns true if the given Class is a considered a collection by the marshalling framework.

Returns:

true if the given Class is considered a collection.

getCollectionHandler

public CollectionHandler getCollectionHandler(java.lang.Class clazz)

Returns the CollectionHandler associated with the given collection, or null if no such handler exists.

Returns:

the CollectionHandler for the associated type.

namespaceEquals

public static boolean namespaceEquals(java.lang.String ns1,
                                      java.lang.String ns2)

Compares the given namespaces (as strings) for equality. null and empty values are considered equal.

Parameters:

ns1 - the namespace to compare to argument ns2

ns2 - the namespace to compare to argument ns1

searchInheritance

public static MarshalFramework.InheritanceMatch[] searchInheritance(java.lang.String name,
                                                                    java.lang.String namespace,
                                                                    XMLClassDescriptor classDesc,
                                                                    ClassDescriptorResolver cdResolver)

Search there is a field descriptor which can accept one of the class descriptor which match the given name and namespace.