org.openestate.io.core

Class XmlUtils

java.lang.Object

org.openestate.io.core.XmlUtils

public final class XmlUtils
extends Object

Some helper functions for XML processing.

Since:

1.0

Author:

Andreas Rudolph

Method Summary

Modifier and Type	Method and Description
static void	clean(Node node) Recursively remove any comments and unnecessary white spaces from a Node and its children.
static int	countNodes(String xpathExpression, Document doc) Count the number of nodes, that are matching against an XPath expression.
static int	countNodes(String xpathExpression, Document doc, Object context) Count the number of nodes, that are matching against an XPath expression.
static Element	getRootElement(Document doc) Return the root Element of a Document.
static Document	newDocument() Create an empty Document.
static Document	newDocument(boolean namespaceAware) Create an empty Document.
static Document	newDocument(File xmlFile) Create a Document from a File.
static Document	newDocument(File xmlFile, boolean namespaceAware) Create a Document from a File.
static Document	newDocument(InputSource xmlSource) Create a Document from an InputSource.
static Document	newDocument(InputSource xmlSource, boolean namespaceAware) Create a Document from an InputSource.
static Document	newDocument(InputStream xmlStream) Create a Document from an InputStream.
static Document	newDocument(InputStream xmlStream, boolean namespaceAware) Create a Document from an InputStream.
static Document	newDocument(String xmlString) Create a Document from a XML string.
static Document	newDocument(String xmlString, boolean namespaceAware) Create a Document from a XML string.
static org.jaxen.XPath	newXPath(String expression) Create a XPath expression.
static org.jaxen.XPath	newXPath(String expression, Document doc) Create a XPath expression.
static org.jaxen.XPath	newXPath(String expression, Document doc, String namespacePrefix) Create a XPath expression.
static Calendar	parseDate(String value) Reads an xsd:date value.
static Calendar	parseDateTime(String value) Reads an xsd:dateTime value.
static void	printNode(Element node) Print an Element and its children to the local logger.
static void	printNodes(Document doc) Print nodes of a Document recursively to the local logger.
static void	replaceNamespace(Document doc, Node node, String newNamespaceURI) Replace the namespace of a Node and its children.
static void	replaceNamespace(Document doc, String newNamespaceURI) Replace the namespace of any Element in a Document.
static void	replaceTextWithCData(Document doc) Replace all text values of a Document with CDATA values.
static void	replaceTextWithCData(Document doc, Node node) Replace all text values of a Node with CDATA values.
static void	write(Document doc, File file) Write a Document to a File.
static void	write(Document doc, File file, boolean prettyPrint) Write a Document to a File.
static void	write(Document doc, OutputStream output) Write a Document to an OutputStream.
static void	write(Document doc, OutputStream output, boolean prettyPrint) Write a Document to an OutputStream.
static void	write(Document doc, Writer output) Write a Document to a Writer.
static void	write(Document doc, Writer output, boolean prettyPrint) Write a Document to a Writer.

Methods inherited from class java.lang.Object

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

Method Detail

clean

public static void clean(Node node)

Recursively remove any comments and unnecessary white spaces from a Node and its children.

Parameters:

node - the node to clean

countNodes

public static int countNodes(String xpathExpression,
                             Document doc)
                      throws org.jaxen.JaxenException

Count the number of nodes, that are matching against an XPath expression.

Parameters:

xpathExpression - the XPath expression to match

doc - the document, on which the XPath expression is evaluated

Returns:

number of matching nodes

Throws:

org.jaxen.JaxenException - if the XPath evaluation failed

countNodes

public static int countNodes(String xpathExpression,
                             Document doc,
                             Object context)
                      throws org.jaxen.JaxenException

Count the number of nodes, that are matching against an XPath expression.

Parameters:

xpathExpression - the XPath expression to match

doc - the document, on which the XPath expression is evaluated

context - the node, on which the XPath expression is evaluated

Returns:

number of matching nodes

Throws:

org.jaxen.JaxenException - if the XPath evaluation failed

getRootElement

public static Element getRootElement(Document doc)

Return the root Element of a Document.

Parameters:

doc - the document, where the root element is looked up

Returns:

