|
Spring Web Services Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.springframework.oxm.AbstractMarshaller
org.springframework.oxm.castor.CastorMarshaller
public class CastorMarshaller
Implementation of the Marshaller
interface for Castor. By default, Castor does not require any further
configuration, though setting a target class or providing a mapping file can be used to have more control over the
behavior of Castor.
setTargetClass
, the CastorMarshaller
can only be used
to unmarshall XML that represents that specific class. If you want to unmarshall multiple classes, you have to
provide a mapping file using setMappingLocations
.
Due to Castor's API, it is required to set the encoding used for writing to output streams. It defaults to
UTF-8
.
setEncoding(String)
,
setTargetClass(Class)
,
setMappingLocation(org.springframework.core.io.Resource)
,
setMappingLocations(org.springframework.core.io.Resource[])
Field Summary | |
---|---|
static String |
DEFAULT_ENCODING
The default encoding used for stream access. |
Fields inherited from class org.springframework.oxm.AbstractMarshaller |
---|
logger |
Constructor Summary | |
---|---|
CastorMarshaller()
|
Method Summary | |
---|---|
void |
afterPropertiesSet()
|
XmlMappingException |
convertCastorException(org.exolab.castor.xml.XMLException ex,
boolean marshalling)
Converts the given CastorException to an appropriate exception from the
org.springframework.oxm hierarchy. |
protected org.exolab.castor.xml.XMLContext |
createXMLContext(Resource[] mappingLocations,
Class targetClass)
Creates the Castor XMLContext . |
protected void |
customizeMarshaller(org.exolab.castor.xml.Marshaller marshaller)
Template method that allows for customizing of the given Castor Marshaller . |
protected void |
customizeUnmarshaller(org.exolab.castor.xml.Unmarshaller unmarshaller)
Template method that allows for customizing of the given Castor Unmarshaller . |
boolean |
getIgnoreExtraAttributes()
Returns whether the Castor Unmarshaller should ignore attributes that do not match a specific field. |
boolean |
getIgnoreExtraElements()
Returns whether the Castor Unmarshaller should ignore elements that do not match a specific field. |
Properties |
getNamespaceMappings()
Returns the namespace mappings. |
boolean |
getWhitespacePreserve()
Returns whether the Castor Unmarshaller should preserve "ignorable" whitespace. |
boolean |
isSuppressNamespaces()
Returns whether this marshaller should output namespaces. |
boolean |
isSuppressXsiType()
Sets whether this marshaller should output the xsi:type attribute. |
boolean |
isValidating()
Returns whether this marshaller should validate in- and outgoing documents. |
protected void |
marshalDomNode(Object graph,
Node node)
Abstract template method for marshalling the given object graph to a DOM Node . |
protected void |
marshalOutputStream(Object graph,
OutputStream outputStream)
Abstract template method for marshalling the given object graph to a OutputStream . |
protected void |
marshalSaxHandlers(Object graph,
ContentHandler contentHandler,
LexicalHandler lexicalHandler)
Abstract template method for marshalling the given object graph to a SAX ContentHandler . |
protected void |
marshalWriter(Object graph,
Writer writer)
Abstract template method for marshalling the given object graph to a Writer . |
protected void |
marshalXmlEventWriter(Object graph,
XMLEventWriter eventWriter)
Abstract template method for marshalling the given object to a StAX XMLEventWriter . |
protected void |
marshalXmlStreamWriter(Object graph,
XMLStreamWriter streamWriter)
Abstract template method for marshalling the given object to a StAX XMLStreamWriter . |
void |
setEncoding(String encoding)
Sets the encoding to be used for stream access. |
void |
setIgnoreExtraAttributes(boolean ignoreExtraAttributes)
Sets whether the Castor Unmarshaller should ignore attributes that do not match a specific field. |
void |
setIgnoreExtraElements(boolean ignoreExtraElements)
Sets whether the Castor Unmarshaller should ignore elements that do not match a specific field. |
void |
setMappingLocation(Resource mappingLocation)
Sets the locations of the Castor XML Mapping files. |
void |
setMappingLocations(Resource[] mappingLocations)
Sets the locations of the Castor XML Mapping files. |
void |
setNamespaceMappings(Properties namespaceMappings)
Sets the namespace mappings. |
void |
setSuppressNamespaces(boolean suppressNamespaces)
Sets whether this marshaller should output namespaces. |
void |
setSuppressXsiType(boolean suppressXsiType)
Sets whether this marshaller should output the xsi:type attribute. |
void |
setTargetClass(Class targetClass)
Sets the Castor target class. |
void |
setValidating(boolean validating)
Sets whether this marshaller should validate in- and outgoing documents. |
void |
setWhitespacePreserve(boolean whitespacePreserve)
Sets whether the Castor Unmarshaller should preserve "ignorable" whitespace. |
boolean |
supports(Class clazz)
Returns true for all classes, i.e. |
protected Object |
unmarshalDomNode(Node node)
Abstract template method for unmarshalling from a given DOM Node . |
protected Object |
unmarshalInputStream(InputStream inputStream)
Abstract template method for unmarshalling from a given InputStream . |
protected Object |
unmarshalReader(Reader reader)
Abstract template method for unmarshalling from a given Reader . |
protected Object |
unmarshalSaxReader(XMLReader xmlReader,
InputSource inputSource)
Abstract template method for unmarshalling using a given SAX XMLReader and
InputSource . |
protected Object |
unmarshalXmlEventReader(XMLEventReader eventReader)
Abstract template method for unmarshalling from a given Stax XMLEventReader . |
protected Object |
unmarshalXmlStreamReader(XMLStreamReader streamReader)
Abstract template method for unmarshalling from a given Stax XMLStreamReader . |
Methods inherited from class org.springframework.oxm.AbstractMarshaller |
---|
createDocumentBuilder, createDocumentBuilderFactory, createXmlReader, marshal, marshalDomResult, marshalSaxResult, marshalStaxResult, marshalStreamResult, unmarshal, unmarshalDomSource, unmarshalSaxSource, unmarshalStaxSource, unmarshalStreamSource |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DEFAULT_ENCODING
Constructor Detail |
---|
public CastorMarshaller()
Method Detail |
---|
public boolean getIgnoreExtraAttributes()
Unmarshaller
should ignore attributes that do not match a specific field.
public void setIgnoreExtraAttributes(boolean ignoreExtraAttributes)
Unmarshaller
should ignore attributes that do not match a specific field.
Default is true
: extra attributes are ignored.
Unmarshaller.setIgnoreExtraAttributes(boolean)
public boolean getIgnoreExtraElements()
Unmarshaller
should ignore elements that do not match a specific field.
public void setIgnoreExtraElements(boolean ignoreExtraElements)
Unmarshaller
should ignore elements that do not match a specific field. Default
is false
, extra attributes are flagged as an error.
Unmarshaller.setIgnoreExtraElements(boolean)
public boolean getWhitespacePreserve()
Unmarshaller
should preserve "ignorable" whitespace.
public void setWhitespacePreserve(boolean whitespacePreserve)
Unmarshaller
should preserve "ignorable" whitespace. Default is
false
.
Unmarshaller.setWhitespacePreserve(boolean)
public boolean isValidating()
public void setValidating(boolean validating)
false
.
Marshaller.setValidation(boolean)
public Properties getNamespaceMappings()
public void setNamespaceMappings(Properties namespaceMappings)
Marshaller.setNamespaceMapping(String, String)
public void setEncoding(String encoding)
DEFAULT_ENCODING
public void setMappingLocation(Resource mappingLocation)
public void setMappingLocations(Resource[] mappingLocations)
public boolean isSuppressNamespaces()
public void setSuppressNamespaces(boolean suppressNamespaces)
false
, i.e. namespaces are
written.
Marshaller.setSuppressNamespaces(boolean)
public boolean isSuppressXsiType()
public void setSuppressXsiType(boolean suppressXsiType)
xsi:type
attribute. The default is false
, i.e. the
xsi:type
is written.
Marshaller.setSuppressXSIType(boolean)
public void setTargetClass(Class targetClass)
CastorMarshaller
is tied to this one
specific class. Use a mapping file for unmarshalling multiple classes.
public final void afterPropertiesSet() throws IOException
afterPropertiesSet
in interface InitializingBean
IOException
public boolean supports(Class clazz)
true
for all classes, i.e. Castor supports arbitrary classes.
supports
in interface Marshaller
supports
in interface Unmarshaller
clazz
- the class that this marshaller is being asked if it can marshal
true
if this marshaller can indeed marshal instances of the supplied class;
false
otherwiseprotected org.exolab.castor.xml.XMLContext createXMLContext(Resource[] mappingLocations, Class targetClass) throws org.exolab.castor.mapping.MappingException, IOException, org.exolab.castor.xml.ResolverException
XMLContext
. Subclasses can override this to create a custom context.
The default implementation loads mapping files if defined, and the target class if not defined.
org.exolab.castor.mapping.MappingException
- when the mapping file cannot be loaded
IOException
- in case of I/O errors
org.exolab.castor.xml.ResolverException
XMLContext.addMapping(org.exolab.castor.mapping.Mapping)
,
XMLContext.addClass(Class)
protected final void marshalDomNode(Object graph, Node node) throws XmlMappingException
AbstractMarshaller
Node
.
In practice, node is be a Document
node, a DocumentFragment
node, or a
Element
node. In other words, a node that accepts children.
marshalDomNode
in class AbstractMarshaller
graph
- the root of the object graph to marshalnode
- The DOM node that will contain the result tree
XmlMappingException
- if the given object cannot be marshalled to the DOM nodeDocument
,
DocumentFragment
,
Element
protected final void marshalSaxHandlers(Object graph, ContentHandler contentHandler, LexicalHandler lexicalHandler) throws XmlMappingException
AbstractMarshaller
ContentHandler
.
marshalSaxHandlers
in class AbstractMarshaller
graph
- the root of the object graph to marshalcontentHandler
- the SAX ContentHandler
lexicalHandler
- the SAX2 LexicalHandler
. Can be null
.
XmlMappingException
- if the given object cannot be marshalled to the handlersprotected final void marshalOutputStream(Object graph, OutputStream outputStream) throws XmlMappingException, IOException
AbstractMarshaller
OutputStream
.
marshalOutputStream
in class AbstractMarshaller
graph
- the root of the object graph to marshaloutputStream
- the OutputStream
to write to
XmlMappingException
- if the given object cannot be marshalled to the writer
IOException
- if an I/O exception occursprotected final void marshalWriter(Object graph, Writer writer) throws XmlMappingException, IOException
AbstractMarshaller
Writer
.
marshalWriter
in class AbstractMarshaller
graph
- the root of the object graph to marshalwriter
- the Writer
to write to
XmlMappingException
- if the given object cannot be marshalled to the writer
IOException
- if an I/O exception occursprotected final void marshalXmlEventWriter(Object graph, XMLEventWriter eventWriter) throws XmlMappingException
AbstractMarshaller
XMLEventWriter
.
marshalXmlEventWriter
in class AbstractMarshaller
graph
- the root of the object graph to marshaleventWriter
- the XMLEventWriter
to write to
XmlMappingException
- if the given object cannot be marshalled to the DOM nodeprotected final void marshalXmlStreamWriter(Object graph, XMLStreamWriter streamWriter) throws XmlMappingException
AbstractMarshaller
XMLStreamWriter
.
marshalXmlStreamWriter
in class AbstractMarshaller
graph
- the root of the object graph to marshalstreamWriter
- the XMLStreamWriter
to write to
XmlMappingException
- if the given object cannot be marshalled to the DOM nodeprotected void customizeMarshaller(org.exolab.castor.xml.Marshaller marshaller)
Marshaller
.
Default implementation invokes Marshaller.setValidation(boolean)
with the property set on this
marshaller, and calls Marshaller.setNamespaceMapping(String, String)
with the namespace mappings.
protected final Object unmarshalDomNode(Node node) throws XmlMappingException
AbstractMarshaller
Node
.
unmarshalDomNode
in class AbstractMarshaller
node
- The DOM node that contains the objects to be unmarshalled
XmlMappingException
- if the given DOM node cannot be mapped to an objectprotected final Object unmarshalInputStream(InputStream inputStream) throws XmlMappingException, IOException
AbstractMarshaller
InputStream
.
unmarshalInputStream
in class AbstractMarshaller
inputStream
- the InputStreamStream
to read from
XmlMappingException
- if the given stream cannot be converted to an object
IOException
- if an I/O exception occursprotected final Object unmarshalReader(Reader reader) throws XmlMappingException, IOException
AbstractMarshaller
Reader
.
unmarshalReader
in class AbstractMarshaller
reader
- the Reader
to read from
XmlMappingException
- if the given reader cannot be converted to an object
IOException
- if an I/O exception occursprotected final Object unmarshalXmlEventReader(XMLEventReader eventReader)
AbstractMarshaller
XMLEventReader
.
unmarshalXmlEventReader
in class AbstractMarshaller
eventReader
- The XMLEventReader
to read from
protected final Object unmarshalSaxReader(XMLReader xmlReader, InputSource inputSource) throws XmlMappingException, IOException
AbstractMarshaller
XMLReader
and
InputSource
.
unmarshalSaxReader
in class AbstractMarshaller
xmlReader
- the SAX XMLReader
to parse withinputSource
- the input source to parse from
XmlMappingException
- if the given reader and input source cannot be converted to an object
IOException
- if an I/O exception occursprotected final Object unmarshalXmlStreamReader(XMLStreamReader streamReader)
AbstractMarshaller
XMLStreamReader
.
unmarshalXmlStreamReader
in class AbstractMarshaller
streamReader
- The XMLStreamReader
to read from
protected void customizeUnmarshaller(org.exolab.castor.xml.Unmarshaller unmarshaller)
Unmarshaller
.
Default implementation invokes Unmarshaller.setValidation(boolean)
, Unmarshaller.setWhitespacePreserve(boolean)
, Unmarshaller.setIgnoreExtraAttributes(boolean)
, and Unmarshaller.setIgnoreExtraElements(boolean)
with the properties set on this marshaller.
public XmlMappingException convertCastorException(org.exolab.castor.xml.XMLException ex, boolean marshalling)
CastorException
to an appropriate exception from the
org.springframework.oxm
hierarchy.
The default implementation delegates to CastorUtils
. Can be overridden in subclasses.
A boolean flag is used to indicate whether this exception occurs during marshalling or unmarshalling, since
Castor itself does not make this distinction in its exception hierarchy.
ex
- Castor XMLException
that occuredmarshalling
- indicates whether the exception occurs during marshalling (true
), or
unmarshalling (false
)
XmlMappingException
CastorUtils.convertXmlException(org.exolab.castor.xml.XMLException, boolean)
|
Spring Web Services Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |