org.yawlfoundation.yawl.util

Class DOMUtil

java.lang.Object

org.yawlfoundation.yawl.util.DOMUtil

public class DOMUtil
extends java.lang.Object

This class provides helper methods to perform common DOM related tasks.

Author:

Mike Fowler Date: Oct 25, 2005

Constructor Summary

Constructors

Constructor and Description
DOMUtil()

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Node	alphabetiseChildNodes(org.w3c.dom.Node root) Alphabetises the top level children of the node root.
static org.w3c.dom.Document	createDocumentInstance() Creates a new, namespace aware, Document node
static org.w3c.dom.Document	createNamespacelessDocumentInstance() Creates a new, namespace aware, Document node
static org.xml.sax.InputSource	createUTF8InputSource(org.w3c.dom.Node node) Converts a Document dom into an Input source with UTF-8 encoding
static org.xml.sax.InputSource	createUTF8InputSource(java.lang.String xml) Converts a XML String into an Input source with UTF-8 encoding
static java.lang.String	formatXMLStringForDisplay(java.lang.String xml) Formats a string of XML suitable for standard display (ie.
static java.lang.String	formatXMLStringForDisplay(java.lang.String xml, boolean omitDeclaration) Formats a string of XML suitable for standard display (ie.
static org.w3c.dom.Document	getDocumentFromString(java.lang.String xml) Converts a xml String to a DOM Document
static org.w3c.dom.Document	getNamespacelessDocumentFromDocument(org.w3c.dom.Document dom)
static org.w3c.dom.Document	getNamespacelessDocumentFromString(java.lang.String xml)
static java.lang.String	getNodeText(org.w3c.dom.Node node) Extracts to text from the supplied node and it's children.
static java.lang.String	getXMLStringFragmentFromNode(org.w3c.dom.Node node) Takes the supplied node as the root of an xml document and converts it to a String representation.
static java.lang.String	getXMLStringFragmentFromNode(org.w3c.dom.Node node, boolean omitDeclaration) Takes the supplied node as the root of an xml document and converts it to a String representation.
static java.lang.String	getXMLStringFragmentFromNode(org.w3c.dom.Node node, boolean omitDeclaration, boolean collapseEmptyTags) Takes the supplied node as the root of an xml document and converts it to a String representation.
static java.lang.String	getXMLStringFragmentFromNode(org.w3c.dom.Node node, boolean omitDeclaration, java.lang.String encoding) Takes the supplied node as the root of an xml document and converts it to a String representation.
static java.lang.String	getXMLStringFragmentFromNode(org.w3c.dom.Node node, boolean omitDeclaration, java.lang.String encoding, boolean collapseEmptyTags) Takes the supplied node as the root of an xml document and converts it to a String representation.
static java.lang.String	getXMLStringFragmentFromNode(org.w3c.dom.Node node, java.lang.String encoding) Takes the supplied node as the root of an xml document and converts it to a String representation.
static void	removeAllAttributes(org.w3c.dom.Element element)
static void	removeAllChildNodes(org.w3c.dom.Node node) Removes all child nodes from the context Node node.
static org.w3c.dom.Node	removeEmptyElements(org.w3c.dom.Node node) Deprecated.
static org.w3c.dom.Document	removeEmptyNodes(org.w3c.dom.Node node)
static org.w3c.dom.NodeList	selectNodeList(org.w3c.dom.Node node, java.lang.String expression)
static java.lang.String	selectNodeText(org.w3c.dom.Node node, java.lang.String expression)
static org.w3c.dom.Node	selectSingleNode(org.w3c.dom.Node node, java.lang.String expression)

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMUtil

public DOMUtil()

Method Detail

getDocumentFromString

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

Converts a xml String to a DOM Document

Parameters:

xml - to be parsed

Returns:

DOM Document representation of XML.

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

createDocumentInstance

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

Creates a new, namespace aware, Document node

Returns:

the created DOM Document, otherwise return null

Throws:

javax.xml.parsers.ParserConfigurationException

createNamespacelessDocumentInstance

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

Creates a new, namespace aware, Document node

Returns:

the created DOM Document, otherwise return null

Throws:

javax.xml.parsers.ParserConfigurationException

getNamespacelessDocumentFromDocument

public static org.w3c.dom.Document getNamespacelessDocumentFromDocument(org.w3c.dom.Document dom)
                                                                 throws javax.xml.transform.TransformerException,
                                                                        java.io.IOException,
                                                                        javax.xml.parsers.ParserConfigurationException,
                                                                        org.xml.sax.SAXException

Throws:

javax.xml.transform.TransformerException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

getNamespacelessDocumentFromString

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

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getNodeText

public static java.lang.String getNodeText(org.w3c.dom.Node node)

Extracts to text from the supplied node and it's children.

Parameters:

node - to extract text from.

Returns:

String representation of the node text.

getXMLStringFragmentFromNode

public static java.lang.String getXMLStringFragmentFromNode(org.w3c.dom.Node node)
                                                     throws javax.xml.transform.TransformerException

Takes the supplied node as the root of an xml document and converts it to a String representation. The xml header is omitted.

Parameters:

node - to convert to a String

Returns:

String XML fragment.

Throws:

javax.xml.transform.TransformerException

getXMLStringFragmentFromNode

public static java.lang.String getXMLStringFragmentFromNode(org.w3c.dom.Node node,
                                                            java.lang.String encoding)
                                                     throws javax.xml.transform.TransformerException

Takes the supplied node as the root of an xml document and converts it to a String representation. The xml header is omitted.

Parameters:

node - to convert to a String

encoding - Target encoding of output XML

Returns:

String XML fragment.

Throws:

javax.xml.transform.TransformerException

getXMLStringFragmentFromNode

public static java.lang.String getXMLStringFragmentFromNode(org.w3c.dom.Node node,
                                                            boolean omitDeclaration)
                                                     throws javax.xml.transform.TransformerException

Takes the supplied node as the root of an xml document and converts it to a String representation.

Parameters:

node - to convert to a String

omitDeclaration - set to false to include the <? xml ?> declaration

Returns:

String XML fragment.

Throws:

javax.xml.transform.TransformerException

getXMLStringFragmentFromNode

public static java.lang.String getXMLStringFragmentFromNode(org.w3c.dom.Node node,
                                                            boolean omitDeclaration,
                                                            java.lang.String encoding)
                                                     throws javax.xml.transform.TransformerException

Takes the supplied node as the root of an xml document and converts it to a String representation.

Parameters:

node - to convert to a String

omitDeclaration - set to false to include the <? xml ?> declaration

encoding - Target encoding of output XML

Returns:

String XML fragment.

Throws:

javax.xml.transform.TransformerException

getXMLStringFragmentFromNode

public static java.lang.String getXMLStringFragmentFromNode(org.w3c.dom.Node node,
                                                            boolean omitDeclaration,
                                                            boolean collapseEmptyTags)
                                                     throws javax.xml.transform.TransformerException

Takes the supplied node as the root of an xml document and converts it to a String representation.

Parameters:

node - to convert to a String

omitDeclaration - set to false to include the <? xml ?> declaration

collapseEmptyTags - set to false to use the long form of xml tags (ie. <a></a>)

Returns:

String XML fragment.

Throws:

javax.xml.transform.TransformerException

getXMLStringFragmentFromNode

public static java.lang.String getXMLStringFragmentFromNode(org.w3c.dom.Node node,
                                                            boolean omitDeclaration,
                                                            java.lang.String encoding,
                                                            boolean collapseEmptyTags)
                                                     throws javax.xml.transform.TransformerException

Takes the supplied node as the root of an xml document and converts it to a String representation.

Parameters:

node - to convert to a String

omitDeclaration - set to false to include the <? xml ?> declaration

encoding - Target encoding of output XML

collapseEmptyTags - set to false to use the long form of xml tags (ie. <a></a>)

Returns:

String XML fragment.

Throws:

javax.xml.transform.TransformerException

removeEmptyNodes

public static org.w3c.dom.Document removeEmptyNodes(org.w3c.dom.Node node)
                                             throws java.io.IOException,
                                                    javax.xml.transform.TransformerException,
                                                    org.xml.sax.SAXException,
                                                    javax.xml.parsers.ParserConfigurationException

Throws:

java.io.IOException

javax.xml.transform.TransformerException

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

removeEmptyElements

public static org.w3c.dom.Node removeEmptyElements(org.w3c.dom.Node node)
                                            throws javax.xml.xpath.XPathExpressionException

Deprecated.

Takes the supplied node and recursively removes empty (no content/child nodes) elements

Parameters:

node - to remove all empty elements from

Returns:

Trimmed node

Throws:

javax.xml.xpath.XPathExpressionException

selectSingleNode

public static org.w3c.dom.Node selectSingleNode(org.w3c.dom.Node node,
                                                java.lang.String expression)
                                         throws javax.xml.xpath.XPathExpressionException

Throws:

javax.xml.xpath.XPathExpressionException

selectNodeText

public static java.lang.String selectNodeText(org.w3c.dom.Node node,
                                              java.lang.String expression)
                                       throws javax.xml.xpath.XPathExpressionException

Throws:

javax.xml.xpath.XPathExpressionException

selectNodeList

public static org.w3c.dom.NodeList selectNodeList(org.w3c.dom.Node node,
                                                  java.lang.String expression)
                                           throws javax.xml.xpath.XPathExpressionException

Throws:

javax.xml.xpath.XPathExpressionException

formatXMLStringForDisplay

public static java.lang.String formatXMLStringForDisplay(java.lang.String xml)

Formats a string of XML suitable for standard display (ie. no xml directive and idented). If the formatting fails, the original XML string is returned unaltered.

Parameters:

xml - to format for display

Returns:

formatted xml if no exceptions occured, otherwise original string.

formatXMLStringForDisplay

public static java.lang.String formatXMLStringForDisplay(java.lang.String xml,
                                                         boolean omitDeclaration)

Formats a string of XML suitable for standard display (ie. no xml directive and idented). If the formatting fails, the original XML string is returned unaltered.

Parameters:

xml - to format for display

Returns:

formatted xml if no exceptions occured, otherwise original string.

removeAllChildNodes

public static void removeAllChildNodes(org.w3c.dom.Node node)

Removes all child nodes from the context Node node.

Parameters:

node - to remove all children from

removeAllAttributes

public static void removeAllAttributes(org.w3c.dom.Element element)

createUTF8InputSource

public static org.xml.sax.InputSource createUTF8InputSource(java.lang.String xml)
                                                     throws java.io.UnsupportedEncodingException

Converts a XML String into an Input source with UTF-8 encoding

Parameters:

xml -

Returns:

an instantiated InputSource

Throws:

java.io.UnsupportedEncodingException

createUTF8InputSource

public static org.xml.sax.InputSource createUTF8InputSource(org.w3c.dom.Node node)
                                                     throws java.io.UnsupportedEncodingException,
                                                            javax.xml.transform.TransformerException

Converts a Document dom into an Input source with UTF-8 encoding

Parameters:

node -

Returns:

an instantiated InputSource

Throws:

java.io.UnsupportedEncodingException

javax.xml.transform.TransformerException

alphabetiseChildNodes

public static org.w3c.dom.Node alphabetiseChildNodes(org.w3c.dom.Node root)
                                              throws javax.xml.xpath.XPathExpressionException

Alphabetises the top level children of the node root.

Parameters:

root -

Returns:

The alphabetised root node.

Throws:

javax.xml.xpath.XPathExpressionException