org.apache.camel.converter.jaxp
Class XmlConverter

java.lang.Object
  org.apache.camel.converter.jaxp.XmlConverter

@Converter
public class XmlConverter
extends Object

A helper class to transform to and from various JAXB types such as Source and Document

Version:

$Revision: 787735 $

Field Summary

static String	DEFAULT_CHARSET_PROPERTY
static String	defaultCharset

Constructor Summary

XmlConverter()

XmlConverter(DocumentBuilderFactory documentBuilderFactory)

Method Summary

Document	createDocument()
DocumentBuilder	createDocumentBuilder()
DocumentBuilderFactory	createDocumentBuilderFactory()
Transformer	createTransfomer()
TransformerFactory	createTransformerFactory()
Properties	defaultOutputProperties() Returns the default set of output properties for conversions.
DocumentBuilderFactory	getDocumentBuilderFactory()
TransformerFactory	getTransformerFactory()
void	setDocumentBuilderFactory(DocumentBuilderFactory documentBuilderFactory)
void	setTransformerFactory(TransformerFactory transformerFactory)
byte[]	toByteArray(Source source, Exchange exchange) Converts the given input Source into bytes
Document	toDOMDocument(byte[] data) Converts the given data to a DOM document
Document	toDOMDocument(File file) Converts the given File to a DOM document
Document	toDOMDocument(InputSource in) Converts the given InputSource to a DOM document
Document	toDOMDocument(InputStream in) Converts the given InputStream to a DOM document
Document	toDOMDocument(Node node) Create a DOM document from the given Node.
Document	toDOMDocument(Reader in) Converts the given InputStream to a DOM document
Document	toDOMDocument(Source source) Create a DOM document from the given source.
Document	toDOMDocument(String text) Converts the given String to a DOM document
Element	toDOMElement(Node node) Create a DOM element from the DOM node.
Element	toDOMElement(Source source) Create a DOM element from the given source.
Node	toDOMNode(Source source) Converts the given TRaX Source into a W3C DOM node
Node	toDOMNodeFromSAX(SAXSource source)
DOMSource	toDOMSource(InputStream is)
DOMSource	toDOMSource(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).
DOMSource	toDOMSource(String text) 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).
DOMSource	toDOMSourceFromSAX(SAXSource source)
DOMSource	toDOMSourceFromStream(StreamSource source)
Reader	toReaderFromSource(Source src)
void	toResult(Source source, Result result) Converts the given input Source into the required result
void	toResult(Source source, Result result, Properties outputProperties) Converts the given input Source into the required result
SAXSource	toSAXSource(InputStream 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).
SAXSource	toSAXSource(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).
SAXSource	toSAXSource(String 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).
SAXSource	toSAXSourceFromDOM(DOMSource source)
SAXSource	toSAXSourceFromStream(StreamSource source)
BytesSource	toSource(byte[] data) Converts the given byte[] to a Source
DOMSource	toSource(Document document) Converts the given Document to a Source
Source	toSource(Node node) Converts the given Node to a Source
StringSource	toSource(String data) Converts the given String to a Source
StreamSource	toStreamSource(byte[] in, Exchange exchange)
StreamSource	toStreamSource(ByteBuffer in, Exchange exchange)
StreamSource	toStreamSource(File in)
StreamSource	toStreamSource(InputStream in)
StreamSource	toStreamSource(Reader in)
StreamSource	toStreamSource(Source source)
StreamSource	toStreamSourceFromDOM(DOMSource source)
StreamSource	toStreamSourceFromSAX(SAXSource source)
String	toString(Node node) Converts the given input Node into text
String	toString(Source source) Converts the given input Source into text

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 String DEFAULT_CHARSET_PROPERTY

See Also:

Constant Field Values

defaultCharset

public static String defaultCharset

Constructor Detail

XmlConverter

public XmlConverter()

XmlConverter

public XmlConverter(DocumentBuilderFactory documentBuilderFactory)

Method Detail

defaultOutputProperties

public Properties defaultOutputProperties()

Returns the default set of output properties for conversions.

toResult

public void toResult(Source source,
                     Result result)
              throws TransformerException

Converts the given input Source into the required result

Throws:

TransformerException

toResult

