net.mtu.eggplant.xml

Class XMLUtils

java.lang.Object

net.mtu.eggplant.xml.XMLUtils

public class XMLUtils
extends java.lang.Object

Some utilities for working with XML.

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.parsers.DocumentBuilder	DOCUMENT_BUILDER
static org.xml.sax.ErrorHandler	STANDARD_ERROR_HANDLER Standard error handler that throws exceptions on error and fatalError and logs a warning on warning.
static java.lang.ThreadLocal<java.text.DateFormat>	XML_TIME_FORMAT Date format for time type.

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	compareDocuments(org.w3c.dom.Document controlDoc, org.w3c.dom.Document testDoc) Compare two documents and check if they are the same or not.
static java.lang.Boolean	getBooleanAttributeValue(org.w3c.dom.Element element, java.lang.String attributeName)
static java.lang.Double	getDoubleAttributeValue(org.w3c.dom.Element element, java.lang.String attributeName) Get a double value from an attribute.
static java.lang.String	getStringAttributeValue(org.w3c.dom.Element element, java.lang.String attributeName)
static org.w3c.dom.Document	parse(java.io.Reader stream, javax.xml.validation.Schema schema) Parse the document from the given stream.
static org.w3c.dom.Document	parseXMLDocument(org.xml.sax.InputSource xmlDocStream) Parse xmlDoc an XML document.
static org.w3c.dom.Document	parseXMLDocument(java.io.InputStream xmlDocStream) Parse xmlDoc an XML document.
static org.w3c.dom.Document	parseXMLDocument(java.io.Reader xmlDocStream) Parse xmlDoc an XML document.
static void	writeXML(org.w3c.dom.Document doc, java.io.Writer writer) Write the document to a writer.
static void	writeXML(org.w3c.dom.Document doc, java.io.Writer writer, java.lang.String encoding) Write the document to a writer.

Methods inherited from class java.lang.Object

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

Field Detail

XML_TIME_FORMAT

public static final java.lang.ThreadLocal<java.text.DateFormat> XML_TIME_FORMAT

Date format for time type.

DOCUMENT_BUILDER

public static final javax.xml.parsers.DocumentBuilder DOCUMENT_BUILDER

STANDARD_ERROR_HANDLER

public static final org.xml.sax.ErrorHandler STANDARD_ERROR_HANDLER

Standard error handler that throws exceptions on error and fatalError and logs a warning on warning.

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

parse

public static org.w3c.dom.Document parse(java.io.Reader stream,
                                         javax.xml.validation.Schema schema)
                                  throws java.io.IOException,
                                         org.xml.sax.SAXException

Parse the document from the given stream. The document is validated with the specified schema. Does not close the stream after reading. Warnings are output to the logger for this class.

Parameters:

stream - a stream containing document

Returns:

the document

Throws:

java.io.IOException - if there is an error reading the stream

org.xml.sax.SAXException - if there is an error parsing the document or it doesn't match the schema

java.lang.RuntimeException - if there is an error configuring the XML parser, this shouldn't happen

parseXMLDocument

public static org.w3c.dom.Document parseXMLDocument(java.io.InputStream xmlDocStream)
                                             throws org.xml.sax.SAXException,
                                                    java.io.IOException

Parse xmlDoc an XML document. Just does basic parsing, no validity checks. Does not close the stream after parsing. Warnings are output to the logger for this class.

Throws:

java.io.IOException - if there is an error reading the stream

org.xml.sax.SAXException - if the document is found to be invalid

java.lang.RuntimeException - if there is an error configuring the XML parser, this shouldn't happen

parseXMLDocument

public static org.w3c.dom.Document parseXMLDocument(java.io.Reader xmlDocStream)
                                             throws org.xml.sax.SAXException,
                                                    java.io.IOException

Parse xmlDoc an XML document. Just does basic parsing, no validity checks. Does not close the stream after parsing. Warnings are output to the logger for this class.

Throws:

java.io.IOException - if there is an error reading the stream

org.xml.sax.SAXException - if the document is found to be invalid

java.lang.RuntimeException - if there is an error configuring the XML parser, this shouldn't happen

parseXMLDocument

public static org.w3c.dom.Document parseXMLDocument(org.xml.sax.InputSource xmlDocStream)
                                             throws org.xml.sax.SAXException,
                                                    java.io.IOException

Parse xmlDoc an XML document. Just does basic parsing, no validity checks. Does not close the stream after parsing. Warnings are output to the logger for this class.

Throws:

java.io.IOException - if there is an error reading the stream

org.xml.sax.SAXException - if the document is found to be invalid

java.lang.RuntimeException - if there is an error configuring the XML parser, this shouldn't happen

getStringAttributeValue

public static java.lang.String getStringAttributeValue(org.w3c.dom.Element element,
                                                       java.lang.String attributeName)

See Also:

getDoubleAttributeValue(Element, String)

getBooleanAttributeValue

public static java.lang.Boolean getBooleanAttributeValue(org.w3c.dom.Element element,
                                                         java.lang.String attributeName)

See Also:

getDoubleAttributeValue(Element, String)

getDoubleAttributeValue

public static java.lang.Double getDoubleAttributeValue(org.w3c.dom.Element element,
                                                       java.lang.String attributeName)

Get a double value from an attribute.

Parameters:

element - the element to get the attribute from, may be null

attributeName - the attribute name to get

Returns:

the value, null if element is null or the attribute value is null or empty

writeXML

public static void writeXML(org.w3c.dom.Document doc,
                            java.io.Writer writer)

Write the document to a writer.

Parameters:

doc - the document to write

writer - where to write the document

writeXML

public static void writeXML(org.w3c.dom.Document doc,
                            java.io.Writer writer,
                            java.lang.String encoding)

Write the document to a writer.

Parameters:

doc - the document to write

writer - where to write the document

encoding - if non-null use this as the encoding for the text

Throws:

java.lang.RuntimeException - if a TransformerException occurs.

compareDocuments

public static boolean compareDocuments(org.w3c.dom.Document controlDoc,
                                       org.w3c.dom.Document testDoc)

Compare two documents and check if they are the same or not.

Parameters:

controlDoc -

testDoc -

Returns:

true if the documents have the same elements and attributes, reguardless of order