org.apache.servicemix.jbi.jaxp

Class SourceTransformer

java.lang.Object

org.apache.servicemix.jbi.jaxp.SourceTransformer

public class SourceTransformer
extends java.lang.Object

A helper class to transform from one type of Source to another

Version:

$Revision: 670459 $

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CHARSET_PROPERTY
static java.lang.String	DEFAULT_VALIDATING_DTD_PROPERTY

Constructor Summary

Constructors

Constructor and Description
SourceTransformer()
SourceTransformer(javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	contentToString(javax.jbi.messaging.NormalizedMessage message) Converts the content of the given message to a String
org.w3c.dom.Document	createDocument()
javax.xml.parsers.DocumentBuilder	createDocumentBuilder()
javax.xml.parsers.DocumentBuilderFactory	createDocumentBuilderFactory()
protected javax.xml.stream.XMLInputFactory	createInputFactory()
protected javax.xml.stream.XMLOutputFactory	createOutputFactory()
javax.xml.transform.Transformer	createTransfomer()
javax.xml.transform.TransformerFactory	createTransformerFactory()
static java.lang.String	getDefaultCharset()
static boolean	getDefaultValidatingDtd()
javax.xml.parsers.DocumentBuilderFactory	getDocumentBuilderFactory()
javax.xml.stream.XMLInputFactory	getInputFactory()
javax.xml.stream.XMLOutputFactory	getOutputFactory()
javax.xml.transform.TransformerFactory	getTransformerFactory()
static void	setDefaultCharset(java.lang.String defaultCharset)
static void	setDefaultValidatingDtd(boolean defaultValidatingDtd)
void	setDocumentBuilderFactory(javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory)
void	setInputFactory(javax.xml.stream.XMLInputFactory inputFactory)
void	setOutputFactory(javax.xml.stream.XMLOutputFactory outputFactory)
void	setTransformerFactory(javax.xml.transform.TransformerFactory transformerFactory)
org.w3c.dom.Document	toDOMDocument(org.w3c.dom.Node node) Create a DOM document from the given Node.
org.w3c.dom.Document	toDOMDocument(javax.jbi.messaging.NormalizedMessage message) Create a DOM document from the given normalized message
org.w3c.dom.Document	toDOMDocument(javax.xml.transform.Source source) Create a DOM document from the given source.
org.w3c.dom.Element	toDOMElement(org.w3c.dom.Node node) Create a DOM element from the DOM node.
org.w3c.dom.Element	toDOMElement(javax.jbi.messaging.NormalizedMessage message) Create a DOM element from the normalized message.
org.w3c.dom.Element	toDOMElement(javax.xml.transform.Source source) Create a DOM element from the given source.
org.w3c.dom.Node	toDOMNode(javax.jbi.messaging.NormalizedMessage message) Avoids multple parsing to DOM by caching the DOM representation in the message as a property so future calls will avoid the reparse - and avoid issues with stream based Source instances.
org.w3c.dom.Node	toDOMNode(javax.xml.transform.Source source) Converts the given TRaX Source into a W3C DOM node
org.w3c.dom.Node	toDOMNodeFromSAX(javax.xml.transform.sax.SAXSource source)
javax.xml.transform.Source	toDOMSource(javax.jbi.messaging.NormalizedMessage message)
javax.xml.transform.dom.DOMSource	toDOMSource(javax.xml.transform.Source source) Converts the source instance to a DOMSource or returns null if the conversion is not supported (making it easy to derive from this class to add new kinds of conversion).
javax.xml.transform.Source	toDOMSource(StaxSource source)
javax.xml.transform.dom.DOMSource	toDOMSourceFromSAX(javax.xml.transform.sax.SAXSource source)
javax.xml.transform.dom.DOMSource	toDOMSourceFromStax(StaxSource source)
javax.xml.transform.dom.DOMSource	toDOMSourceFromStream(javax.xml.transform.stream.StreamSource source)
java.io.Reader	toReaderFromSource(javax.xml.transform.Source src)
void	toResult(javax.xml.transform.Source source, javax.xml.transform.Result result) Converts the given input Source into the required result, using the default charset
void	toResult(javax.xml.transform.Source source, javax.xml.transform.Result result, java.lang.String charset) Converts the given input Source into the required result, using the specified encoding
javax.xml.transform.sax.SAXSource	toSAXSource(javax.xml.transform.Source source) Converts the source instance to a SAXSource or returns null if the conversion is not supported (making it easy to derive from this class to add new kinds of conversion).
javax.xml.transform.sax.SAXSource	toSAXSourceFromDOM(javax.xml.transform.dom.DOMSource source)
javax.xml.transform.sax.SAXSource	toSAXSourceFromStax(StaxSource source)
javax.xml.transform.sax.SAXSource	toSAXSourceFromStream(javax.xml.transform.stream.StreamSource source)
StaxSource	toStaxSource(javax.xml.transform.Source source) Converts the source instance to a StaxSource or returns null if the conversion is not supported (making it easy to derive from this class to add new kinds of conversion).
javax.xml.transform.stream.StreamSource	toStreamSource(javax.xml.transform.Source source)
javax.xml.transform.stream.StreamSource	toStreamSourceFromDOM(javax.xml.transform.dom.DOMSource source)
javax.xml.transform.stream.StreamSource	toStreamSourceFromSAX(javax.xml.transform.sax.SAXSource source)
java.lang.String	toString(org.w3c.dom.Node node) Converts the given input Node into text
java.lang.String	toString(javax.xml.transform.Source source) Converts the given input Source into text
javax.xml.stream.XMLStreamReader	toXMLStreamReader(javax.xml.transform.Source source)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET_PROPERTY

public static final java.lang.String DEFAULT_CHARSET_PROPERTY

See Also:

Constant Field Values

DEFAULT_VALIDATING_DTD_PROPERTY

public static final java.lang.String DEFAULT_VALIDATING_DTD_PROPERTY

See Also:

Constant Field Values

Constructor Detail

SourceTransformer

public SourceTransformer()

SourceTransformer

public SourceTransformer(javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory)

Method Detail

getDefaultCharset

public static java.lang.String getDefaultCharset()

setDefaultCharset

public static void setDefaultCharset(java.lang.String defaultCharset)

getDefaultValidatingDtd

public static boolean getDefaultValidatingDtd()

setDefaultValidatingDtd

public static void setDefaultValidatingDtd(boolean defaultValidatingDtd)

toResult

public void toResult(javax.xml.transform.Source source,
            javax.xml.transform.Result result)
              throws javax.xml.transform.TransformerException

Converts the given input Source into the required result, using the default charset

Throws:

javax.xml.transform.TransformerException

toResult

public void toResult(javax.xml.transform.Source source,
            javax.xml.transform.Result result,
            java.lang.String charset)
              throws javax.xml.transform.TransformerConfigurationException,
                     javax.xml.transform.TransformerException

Converts the given input Source into the required result, using the specified encoding

Parameters:

source - the input Source

result - the output Result

charset - the required charset, if you specify null the default charset will be used

Throws:

javax.xml.transform.TransformerConfigurationException

javax.xml.transform.TransformerException

toString

public java.lang.String toString(javax.xml.transform.Source source)
                          throws javax.xml.transform.TransformerException

Converts the given input Source into text

Throws:

javax.xml.transform.TransformerException

toString

public java.lang.String toString(org.w3c.dom.Node node)
                          throws javax.xml.transform.TransformerException

Converts the given input Node into text

Throws:

javax.xml.transform.TransformerException

contentToString

public java.lang.String contentToString(javax.jbi.messaging.NormalizedMessage message)
                                 throws javax.jbi.messaging.MessagingException,
                                        javax.xml.transform.TransformerException,
                                        javax.xml.parsers.ParserConfigurationException,
                                        java.io.IOException,
                                        org.xml.sax.SAXException

Converts the content of the given message to a String

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

javax.jbi.messaging.MessagingException

javax.xml.transform.TransformerException

toDOMSource

public javax.xml.transform.dom.DOMSource toDOMSource(javax.xml.transform.Source source)
                                              throws javax.xml.parsers.ParserConfigurationException,
                                                     java.io.IOException,
                                                     org.xml.sax.SAXException,
                                                     javax.xml.transform.TransformerException

Converts the source instance to a DOMSource or returns null if the conversion is not supported (making it easy to derive from this class to add new kinds of conversion).

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

javax.xml.transform.TransformerException

toDOMSource

public javax.xml.transform.Source toDOMSource(javax.jbi.messaging.NormalizedMessage message)
                                       throws javax.jbi.messaging.MessagingException,
                                              javax.xml.transform.TransformerException,
                                              javax.xml.parsers.ParserConfigurationException,
                                              java.io.IOException,
                                              org.xml.sax.SAXException

Throws:

javax.jbi.messaging.MessagingException

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

toDOMSource

public javax.xml.transform.Source toDOMSource(StaxSource source)
                                       throws javax.xml.parsers.ParserConfigurationException,
                                              java.io.IOException,
                                              org.xml.sax.SAXException,
                                              javax.xml.transform.TransformerException

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

javax.xml.transform.TransformerException

toSAXSource

public javax.xml.transform.sax.SAXSource toSAXSource(javax.xml.transform.Source source)
                                              throws java.io.IOException,
                                                     org.xml.sax.SAXException,
                                                     javax.xml.transform.TransformerException

Converts the source instance to a SAXSource or returns null if the conversion is not supported (making it easy to derive from this class to add new kinds of conversion).

Throws:

java.io.IOException

org.xml.sax.SAXException

javax.xml.transform.TransformerException

toStreamSource

public javax.xml.transform.stream.StreamSource toStreamSource(javax.xml.transform.Source source)
                                                       throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

toStreamSourceFromSAX

public javax.xml.transform.stream.StreamSource toStreamSourceFromSAX(javax.xml.transform.sax.SAXSource source)
                                                              throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

toStreamSourceFromDOM

public javax.xml.transform.stream.StreamSource toStreamSourceFromDOM(javax.xml.transform.dom.DOMSource source)
                                                              throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

toSAXSourceFromStream

public javax.xml.transform.sax.SAXSource toSAXSourceFromStream(javax.xml.transform.stream.StreamSource source)

toSAXSourceFromStax

public javax.xml.transform.sax.SAXSource toSAXSourceFromStax(StaxSource source)

toReaderFromSource

public java.io.Reader toReaderFromSource(javax.xml.transform.Source src)
                                  throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

toDOMSourceFromStream

public javax.xml.transform.dom.DOMSource toDOMSourceFromStream(javax.xml.transform.stream.StreamSource source)
                                                        throws javax.xml.parsers.ParserConfigurationException,
                                                               java.io.IOException,
                                                               org.xml.sax.SAXException

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

toDOMSourceFromStax

public javax.xml.transform.dom.DOMSource toDOMSourceFromStax(StaxSource source)
                                                      throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

toSAXSourceFromDOM

public javax.xml.transform.sax.SAXSource toSAXSourceFromDOM(javax.xml.transform.dom.DOMSource source)
                                                     throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

toDOMSourceFromSAX

public javax.xml.transform.dom.DOMSource toDOMSourceFromSAX(javax.xml.transform.sax.SAXSource source)
                                                     throws java.io.IOException,
                                                            org.xml.sax.SAXException,
                                                            javax.xml.parsers.ParserConfigurationException,
                                                            javax.xml.transform.TransformerException

Throws:

java.io.IOException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

javax.xml.transform.TransformerException

toDOMNodeFromSAX

public org.w3c.dom.Node toDOMNodeFromSAX(javax.xml.transform.sax.SAXSource source)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException,
                                         javax.xml.transform.TransformerException

Throws:

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

javax.xml.transform.TransformerException

toDOMNode

public org.w3c.dom.Node toDOMNode(javax.xml.transform.Source source)
                           throws javax.xml.transform.TransformerException,
                                  javax.xml.parsers.ParserConfigurationException,
                                  java.io.IOException,
                                  org.xml.sax.SAXException

Converts the given TRaX Source into a W3C DOM node

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

javax.xml.transform.TransformerException

toDOMNode

public org.w3c.dom.Node toDOMNode(javax.jbi.messaging.NormalizedMessage message)
                           throws javax.jbi.messaging.MessagingException,
                                  javax.xml.transform.TransformerException,
                                  javax.xml.parsers.ParserConfigurationException,
                                  java.io.IOException,
                                  org.xml.sax.SAXException

Avoids multple parsing to DOM by caching the DOM representation in the message as a property so future calls will avoid the reparse - and avoid issues with stream based Source instances.

Parameters:

message - the normalized message

Returns:

the W3C DOM node for this message

Throws:

org.xml.sax.SAXException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

javax.jbi.messaging.MessagingException

javax.xml.transform.TransformerException

toDOMElement

public org.w3c.dom.Element toDOMElement(javax.jbi.messaging.NormalizedMessage message)
                                 throws javax.jbi.messaging.MessagingException,
                                        javax.xml.transform.TransformerException,
                                        javax.xml.parsers.ParserConfigurationException,
                                        java.io.IOException,
                                        org.xml.sax.SAXException

Create a DOM element from the normalized message.

Parameters:

message -

Returns:

Throws:

javax.jbi.messaging.MessagingException

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

toDOMElement

public org.w3c.dom.Element toDOMElement(javax.xml.transform.Source source)
                                 throws javax.xml.transform.TransformerException,
                                        javax.xml.parsers.ParserConfigurationException,
                                        java.io.IOException,
                                        org.xml.sax.SAXException

Create a DOM element from the given source.

Parameters:

source -

Returns:

Throws:

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

toDOMElement

public org.w3c.dom.Element toDOMElement(org.w3c.dom.Node node)
                                 throws javax.xml.transform.TransformerException

Create a DOM element from the DOM node. Simply cast if the node is an Element, or return the root element if it is a Document.

Parameters:

node -

Returns:

Throws:

javax.xml.transform.TransformerException

toDOMDocument

public org.w3c.dom.Document toDOMDocument(javax.jbi.messaging.NormalizedMessage message)
                                   throws javax.jbi.messaging.MessagingException,
                                          javax.xml.transform.TransformerException,
                                          javax.xml.parsers.ParserConfigurationException,
                                          java.io.IOException,
                                          org.xml.sax.SAXException

Create a DOM document from the given normalized message

Parameters:

message -

Returns:

Throws:

javax.jbi.messaging.MessagingException

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

toDOMDocument

public org.w3c.dom.Document toDOMDocument(javax.xml.transform.Source source)
                                   throws javax.xml.transform.TransformerException,
                                          javax.xml.parsers.ParserConfigurationException,
                                          java.io.IOException,
                                          org.xml.sax.SAXException

Create a DOM document from the given source.

Parameters:

source -

Returns:

Throws:

javax.xml.transform.TransformerException

javax.xml.parsers.ParserConfigurationException

java.io.IOException

org.xml.sax.SAXException

toDOMDocument

public org.w3c.dom.Document toDOMDocument(org.w3c.dom.Node node)
                                   throws javax.xml.parsers.ParserConfigurationException,
                                          javax.xml.transform.TransformerException

Create a DOM document from the given Node. If the node is an document, just cast it, if the node is an root element, retrieve its owner element or create a new document and import the node.

Parameters:

node -

Returns:

Throws:

javax.xml.parsers.ParserConfigurationException

javax.xml.transform.TransformerException

toStaxSource

public StaxSource toStaxSource(javax.xml.transform.Source source)
                        throws javax.xml.stream.XMLStreamException

Converts the source instance to a StaxSource or returns null if the conversion is not supported (making it easy to derive from this class to add new kinds of conversion).

Parameters:

source - the source

Returns:

the converted StaxSource

Throws:

javax.xml.stream.XMLStreamException

toXMLStreamReader

public javax.xml.stream.XMLStreamReader toXMLStreamReader(javax.xml.transform.Source source)
                                                   throws javax.xml.stream.XMLStreamException,
                                                          javax.xml.transform.TransformerException

Throws:

javax.xml.stream.XMLStreamException

javax.xml.transform.TransformerException

getDocumentBuilderFactory

public javax.xml.parsers.DocumentBuilderFactory getDocumentBuilderFactory()

setDocumentBuilderFactory

public void setDocumentBuilderFactory(javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory)

createDocumentBuilderFactory

public javax.xml.parsers.DocumentBuilderFactory createDocumentBuilderFactory()

createDocumentBuilder

public javax.xml.parsers.DocumentBuilder createDocumentBuilder()
                                                        throws javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.parsers.ParserConfigurationException

createDocument

public org.w3c.dom.Document createDocument()
                                    throws javax.xml.parsers.ParserConfigurationException

Throws:

javax.xml.parsers.ParserConfigurationException

createTransfomer

public javax.xml.transform.Transformer createTransfomer()
                                                 throws javax.xml.transform.TransformerConfigurationException

Throws:

javax.xml.transform.TransformerConfigurationException

createTransformerFactory

public javax.xml.transform.TransformerFactory createTransformerFactory()

getTransformerFactory

public javax.xml.transform.TransformerFactory getTransformerFactory()

setTransformerFactory

public void setTransformerFactory(javax.xml.transform.TransformerFactory transformerFactory)

getInputFactory

public javax.xml.stream.XMLInputFactory getInputFactory()

setInputFactory

public void setInputFactory(javax.xml.stream.XMLInputFactory inputFactory)

getOutputFactory

public javax.xml.stream.XMLOutputFactory getOutputFactory()

setOutputFactory

public void setOutputFactory(javax.xml.stream.XMLOutputFactory outputFactory)

createInputFactory

protected javax.xml.stream.XMLInputFactory createInputFactory()

createOutputFactory

protected javax.xml.stream.XMLOutputFactory createOutputFactory()