root element of the document or null, if not found

newDocument

public static Document newDocument()
                            throws ParserConfigurationException

Create an empty Document.

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

newDocument

public static Document newDocument(boolean namespaceAware)
                            throws ParserConfigurationException

Create an empty Document.

Parameters:

namespaceAware - if namespaces are used in the created document

Returns:

created document

Throws:

ParserConfigurationException - if the parser is not properly configured

newDocument

public static Document newDocument(String xmlString)
                            throws SAXException,
                                   IOException,
                                   ParserConfigurationException

Create a Document from a XML string.

Parameters:

xmlString - the XML string, the document is created from

Returns:

created document

Throws:

SAXException - if XML contains an error

IOException - if XML is not readable

ParserConfigurationException - if the parser is not properly configured

newDocument

public static Document newDocument(String xmlString,
                                   boolean namespaceAware)
                            throws SAXException,
                                   IOException,
                                   ParserConfigurationException

Create a Document from a XML string.

Parameters:

xmlString - the XML string, the document is created from

namespaceAware - if namespaces are used in the created document

Returns:

created document

Throws:

SAXException - if XML contains an error

IOException - if XML is not readable

ParserConfigurationException - if the parser is not properly configured

newDocument

public static Document newDocument(InputSource xmlSource)
                            throws SAXException,
                                   IOException,
                                   ParserConfigurationException

Create a Document from an InputSource.

Parameters:

xmlSource - the XML input, the document is created from

Returns:

created document

Throws:

SAXException - if XML contains an error

IOException - if XML is not readable

ParserConfigurationException - if the parser is not properly configured

newDocument

public static Document newDocument(InputSource xmlSource,
                                   boolean namespaceAware)
                            throws SAXException,
                                   IOException,
                                   ParserConfigurationException

Create a Document from an InputSource.

Parameters:

xmlSource - the XML input, the document is created from

namespaceAware - if namespaces are used in the created document

Returns:

created document

Throws:

SAXException - if XML contains an error

IOException - if XML is not readable

ParserConfigurationException - if the parser is not properly configured

newDocument

public static Document newDocument(InputStream xmlStream)
                            throws SAXException,
                                   IOException,
                                   ParserConfigurationException

Create a Document from an InputStream.

Parameters:

xmlStream - the XML input, the document is created from

Returns:

created document

Throws:

SAXException - if XML contains an error

IOException - if XML is not readable

ParserConfigurationException - if the parser is not properly configured

newDocument

public static Document newDocument(InputStream xmlStream,
                                   boolean namespaceAware)
                            throws SAXException,
                                   IOException,
                                   ParserConfigurationException

Create a Document from an InputStream.

Parameters:

xmlStream - the XML input, the document is created from

namespaceAware - if namespaces are used in the created document

Returns:

created document

Throws:

SAXException - if XML contains an error

IOException - if XML is not readable

ParserConfigurationException - if the parser is not properly configured

newDocument

public static Document newDocument(File xmlFile)
                            throws SAXException,
                                   IOException,
                                   ParserConfigurationException

Create a Document from a File.

Parameters:

xmlFile - the XML file, the document is created from

Returns:

created document

Throws:

SAXException - if XML contains an error

IOException - if XML is not readable

ParserConfigurationException - if the parser is not properly configured

newDocument

public static Document newDocument(File xmlFile,
                                   boolean namespaceAware)
                            throws SAXException,
                                   IOException,
                                   ParserConfigurationException

Create a Document from a File.

Parameters:

xmlFile - the XML file, the document is created from

namespaceAware - if namespaces are used in the created document

Returns:

created document

Throws:

SAXException - if XML contains an error

IOException - if XML is not readable

ParserConfigurationException - if the parser is not properly configured

newXPath

public static org.jaxen.XPath newXPath(String expression)
                                throws org.jaxen.JaxenException

Create a XPath expression.

Parameters:

expression - string with the XPath expression to create

Returns:

the created XPath expression

Throws:

org.jaxen.JaxenException - if the XPath is not creatable

newXPath

public static org.jaxen.XPath newXPath(String expression,
                                       Document doc)
                                throws org.jaxen.JaxenException

