org.mule.module.xml.transformer

Class AbstractXmlTransformer

java.lang.Object

org.mule.AbstractAnnotatedObject

org.mule.transformer.AbstractTransformer

org.mule.transformer.AbstractMessageTransformer

org.mule.module.xml.transformer.AbstractXmlTransformer

All Implemented Interfaces:

AnnotatedObject, MuleContextAware, Disposable, Initialisable, NameableObject, NamedObject, MessageProcessor, MessageTransformer, Transformer, EndpointAware

Direct Known Subclasses:

DomDocumentToXml, XmlToDomDocument, XmlToOutputHandler, XmlToXMLStreamReader, XQueryTransformer, XsltTransformer

public abstract class AbstractXmlTransformer
extends AbstractMessageTransformer
implements Initialisable

AbstractXmlTransformer offers some XSLT transform on a DOM (or other XML-ish) object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractXmlTransformer.ResultHolder Result callback interface used when processing XML through JAXP

Field Summary

Fields inherited from class org.mule.transformer.AbstractTransformer

encoding, endpoint, logger, mimeType, MULE_MESSAGE_DATA_TYPE, muleContext, name, returnType, sourceTypes

Fields inherited from interface org.mule.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.api.lifecycle.Disposable

PHASE_NAME

Fields inherited from interface org.mule.api.AnnotatedObject

PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractXmlTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	convertToBytes(Object obj, String outputEncoding) Converts an XML in-memory representation to a String using a specific encoding.
protected String	convertToText(Object obj) Deprecated. Replaced by convertToText(Object obj, String ouputEncoding)
protected String	convertToText(Object obj, String outputEncoding) Converts an XML in-memory representation to a String using a specific encoding.
protected void	doInitialise()
boolean	getAcceptExternalEntities()
String	getOutputEncoding()
protected static AbstractXmlTransformer.ResultHolder	getResultHolder(Class<?> desiredClass)
XMLInputFactory	getXMLInputFactory()
XMLOutputFactory	getXMLOutputFactory()
void	initialise() Template method where deriving classes can do any initialisation after the properties have been set on this transformer
boolean	isUseStaxSource()
void	setAcceptExternalEntities(boolean acceptExternalEntities)
void	setOutputEncoding(String outputEncoding)
void	setUseStaxSource(boolean useStaxSource)
void	setXMLInputFactory(XMLInputFactory xmlInputFactory)
void	setXMLOutputFactory(XMLOutputFactory xmlOutputFactory)
protected void	writeToStream(Object obj, String outputEncoding, OutputStream output)

Methods inherited from class org.mule.transformer.AbstractMessageTransformer

checkReturnClass, doTransform, isSourceDataTypeSupported, transform, transform, transform, transformMessage

Methods inherited from class org.mule.transformer.AbstractTransformer

dispose, generateTransformerName, getEncoding, getEncoding, getEndpoint, getMimeType, getName, getReturnClass, getReturnDataType, getSourceDataTypes, getSourceTypes, isAcceptNull, isAllowNullReturn, isConsumed, isIgnoreBadInput, isSourceDataTypeSupported, isSourceTypeSupported, isSourceTypeSupported, process, registerSourceType, registerSourceType, setAllowNullReturn, setEncoding, setEndpoint, setIgnoreBadInput, setMimeType, setMuleContext, setName, setReturnClass, setReturnDataType, toString, transform, unregisterSourceType, unregisterSourceType

Methods inherited from class org.mule.AbstractAnnotatedObject

getAnnotation, getAnnotations, setAnnotations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.transformer.Transformer

getEncoding, getEndpoint, getMimeType, getReturnClass, getReturnDataType, getSourceDataTypes, getSourceTypes, isAcceptNull, isIgnoreBadInput, isSourceDataTypeSupported, isSourceTypeSupported, setReturnClass, setReturnDataType, transform

Methods inherited from interface org.mule.api.processor.MessageProcessor

process

Methods inherited from interface org.mule.api.lifecycle.Disposable

