com.technia.tvc.core.util

Class XMLUtils

java.lang.Object

com.technia.tvc.core.util.XMLUtils

public class XMLUtils
extends java.lang.Object

This class provides some useful (!?) methods for transforming, serializing and parsing xml documents.

Method Summary

Modifier and Type	Method and Description
static javax.xml.parsers.DocumentBuilder	createBuilder(org.xml.sax.EntityResolver entityResolver) Creates a DocumentBuilder with the specified entity resolver.
static org.w3c.dom.Document	newDocument() Creates an empty DOM document.
static org.w3c.dom.Document	parse(java.io.File file) Parses the document represented by the file.
static org.w3c.dom.Document	parse(java.io.File file, org.xml.sax.EntityResolver entityResolver) Parses the document represented by the file.
static org.w3c.dom.Document	parse(org.xml.sax.InputSource source) Parses the document represented by the input source.
static org.w3c.dom.Document	parse(org.xml.sax.InputSource source, org.xml.sax.EntityResolver entityResolver) Parses the document represented by the input source.
static org.w3c.dom.Document	parse(java.io.InputStream in) Parses the document represented by the input stream.
static org.w3c.dom.Document	parse(java.io.InputStream in, org.xml.sax.EntityResolver entityResolver) Parses the document represented by the input stream.
static org.w3c.dom.Document	parse(java.lang.String xml) Parses the document represented by the string.
static org.w3c.dom.Document	parse(java.lang.String xml, org.xml.sax.EntityResolver entityResolver) Parses the document represented by the string.
static java.lang.String	prettyPrint(org.w3c.dom.Document document) Serializes a document into a String, with pretty indentations.
static void	prettyPrint(org.w3c.dom.Document document, java.io.Writer writer) Serializes the document to the writer.
static java.io.InputStream	serialize(org.w3c.dom.Document document) Serializes the document and returns the input stream from which to read the result from.
static void	serialize(org.w3c.dom.Document document, java.io.OutputStream out) Serializes the document to the output stream.
static void	serialize(org.w3c.dom.Document document, java.io.Writer writer) Serializes the document to the writer.
static java.io.InputStream	transform(javax.xml.transform.Source xml, javax.xml.transform.Source xsl) Transforms the xml using the xsl and returns an input stream from which the result can be read.
static void	transform(javax.xml.transform.Source xml, javax.xml.transform.Source xsl, java.io.OutputStream out) Transforms the xml using the xsl to the output stream.
static void	transform(javax.xml.transform.Source xml, javax.xml.transform.Source xsl, java.io.OutputStream out, java.util.Properties params) Transforms the xml using the xsl to the output stream.

Methods inherited from class java.lang.Object

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

Method Detail

transform

public static java.io.InputStream transform(javax.xml.transform.Source xml,
                                            javax.xml.transform.Source xsl)
                                     throws org.xml.sax.SAXException,
                                            javax.xml.transform.TransformerConfigurationException,
                                            javax.xml.transform.TransformerException,
                                            java.io.IOException

Transforms the xml using the xsl and returns an input stream from which the result can be read.

Parameters:

xml - the xml document to transform.

xsl - the xsl to use when transforming.

Returns:

an input stream to read the result from.

Throws:

org.xml.sax.SAXException - if unable to parse any of the documents.

javax.xml.transform.TransformerConfigurationException - if unable to create transformer.

javax.xml.transform.TransformerException - if unable to transform.

java.io.IOException - if an input/output error occurs.

transform

public static void transform(javax.xml.transform.Source xml,
                             javax.xml.transform.Source xsl,
                             java.io.OutputStream out)
                      throws org.xml.sax.SAXException,
                             javax.xml.transform.TransformerConfigurationException,
                             javax.xml.transform.TransformerException,
                             java.io.IOException

Transforms the xml using the xsl to the output stream.

Parameters:

xml - the xml document to transform.

xsl - the xsl to use when transforming.

out - the output stream to transform to.

Throws:

org.xml.sax.SAXException - if unable to parse any of the documents.

javax.xml.transform.TransformerConfigurationException - if unable to create transformer.

javax.xml.transform.TransformerException - if unable to transform.

java.io.IOException - if an input/output error occurs.

transform

public static void transform(javax.xml.transform.Source xml,
                             javax.xml.transform.Source xsl,
                             java.io.OutputStream out,
                             java.util.Properties params)
                      throws javax.xml.transform.TransformerException,
                             java.io.IOException

Transforms the xml using the xsl to the output stream.

Parameters:

xml - the xml document to transform.

xsl - the xsl to use when transforming.

out - the output stream to transform to.

params - The parameters to pass to the processor.

Throws:

org.xml.sax.SAXException - if unable to parse any of the documents.

javax.xml.transform.TransformerConfigurationException - if unable to create transformer.

javax.xml.transform.TransformerException - if unable to transform.

java.io.IOException - if an input/output error occurs.

Since:

5.0.2

createBuilder

public static javax.xml.parsers.DocumentBuilder createBuilder(org.xml.sax.EntityResolver entityResolver)
                                                       throws javax.xml.parsers.ParserConfigurationException

Creates a DocumentBuilder with the specified entity resolver.

Parameters:

entityResolver - the EntityResolver to use.

Returns:

the document builder.

Throws:

javax.xml.parsers.ParserConfigurationException - if unable to create document builder.

newDocument

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

Creates an empty DOM document.

Returns:

The empty document.

Throws:

javax.xml.parsers.ParserConfigurationException - If unable to create the document.