public void toResult(Source source,
                     Result result,
                     Properties outputProperties)
              throws TransformerException

Converts the given input Source into the required result

Throws:

TransformerException

toSource

@Converter
public BytesSource toSource(byte[] data)

Converts the given byte[] to a Source

toSource

@Converter
public StringSource toSource(String data)

Converts the given String to a Source

toSource

@Converter
public DOMSource toSource(Document document)

Converts the given Document to a Source

toSource

@Converter
public Source toSource(Node node)

Converts the given Node to a Source

toString

@Converter
public String toString(Source source)
                throws TransformerException

Converts the given input Source into text

Throws:

TransformerException

toByteArray

@Converter
public byte[] toByteArray(Source source,
                                    Exchange exchange)
                   throws TransformerException

Converts the given input Source into bytes

Throws:

TransformerException

toString

@Converter
public String toString(Node node)
                throws TransformerException

Converts the given input Node into text

Throws:

TransformerException

toDOMSource

@Converter
public DOMSource toDOMSource(Source source)
                      throws ParserConfigurationException,
                             IOException,
                             SAXException,
                             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:

ParserConfigurationException

IOException

SAXException

TransformerException

toDOMSource

@Converter
public DOMSource toDOMSource(String text)
                      throws ParserConfigurationException,
                             IOException,
                             SAXException,
                             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:

ParserConfigurationException

IOException

SAXException

TransformerException

toSAXSource

@Converter
public SAXSource toSAXSource(String source)
                      throws IOException,
                             SAXException,
                             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:

IOException

SAXException

TransformerException

toSAXSource

@Converter
public SAXSource toSAXSource(InputStream source)
                      throws IOException,
                             SAXException,
                             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:

IOException

SAXException

TransformerException

toSAXSource

@Converter
public SAXSource toSAXSource(Source source)
                      throws IOException,
                             SAXException,
                             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:

IOException

SAXException

TransformerException

toStreamSource

@Converter
public StreamSource toStreamSource(Source source)
                            throws TransformerException

Throws:

TransformerException

toStreamSource

@Converter
public StreamSource toStreamSource(InputStream in)
                            throws TransformerException

Throws:

TransformerException

toStreamSource

@Converter
public StreamSource toStreamSource(Reader in)
                            throws TransformerException

Throws:

TransformerException

toStreamSource

@Converter
public StreamSource toStreamSource(File in)
                            throws TransformerException

Throws:

TransformerException

toStreamSource

@Converter
public StreamSource toStreamSource(byte[] in,
                                             Exchange exchange)
                            throws TransformerException

Throws:

TransformerException

toStreamSource

@Converter
public StreamSource toStreamSource(ByteBuffer in,
                                             Exchange exchange)
                            throws TransformerException

Throws:

TransformerException

toStreamSourceFromSAX

@Converter
public StreamSource toStreamSourceFromSAX(SAXSource source)
                                   throws TransformerException

Throws:

TransformerException

toStreamSourceFromDOM

@Converter
public StreamSource toStreamSourceFromDOM(DOMSource source)
                                   throws TransformerException

Throws:

TransformerException

toSAXSourceFromStream

@Converter
public SAXSource toSAXSourceFromStream(StreamSource source)

toReaderFromSource

@Converter
public Reader toReaderFromSource(Source src)
                          throws TransformerException

Throws:

TransformerException

toDOMSource

@Converter
public DOMSource toDOMSource(InputStream is)
                      throws ParserConfigurationException,
                             IOException,
                             SAXException

Throws:

ParserConfigurationException

IOException

SAXException

toDOMSourceFromStream

@Converter
public DOMSource toDOMSourceFromStream(StreamSource source)
                                throws ParserConfigurationException,
                                       IOException,
                                       SAXException

Throws:

ParserConfigurationException

IOException

SAXException

toSAXSourceFromDOM

@Converter
public SAXSource toSAXSourceFromDOM(DOMSource source)
                             throws TransformerException

Throws:

TransformerException

toDOMSourceFromSAX

@Converter
public DOMSource toDOMSourceFromSAX(SAXSource source)
                             throws IOException,
                                    SAXException,
                                    ParserConfigurationException,
                                    TransformerException

Throws:

IOException

SAXException

ParserConfigurationException

TransformerException