Create a XPath expression.

Parameters:

expression - string with the XPath expression to create

doc - the document, whose namespace is bound to the XPath expression

Returns:

the created XPath expression

Throws:

org.jaxen.JaxenException - if the XPath is not creatable

newXPath

public static org.jaxen.XPath newXPath(String expression,
                                       Document doc,
                                       String namespacePrefix)
                                throws org.jaxen.JaxenException

Create a XPath expression.

Parameters:

expression - string with the XPath expression to create

doc - the document, whose namespace is bound to the XPath expression

namespacePrefix - prefix of the document namespace, that is bound to the XPath expression

Returns:

the created XPath expression

Throws:

org.jaxen.JaxenException - if the XPath is not creatable

parseDate

public static Calendar parseDate(String value)

Reads an xsd:date value.

If the value is not a valid xsd:date, we're trying to parse the value against other common formats. If this also fails, we're trying to parse the value as xsd:dateTime.

The functions throws an IllegalArgumentException, if the value is not readable.

Parameters:

value - the XML value to parse

Returns:

parsed date value

parseDateTime

public static Calendar parseDateTime(String value)

Reads an xsd:dateTime value.

If the value is not a valid xsd:dateTime, we're trying to parse the value against other common formats. If this also fails, we're trying to parse the value as xsd:date.

The functions throws an IllegalArgumentException, if the value is not readable.

Parameters:

value - the XML value to parse

Returns:

parsed date value

printNodes

public static void printNodes(Document doc)

Print nodes of a Document recursively to the local logger.

Parameters:

doc - the document to print

printNode

public static void printNode(Element node)

Print an Element and its children to the local logger.

Parameters:

node - the element to print

replaceNamespace

public static void replaceNamespace(Document doc,
                                    String newNamespaceURI)

Replace the namespace of any Element in a Document.

Parameters:

doc - the document to update

newNamespaceURI - the new namespace URI

replaceNamespace

public static void replaceNamespace(Document doc,
                                    Node node,
                                    String newNamespaceURI)

Replace the namespace of a Node and its children.

Parameters:

doc - the document to update

node - the node to update

newNamespaceURI - the new namespace URI

replaceTextWithCData

public static void replaceTextWithCData(Document doc)

Replace all text values of a Document with CDATA values.

Parameters:

doc - the document to update

replaceTextWithCData

public static void replaceTextWithCData(Document doc,
                                        Node node)

Replace all text values of a Node with CDATA values.

Parameters:

doc - the document to update

node - the node to update

write

public static void write(Document doc,
                         File file)
                  throws TransformerException,
                         IOException

Write a Document to a File.

Parameters:

doc - the document to write

file - the file, where the document is written to

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed

write

public static void write(Document doc,
                         File file,
                         boolean prettyPrint)
                  throws TransformerException,
                         IOException

Write a Document to a File.

Parameters:

doc - the document to write

file - the file, where the document is written to

prettyPrint - if pretty printing is enabled for the generated XML code

Throws:

TransformerException - if XML transformation failed

IOException - if writing failed

write

public static void write(Document doc,
                         OutputStream output)
                  throws TransformerException

Write a Document to an OutputStream.

Parameters:

doc - the document to write

output - the output, where the document is written to

Throws:

TransformerException - if XML transformation failed

write

public static void write(Document doc,
                         OutputStream output,
                         boolean prettyPrint)
                  throws TransformerException

Write a Document to an OutputStream.

Parameters:

doc - the document to write

output - the output, where the document is written to

prettyPrint - if pretty printing is enabled for the generated XML code

Throws:

TransformerException - if XML transformation failed

write

public static void write(Document doc,
                         Writer output)
                  throws TransformerException

Write a Document to a Writer.

Parameters:

doc - the document to write

output - the output, where the document is written to

Throws:

TransformerException - if XML transformation failed

write

public static void write(Document doc,
                         Writer output,
                         boolean prettyPrint)
                  throws TransformerException

Write a Document to a Writer.

Parameters:

doc - the document to write

output - the output, where the document is written to

prettyPrint - if pretty printing is enabled for the generated XML code

Throws:

TransformerException - if XML transformation failed