dispose

Methods inherited from interface org.mule.api.NameableObject

setName

Methods inherited from interface org.mule.api.NamedObject

getName

Methods inherited from interface org.mule.api.context.MuleContextAware

setMuleContext

Methods inherited from interface org.mule.endpoint.EndpointAware

setEndpoint

Constructor Detail

AbstractXmlTransformer

public AbstractXmlTransformer()

Method Detail

initialise

public final void initialise()
                      throws InitialisationException

Description copied from class: AbstractTransformer

Template method where deriving classes can do any initialisation after the properties have been set on this transformer

Specified by:

initialise in interface Initialisable

Overrides:

initialise in class AbstractTransformer

Throws:

InitialisationException - if a fatal error occurs causing the Mule instance to shutdown

RecoverableException - if an error occurs that can be recovered from

doInitialise

protected void doInitialise()
                     throws InitialisationException

Throws:

InitialisationException

getResultHolder

protected static AbstractXmlTransformer.ResultHolder getResultHolder(Class<?> desiredClass)

Parameters:

desiredClass - Java class representing the desired format

Returns:

Callback interface representing the desiredClass - or null if the return class isn't supported (or is null).

convertToText

@Deprecated
protected String convertToText(Object obj)
                        throws Exception

Deprecated. Replaced by convertToText(Object obj, String ouputEncoding)

Converts an XML in-memory representation to a String

Parameters:

obj - Object to convert (could be byte[], String, DOM, DOM4J)

Returns:

String including XML header using default (UTF-8) encoding

Throws:

TransformerFactoryConfigurationError - On error

TransformerException - On error

TransformerException

Exception

convertToText

protected String convertToText(Object obj,
                   String outputEncoding)
                        throws Exception

Converts an XML in-memory representation to a String using a specific encoding. If using an encoding which cannot represent specific characters, these are written as entities, even if they can be represented as a Java String.

Parameters:

obj - Object to convert (could be byte[], String, DOM, or DOM4J Document). If the object is a byte[], the character encoding used MUST match the declared encoding standard, or a parse error will occur.

outputEncoding - Name of the XML encoding to use, e.g. US-ASCII, or null for UTF-8

Returns:

String including XML header using the specified encoding

Throws:

TransformerFactoryConfigurationError - On error

TransformerException - On error

TransformerException

Exception

convertToBytes

protected String convertToBytes(Object obj,
                    String outputEncoding)
                         throws Exception

Converts an XML in-memory representation to a String using a specific encoding.

Parameters:

obj - Object to convert (could be byte[], String, DOM, or DOM4J Document). If the object is a byte[], the character encoding used MUST match the declared encoding standard, or a parse error will occur.

outputEncoding - Name of the XML encoding to use, e.g. US-ASCII, or null for UTF-8

Returns:

String including XML header using the specified encoding

Throws:

TransformerFactoryConfigurationError - On error

TransformerException - On error

TransformerException

Exception

writeToStream

protected void writeToStream(Object obj,
                 String outputEncoding,
                 OutputStream output)
                      throws Exception

Throws:

Exception

getOutputEncoding

public String getOutputEncoding()

Returns:

the outputEncoding

setOutputEncoding

public void setOutputEncoding(String outputEncoding)

Parameters:

outputEncoding - the outputEncoding to set

isUseStaxSource

public boolean isUseStaxSource()

setUseStaxSource

public void setUseStaxSource(boolean useStaxSource)

getXMLInputFactory

public XMLInputFactory getXMLInputFactory()

setXMLInputFactory

public void setXMLInputFactory(XMLInputFactory xmlInputFactory)

getXMLOutputFactory

public XMLOutputFactory getXMLOutputFactory()

setXMLOutputFactory

public void setXMLOutputFactory(XMLOutputFactory xmlOutputFactory)

setAcceptExternalEntities

public void setAcceptExternalEntities(boolean acceptExternalEntities)

getAcceptExternalEntities

public boolean getAcceptExternalEntities()