Since:

2009.1

parse

public static org.w3c.dom.Document parse(java.io.File file)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException

Parses the document represented by the file.

Parameters:

file - the file containing the document to parse.

Returns:

the parsed document.

Throws:

javax.xml.parsers.ParserConfigurationException - if unable to create document builder.

org.xml.sax.SAXException - if unable to parse the document.

java.io.IOException - if an input/output error occurs.

parse

public static org.w3c.dom.Document parse(java.io.File file,
                                         org.xml.sax.EntityResolver entityResolver)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException

Parses the document represented by the file.

Parameters:

file - the file containing the document to parse.

entityResolver - the EntityResolver to use.

Returns:

the parsed document.

Throws:

javax.xml.parsers.ParserConfigurationException - if unable to create document builder.

org.xml.sax.SAXException - if unable to parse the document.

java.io.IOException - if an input/output error occurs.

parse

public static org.w3c.dom.Document parse(org.xml.sax.InputSource source)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException

Parses the document represented by the input source.

Parameters:

source - the input source representing the document to parse.

Returns:

the parsed document.

Throws:

javax.xml.parsers.ParserConfigurationException - if unable to create document builder.

org.xml.sax.SAXException - if unable to parse the document.

java.io.IOException - if an input/output error occurs.

parse

public static org.w3c.dom.Document parse(org.xml.sax.InputSource source,
                                         org.xml.sax.EntityResolver entityResolver)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException

Parses the document represented by the input source.

Parameters:

source - the input source representing the document to parse.

entityResolver - the EntityResolver to use.

Returns:

the parsed document.

Throws:

javax.xml.parsers.ParserConfigurationException - if unable to create document builder.

org.xml.sax.SAXException - if unable to parse the document.

java.io.IOException - if an input/output error occurs.

parse

public static org.w3c.dom.Document parse(java.io.InputStream in)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException

Parses the document represented by the input stream.

Parameters:

in - the input stream representing the document to parse.

Returns:

the parsed document.

Throws:

javax.xml.parsers.ParserConfigurationException - if unable to create document builder.

org.xml.sax.SAXException - if unable to parse the document.

java.io.IOException - if an input/output error occurs.

parse

public static org.w3c.dom.Document parse(java.io.InputStream in,
                                         org.xml.sax.EntityResolver entityResolver)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException

Parses the document represented by the input stream.

Parameters:

in - the input stream representing the document to parse.

entityResolver - the EntityResolver to use.

Returns:

the parsed document.

Throws:

javax.xml.parsers.ParserConfigurationException - if unable to create document builder.

org.xml.sax.SAXException - if unable to parse the document.

java.io.IOException - if an input/output error occurs.

parse

public static org.w3c.dom.Document parse(java.lang.String xml)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException

Parses the document represented by the string.

Parameters:

xml - the string representing the document to parse.

Returns:

the parsed document.

Throws:

javax.xml.parsers.ParserConfigurationException - if unable to create document builder.

org.xml.sax.SAXException - if unable to parse the document.

java.io.IOException - if an input/output error occurs.

parse

public static org.w3c.dom.Document parse(java.lang.String xml,
                                         org.xml.sax.EntityResolver entityResolver)
                                  throws javax.xml.parsers.ParserConfigurationException,
                                         java.io.IOException,
                                         org.xml.sax.SAXException

Parses the document represented by the string.

Parameters:

xml - the string representing the document to parse.

entityResolver - the EntityResolver to use.

Returns:

the parsed document.

Throws:

javax.xml.parsers.ParserConfigurationException - if unable to create document builder.

org.xml.sax.SAXException - if unable to parse the document.

java.io.IOException - if an input/output error occurs.

serialize

public static java.io.InputStream serialize(org.w3c.dom.Document document)
                                     throws java.io.IOException,
                                            javax.xml.transform.TransformerException

Serializes the document and returns the input stream from which to read the result from.

Parameters:

document - the document to serialize.

Returns:

an input stream from which to read the result from.

Throws:

java.io.IOException - if an input/output error occurs.

javax.xml.transform.TransformerException

serialize

public static void serialize(org.w3c.dom.Document document,
                             java.io.OutputStream out)
                      throws java.io.IOException,
                             javax.xml.transform.TransformerException

Serializes the document to the output stream. The outputstream is flushed but not closed.

Parameters:

document - the document to serialize.

out - the output stream to serialize into.

Throws:

IOException, - TransformerException

java.io.IOException

javax.xml.transform.TransformerException

serialize

public static void serialize(org.w3c.dom.Document document,
                             java.io.Writer writer)
                      throws java.io.IOException,
                             javax.xml.transform.TransformerException

Serializes the document to the writer. The writer is flushed but not closed.

Parameters:

document - the document to serialize.

writer - the writer to serialize into.

Throws:

IOException, - TransformerException

java.io.IOException

javax.xml.transform.TransformerException

Since:

6.0.0

prettyPrint

public static void prettyPrint(org.w3c.dom.Document document,
                               java.io.Writer writer)
                        throws java.io.IOException,
                               javax.xml.transform.TransformerException

Serializes the document to the writer.

Parameters:

document -

writer -

Throws:

java.io.IOException

javax.xml.transform.TransformerException

Since:

6.0.0

prettyPrint

public static java.lang.String prettyPrint(org.w3c.dom.Document document)

Serializes a document into a String, with pretty indentations.

Parameters:

document - The document.

Returns:

The document as a string or null if unable to serialize.

Since:

2009.1