de.aristaflow.adept2.util.xml

Class XMLHelperTools

java.lang.Object

de.aristaflow.adept2.util.xml.XMLHelperTools

public class XMLHelperTools
extends java.lang.Object

Contains important function for both, XML import and export.

Author:

Florian Micheler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ENCODING The encoding that should be used for writing xml files.
protected static java.util.logging.Logger	logger The logger instance of this class.

Constructor Summary

Constructors

Constructor and Description
XMLHelperTools()

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Document	createDocument() Initialises the document object which will be used for constructing elements.
static byte[]	getByteArrayForDocument(org.w3c.dom.Node node) Returns a byte array containing the XML code for the given node.
static byte[]	getByteArrayForDocument(org.w3c.dom.Node node, boolean intend) Returns a byte array containing the XML code for the given node.
static org.w3c.dom.Document	getDocumentFromFile(java.io.File file, javax.xml.validation.Schema schema, org.xml.sax.ErrorHandler errorHandler) Read a Document from a stream.
static org.w3c.dom.Document	getDocumentFromStream(java.io.InputStream inputStream) Parse a Stream and converts it to a Document
static org.w3c.dom.Document	getDocumentFromStream(java.io.InputStream inputStream, javax.xml.validation.Schema schema, org.xml.sax.ErrorHandler errorHandler, boolean nsAware) Read a Document from a file.
static org.w3c.dom.Document	getDocumentFromString(java.lang.String string, javax.xml.validation.Schema schema) Parse a string and converts it to a Document.
static org.w3c.dom.Element	getElement(org.w3c.dom.Node node) Finds an DOM Element for a given Node.
static java.io.InputStream	getInputStreamForDocument(org.w3c.dom.Node node) Returns an input stream containing the XML code of the given node.
static java.io.InputStream	getInputStreamForDocument(org.w3c.dom.Node node, boolean intend) Returns an input stream containing the XML code of the given node.
static java.io.ByteArrayOutputStream	getOutputStreamForDocument(org.w3c.dom.Node node) Returns an output stream containing the XML code of the given node.
static java.io.ByteArrayOutputStream	getOutputStreamForDocument(org.w3c.dom.Node node, boolean intend) Returns an output stream containing the XML code of the given node.
static java.io.ByteArrayOutputStream	getOutputStreamForDocument(org.w3c.dom.Node node, javax.xml.transform.Source xslt) Returns an output stream containing the XML code of the given node.
static java.io.ByteArrayOutputStream	getOutputStreamForDocument(org.w3c.dom.Node node, javax.xml.transform.Source xslt, boolean intend) Returns an output stream containing the XML code of the given node.
static int	getParsedID(org.w3c.dom.Node node) Strips off the leading character and parses the integer value.
static int	getParsedID(java.lang.String nodeValue) Strips off the leading character and parses the integer value.
protected static java.lang.String	getTagName(org.w3c.dom.Element e) This method returns the tag name of the given element.
static java.lang.String	getXMLStringForDocument(org.w3c.dom.Node node) Returns the XML code of a given node as string.
static java.lang.String	getXMLStringForDocument(org.w3c.dom.Node node, boolean intend) Returns the XML code of a given node as string.
static java.lang.String	getXMLStringForInputStream(java.io.InputStream is) Returns the xml code of a given input stream as string.
static boolean	hasTagName(org.w3c.dom.Element e, java.lang.String name) This method checks, whether the (local) tag name of the given element matches the given name.
static boolean	hasTagName(org.w3c.dom.Node n, java.lang.String name) This method checks, whether the (local) tag name of the given element matches the given name.
static boolean	isStreamValid(java.io.InputStream is, javax.xml.validation.Schema schema) Returns whether the given Node is valid against the given Schema.
static boolean	isValid(org.w3c.dom.Node node, javax.xml.validation.Schema schema) Returns whether the given node is valid against the given Schema.
static org.w3c.dom.Element	nextElement(org.w3c.dom.Node node) Find the next element that actually contains data.
static org.w3c.dom.Element	nextElement(org.w3c.dom.Node node, java.lang.String name) Find the next element that actually contains data, with the given name.
static java.lang.String	replaceWithXMLEntities(java.lang.String string) Replaces all occurrences of special characters that may not appear directly in XML (<, >, &, ' and ") with their corresponding XML entities.
static void	validateAndPrintDoc(org.w3c.dom.Node node, javax.xml.validation.Schema schema) Checks, if a node uses a valid schema.
static void	validateDocument(org.w3c.dom.Node node, javax.xml.validation.Schema schema) Checks, if a node uses a valid schema.
static void	validateStream(java.io.InputStream is, javax.xml.validation.Schema schema) Checks, if a node uses a valid schema.
static void	writeDocumentToFile(org.w3c.dom.Node node, java.io.File file, javax.xml.validation.Schema schema) Exports a DOM node to a file, validates the node before the export, if a schema type is provided.
static void	writeDocumentToFile(org.w3c.dom.Node node, java.io.File file, javax.xml.validation.Schema schema, boolean intend) Exports a DOM node to a file, validates the node before the export, if a schema type is provided.
static void	writeDocumentToStream(org.w3c.dom.Node node, java.io.OutputStream out) Writes the node to the given output stream.
static void	writeDocumentToStream(org.w3c.dom.Node node, java.io.OutputStream out, boolean intend) Writes the node to the given output stream.

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING

public static final java.lang.String ENCODING

The encoding that should be used for writing xml files. Some preferable encodings are 'UTF-8', 'UTF-16BE', 'UTF-16LE' or 'ISO-8859-1'

See Also:

for more possible encodings, Constant Field Values

logger

protected static final java.util.logging.Logger logger

The logger instance of this class.

Constructor Detail

XMLHelperTools

public XMLHelperTools()

Method Detail

isValid

public static boolean isValid(org.w3c.dom.Node node,
                              javax.xml.validation.Schema schema)

Returns whether the given node is valid against the given Schema.

Parameters:

node - The node to be validated.

schema - The schema to validate the node against.

Returns:

Whether the given Node is valid against the given Schema.

isStreamValid

public static boolean isStreamValid(java.io.InputStream is,
                                    javax.xml.validation.Schema schema)

Returns whether the given Node is valid against the given Schema.

Parameters:

is - The input stream containing the XML data to be validated.

schema - The schema to validate the node against.

Returns:

Whether the given Node is valid against the given Schema.

validateAndPrintDoc

public static void validateAndPrintDoc(org.w3c.dom.Node node,
                                       javax.xml.validation.Schema schema)
                                throws XMLFormatException,
                                       java.io.IOException

Checks, if a node uses a valid schema. If not the invalid XML will be written to System.out.

Parameters:

node - The node, that wants to be checked.

schema - The Schema, the node has to use, to be valid.

Throws:

XMLFormatException - when the validation fails.

java.io.IOException - when conversion to string representation fails.

validateDocument

public static void validateDocument(org.w3c.dom.Node node,
                                    javax.xml.validation.Schema schema)
                             throws XMLFormatException

Checks, if a node uses a valid schema.

Parameters:

node - The node, that wants to be checked.

schema - The Schema, the node has to use, to be valid.

Throws:

XMLFormatException - when the validation fails

validateStream

public static void validateStream(java.io.InputStream is,
                                  javax.xml.validation.Schema schema)
                           throws XMLFormatException

Checks, if a node uses a valid schema.

Parameters:

is - The input stream containing the XML data.

schema - The Schema, the node has to use, to be valid.

Throws:

XMLFormatException - when the validation fails

replaceWithXMLEntities

public static java.lang.String replaceWithXMLEntities(java.lang.String string)

Replaces all occurrences of special characters that may not appear directly in XML (<, >, &, ' and ") with their corresponding XML entities.

Parameters:

string - the string to be converted

Returns:

the converted string

getDocumentFromString

public static org.w3c.dom.Document getDocumentFromString(java.lang.String string,
                                                         javax.xml.validation.Schema schema)
                                                  throws XMLFormatException,
                                                         java.io.IOException

Parse a string and converts it to a Document.

Parameters:

string - The string, that shall be converted.

schema - The XML Schema to validate the document against or null to omit validation.

Returns:

A DOM document for the XML in the given string.

Throws:

XMLFormatException - if the document is not well-formed

java.io.IOException - if error occurs while reading from the file

getDocumentFromFile

public static org.w3c.dom.Document getDocumentFromFile(java.io.File file,
                                                       javax.xml.validation.Schema schema,
                                                       org.xml.sax.ErrorHandler errorHandler)
                                                throws XMLFormatException,
                                                       java.io.FileNotFoundException,
                                                       java.io.IOException

Read a Document from a stream.

Parameters:

file -

schema - The XML Schema to validate the document against or null to omit validation

errorHandler - The optional error handler that will be used for the document builder

Returns:

A DOM document

Throws:

XMLFormatException - if the document is not well-formed or doesn't conform to the given Schema

java.io.FileNotFoundException - if the file does not exist or can't be opened

java.io.IOException - if error occurs while reading from the file

getDocumentFromStream

public static org.w3c.dom.Document getDocumentFromStream(java.io.InputStream inputStream)
                                                  throws XMLFormatException,
                                                         java.io.IOException

Parse a Stream and converts it to a Document

Parameters:

inputStream - The stream that shall be converted

Returns:

A DOM document for the given input stream.

Throws:

XMLFormatException - if the document is not well-formed

java.io.IOException - if error occurs while reading from the stream

getDocumentFromStream

public static org.w3c.dom.Document getDocumentFromStream(java.io.InputStream inputStream,
                                                         javax.xml.validation.Schema schema,
                                                         org.xml.sax.ErrorHandler errorHandler,
                                                         boolean nsAware)
                                                  throws XMLFormatException,
                                                         java.io.IOException

Read a Document from a file.

Parameters:

inputStream - The InputStream which should be parsed or null.

schema - The XML Schema to validate the document against or null to omit validation.

errorHandler - The optional error handler that will be used for the document builder.

nsAware - Whether the input stream should be parsed namespace aware.

Returns:

A DOM document

Throws:

XMLFormatException - if the document is not well-formed or doesn't conform to the given Schema

java.io.IOException - if error occurs while reading from the stream

createDocument

public static org.w3c.dom.Document createDocument()

Initialises the document object which will be used for constructing elements.

Returns:

The new document

getXMLStringForDocument

public static java.lang.String getXMLStringForDocument(org.w3c.dom.Node node)
                                                throws java.io.IOException

Returns the XML code of a given node as string.

Parameters:

node - The node to be transformed

Returns:

The XML code of the given node as string.

Throws:

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getXMLStringForDocument

public static java.lang.String getXMLStringForDocument(org.w3c.dom.Node node,
                                                       boolean intend)
                                                throws java.io.IOException

Returns the XML code of a given node as string.

Parameters:

node - The node to be transformed

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

The XML code of the given node as string.

Throws:

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getXMLStringForInputStream

public static java.lang.String getXMLStringForInputStream(java.io.InputStream is)
                                                   throws java.io.IOException

Returns the xml code of a given input stream as string.

Parameters:

is - The input stream which should be transformed.

Returns:

The xml code of the given input stream as string.

Throws:

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation

getInputStreamForDocument

public static java.io.InputStream getInputStreamForDocument(org.w3c.dom.Node node)
                                                     throws java.io.IOException

Returns an input stream containing the XML code of the given node.

Parameters:

node - The node to be transformed

Returns:

The input stream of the XML code of the node.

Throws:

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation.

getInputStreamForDocument

public static java.io.InputStream getInputStreamForDocument(org.w3c.dom.Node node,
                                                            boolean intend)
                                                     throws java.io.IOException

Returns an input stream containing the XML code of the given node.

Parameters:

node - The node to be transformed

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

The input stream of the XML code of the node.

Throws:

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation.

getByteArrayForDocument

public static byte[] getByteArrayForDocument(org.w3c.dom.Node node)
                                      throws java.io.IOException

Returns a byte array containing the XML code for the given node.

Parameters:

node - The node to be transformed.

Returns:

The byte array of the node.

Throws:

java.io.IOException

getByteArrayForDocument

public static byte[] getByteArrayForDocument(org.w3c.dom.Node node,
                                             boolean intend)
                                      throws java.io.IOException

Returns a byte array containing the XML code for the given node.

Parameters:

node - The node to be transformed.

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

The byte array of the node.

Throws:

java.io.IOException

getOutputStreamForDocument

public static java.io.ByteArrayOutputStream getOutputStreamForDocument(org.w3c.dom.Node node)
                                                                throws java.io.IOException

Returns an output stream containing the XML code of the given node.

Parameters:

node - The node to be transformed.

Returns:

The output stream of the XML code of the node.

Throws:

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation.

getOutputStreamForDocument

public static java.io.ByteArrayOutputStream getOutputStreamForDocument(org.w3c.dom.Node node,
                                                                       boolean intend)
                                                                throws java.io.IOException

Returns an output stream containing the XML code of the given node.

Parameters:

node - The node to be transformed.

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

The output stream of the XML code of the node.

Throws:

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation.

getOutputStreamForDocument

public static java.io.ByteArrayOutputStream getOutputStreamForDocument(org.w3c.dom.Node node,
                                                                       javax.xml.transform.Source xslt)
                                                                throws java.io.IOException

Returns an output stream containing the XML code of the given node.

Parameters:

node - The node to be transformed.

xslt - The XSLT style sheet that should be used for the transformer.

Returns:

The output stream of the XML code of the node.

Throws:

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation.

getOutputStreamForDocument

public static java.io.ByteArrayOutputStream getOutputStreamForDocument(org.w3c.dom.Node node,
                                                                       javax.xml.transform.Source xslt,
                                                                       boolean intend)
                                                                throws java.io.IOException

Returns an output stream containing the XML code of the given node.

Parameters:

node - The node to be transformed.

xslt - The XSLT style sheet that should be used for the transformer.

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Returns:

The output stream of the XML code of the node.

Throws:

java.io.IOException - Thrown if an unrecoverable error occurs during the course of the transformation.

writeDocumentToStream

public static void writeDocumentToStream(org.w3c.dom.Node node,
                                         java.io.OutputStream out)
                                  throws java.io.IOException

Writes the node to the given output stream.

Parameters:

node -

out -

Throws:

java.io.IOException

writeDocumentToStream

public static void writeDocumentToStream(org.w3c.dom.Node node,
                                         java.io.OutputStream out,
                                         boolean intend)
                                  throws java.io.IOException

Writes the node to the given output stream.

Parameters:

node -

out -

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Throws:

java.io.IOException

writeDocumentToFile

public static void writeDocumentToFile(org.w3c.dom.Node node,
                                       java.io.File file,
                                       javax.xml.validation.Schema schema)
                                throws java.io.IOException,
                                       XMLFormatException

Exports a DOM node to a file, validates the node before the export, if a schema type is provided.

Parameters:

node - The DOM node to be exported.

file - The target file.

schema - The schema for validation, or null for storing w/o validation.

Throws:

java.io.IOException

XMLFormatException - Thrown, if the validation fails.

writeDocumentToFile

public static void writeDocumentToFile(org.w3c.dom.Node node,
                                       java.io.File file,
                                       javax.xml.validation.Schema schema,
                                       boolean intend)
                                throws java.io.IOException,
                                       XMLFormatException

Exports a DOM node to a file, validates the node before the export, if a schema type is provided.

Parameters:

node - The DOM node to be exported.

file - The target file.

schema - The schema for validation, or null for storing w/o validation.

intend - Whether to intend child nodes and text content. Use with care! Text content may contain whitespace and linebreaks afterwards!

Throws:

java.io.IOException

XMLFormatException - Thrown, if the validation fails.

getParsedID

public static int getParsedID(org.w3c.dom.Node node)

Strips off the leading character and parses the integer value.

Parameters:

node - The node whose text content will be parsed.

Returns:

The integer value of the ID.

getParsedID

public static int getParsedID(java.lang.String nodeValue)

Strips off the leading character and parses the integer value.

Parameters:

nodeValue - The input string.

Returns:

The integer value of the ID.

hasTagName

public static boolean hasTagName(org.w3c.dom.Node n,
                                 java.lang.String name)

This method checks, whether the (local) tag name of the given element matches the given name.

Parameters:

n - The node, whose tag name should be checked.

name - The name, against the tag name should be checked.

Returns:

Whether the tag name of the given element equals the given name.

hasTagName

public static boolean hasTagName(org.w3c.dom.Element e,
                                 java.lang.String name)

This method checks, whether the (local) tag name of the given element matches the given name.

Parameters:

e - The element, whose tag name should be checked.

name - The name, against the tag name should be checked.

Returns:

Whether the tag name of the given element equals the given name.

getTagName

protected static java.lang.String getTagName(org.w3c.dom.Element e)

This method returns the tag name of the given element. In case the tag name is prefixed with a name space, the local name will be returned.

Parameters:

e - The element, whose tag name should be returned.

Returns:

The tag name of the given element.

nextElement

public static org.w3c.dom.Element nextElement(org.w3c.dom.Node node,
                                              java.lang.String name)

Find the next element that actually contains data, with the given name.

Parameters:

node - The current node.

name - The name of the next node.

Returns:

The next node of type ELEMENT_NODE with the given name.

nextElement

public static org.w3c.dom.Element nextElement(org.w3c.dom.Node node)

Find the next element that actually contains data.

Parameters:

node - The current node.

Returns:

The next node of type ELEMENT_NODE.

getElement

public static org.w3c.dom.Element getElement(org.w3c.dom.Node node)

Finds an DOM Element for a given Node. If the given DOM Node is an Element, it is returned as Element. Else its next sibling is returned recursively as element.

Parameters:

node - the DOM object

Returns:

A DOM Element.