toDOMNodeFromSAX

@Converter
public Node toDOMNodeFromSAX(SAXSource source)
                      throws ParserConfigurationException,
                             IOException,
                             SAXException,
                             TransformerException

Throws:

ParserConfigurationException

IOException

SAXException

TransformerException

toDOMNode

@Converter
public Node toDOMNode(Source source)
               throws TransformerException,
                      ParserConfigurationException,
                      IOException,
                      SAXException

Converts the given TRaX Source into a W3C DOM node

Throws:

TransformerException

ParserConfigurationException

IOException

SAXException

toDOMElement

@Converter
public Element toDOMElement(Source source)
                     throws TransformerException,
                            ParserConfigurationException,
                            IOException,
                            SAXException

Create a DOM element from the given source.

Throws:

TransformerException

ParserConfigurationException

IOException

SAXException

toDOMElement

@Converter
public Element toDOMElement(Node node)
                     throws 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.

Throws:

TransformerException

toDOMDocument

@Converter
public Document toDOMDocument(byte[] data)
                       throws IOException,
                              SAXException,
                              ParserConfigurationException

Converts the given data to a DOM document

Parameters:

data - is the data to be parsed

Returns:

the parsed document

Throws:

IOException

SAXException

ParserConfigurationException

toDOMDocument

@Converter
public Document toDOMDocument(InputStream in)
                       throws IOException,
                              SAXException,
                              ParserConfigurationException

Converts the given InputStream to a DOM document

Parameters:

in - is the data to be parsed

Returns:

the parsed document

Throws:

IOException

SAXException

ParserConfigurationException

toDOMDocument

@Converter
public Document toDOMDocument(Reader in)
                       throws IOException,
                              SAXException,
                              ParserConfigurationException

Converts the given InputStream to a DOM document

Parameters:

in - is the data to be parsed

Returns:

the parsed document

Throws:

IOException

SAXException

ParserConfigurationException

toDOMDocument

@Converter
public Document toDOMDocument(InputSource in)
                       throws IOException,
                              SAXException,
                              ParserConfigurationException

Converts the given InputSource to a DOM document

Parameters:

in - is the data to be parsed

Returns:

the parsed document

Throws:

IOException

SAXException

ParserConfigurationException

toDOMDocument

@Converter
public Document toDOMDocument(String text)
                       throws IOException,
                              SAXException,
                              ParserConfigurationException

Converts the given String to a DOM document

Parameters:

text - is the data to be parsed

Returns:

the parsed document

Throws:

IOException

SAXException

ParserConfigurationException

toDOMDocument

@Converter
public Document toDOMDocument(File file)
                       throws IOException,
                              SAXException,
                              ParserConfigurationException

Converts the given File to a DOM document

Parameters:

file - is the data to be parsed

Returns:

the parsed document

Throws:

IOException

SAXException

ParserConfigurationException

toDOMDocument

@Converter
public Document toDOMDocument(Source source)
                       throws TransformerException,
                              ParserConfigurationException,
                              IOException,
                              SAXException

Create a DOM document from the given source.

Throws:

TransformerException

ParserConfigurationException

IOException

SAXException

toDOMDocument

@Converter
public Document toDOMDocument(Node node)
                       throws ParserConfigurationException,
                              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.

Throws:

ParserConfigurationException

TransformerException

getDocumentBuilderFactory

public DocumentBuilderFactory getDocumentBuilderFactory()

setDocumentBuilderFactory

public void setDocumentBuilderFactory(DocumentBuilderFactory documentBuilderFactory)

createDocumentBuilderFactory

public DocumentBuilderFactory createDocumentBuilderFactory()

createDocumentBuilder

public DocumentBuilder createDocumentBuilder()
                                      throws ParserConfigurationException

Throws:

ParserConfigurationException

createDocument

public Document createDocument()
                        throws ParserConfigurationException

Throws:

ParserConfigurationException

getTransformerFactory

public TransformerFactory getTransformerFactory()

setTransformerFactory

public void setTransformerFactory(TransformerFactory transformerFactory)

createTransfomer

public Transformer createTransfomer()
                             throws TransformerConfigurationException

Throws:

TransformerConfigurationException

createTransformerFactory

public TransformerFactory createTransformerFactory()