weave.utils

Class XMLUtils

java.lang.Object

weave.utils.XMLUtils

public class XMLUtils
extends java.lang.Object

This class contains functions to convert between String and XML Document objects.

Author:

Andy Dufilie

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static org.w3c.dom.Node	appendTextNode(org.w3c.dom.Node parent, java.lang.String child)
static org.w3c.dom.Node	appendXMLChildFromString(org.w3c.dom.Node parent, java.lang.String child)
static java.lang.String	escapeSpecialCharacters(java.lang.String str)
static java.lang.String	getStringFromXML(org.w3c.dom.Node node)
static java.lang.String	getStringFromXML(org.w3c.dom.Node node, java.lang.String dtdFilename)
static void	getStringFromXML(org.w3c.dom.Node node, java.lang.String dtdFilename, java.lang.String outputFileName)
static void	getStringFromXML(org.w3c.dom.Node node, java.lang.String dtdFilename, java.io.Writer outputWriter)
static java.lang.String	getStringFromXPath(org.w3c.dom.Document doc, javax.xml.xpath.XPath xpath, java.lang.String expression) Gets a string from an xml.
static java.util.List<java.lang.String>	getStringListFromXPath(org.w3c.dom.Document doc, javax.xml.xpath.XPath xpath, java.lang.String rootNodeExpression, java.lang.String listExpression) Gets a list of strings from an xml.
static java.util.List<java.lang.String>	getStringListFromXPath(org.w3c.dom.Node rootNode, javax.xml.xpath.XPath xpath, java.lang.String listExpression) Gets a list of strings from an xml.
static org.w3c.dom.Document	getValidatedXMLFromFile(java.io.File xmlFile)
static org.w3c.dom.Document	getValidatedXMLFromFile(java.lang.String xmlFile)
static org.w3c.dom.Document	getValidatedXMLFromStream(java.io.InputStream is)
static org.w3c.dom.Document	getValidatedXMLFromString(java.lang.String str)
static org.w3c.dom.Document	getXMLFromFile(java.io.File file)
static org.w3c.dom.Document	getXMLFromString(java.lang.String str) This function does not support validation via DTD.
static org.w3c.dom.Node	insertTextNodeAfter(java.lang.String text, org.w3c.dom.Node sibling)
static org.w3c.dom.Node	insertTextNodeBefore(java.lang.String text, org.w3c.dom.Node sibling)
static org.w3c.dom.Node	prependXMLChildFromString(org.w3c.dom.Node parent, java.lang.String child)
static void	validate(org.w3c.dom.Node node, java.lang.String dtdFilename)
static void	writeXML(org.w3c.dom.Node node, java.lang.String dtdFilename, java.lang.String outputFileName)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

escapeSpecialCharacters

public static java.lang.String escapeSpecialCharacters(java.lang.String str)

Parameters:

str - A String that will be inserted into XML.

Returns:

The String with special characters escaped.

getStringFromXPath

public static java.lang.String getStringFromXPath(org.w3c.dom.Document doc,
                                  javax.xml.xpath.XPath xpath,
                                  java.lang.String expression)

Gets a string from an xml.

Parameters:

expression - The XPath expression to evaluate, returns a string

Returns:

The result of evaluating the given XPath expression.

getStringListFromXPath

public static java.util.List<java.lang.String> getStringListFromXPath(org.w3c.dom.Document doc,
                                                      javax.xml.xpath.XPath xpath,
                                                      java.lang.String rootNodeExpression,
                                                      java.lang.String listExpression)

Gets a list of strings from an xml.

Parameters:

rootNodeExpression - Evaluated on the root of the sqlconfig document to get a single Node.

listExpression - Evaluated on the Node returned by rootNodeExpression, gets a NodeList.

Returns:

A list of the text contents of the NodeList returned by evaluating the listExpression.

getStringListFromXPath

public static java.util.List<java.lang.String> getStringListFromXPath(org.w3c.dom.Node rootNode,
                                                      javax.xml.xpath.XPath xpath,
                                                      java.lang.String listExpression)

Gets a list of strings from an xml.

Parameters:

rootNode - The root node to perform the listExpression on.

listExpression - Evaluated on the rootNode, gets a NodeList.

Returns:

A list of the text contents of the nodes returned by evaluating the listExpression.

insertTextNodeBefore

public static org.w3c.dom.Node insertTextNodeBefore(java.lang.String text,
                                    org.w3c.dom.Node sibling)

insertTextNodeAfter

public static org.w3c.dom.Node insertTextNodeAfter(java.lang.String text,
                                   org.w3c.dom.Node sibling)

appendTextNode

public static org.w3c.dom.Node appendTextNode(org.w3c.dom.Node parent,
                              java.lang.String child)

prependXMLChildFromString

public static org.w3c.dom.Node prependXMLChildFromString(org.w3c.dom.Node parent,
                                         java.lang.String child)
                                                  throws javax.xml.parsers.ParserConfigurationException,
                                                         org.xml.sax.SAXException,
                                                         java.io.IOException

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

appendXMLChildFromString

public static org.w3c.dom.Node appendXMLChildFromString(org.w3c.dom.Node parent,
                                        java.lang.String child)
                                                 throws javax.xml.parsers.ParserConfigurationException,
                                                        org.xml.sax.SAXException,
                                                        java.io.IOException

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getValidatedXMLFromStream

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

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getXMLFromFile

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

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getValidatedXMLFromString

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

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getValidatedXMLFromFile

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

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getValidatedXMLFromFile

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

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

validate

public static void validate(org.w3c.dom.Node node,
            java.lang.String dtdFilename)
                     throws javax.xml.parsers.ParserConfigurationException,
                            org.xml.sax.SAXException,
                            java.io.IOException,
                            javax.xml.transform.TransformerException

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

javax.xml.transform.TransformerException

getXMLFromString

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

This function does not support validation via DTD.

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getStringFromXML

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

Throws:

javax.xml.transform.TransformerException

getStringFromXML

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

Throws:

javax.xml.transform.TransformerException

writeXML

public static void writeXML(org.w3c.dom.Node node,
            java.lang.String dtdFilename,
            java.lang.String outputFileName)
                     throws javax.xml.transform.TransformerException,
                            java.io.IOException

Throws:

javax.xml.transform.TransformerException

java.io.IOException

getStringFromXML

public static void getStringFromXML(org.w3c.dom.Node node,
                    java.lang.String dtdFilename,
                    java.lang.String outputFileName)
                             throws javax.xml.transform.TransformerException,
                                    java.io.IOException

Throws:

javax.xml.transform.TransformerException

java.io.IOException

getStringFromXML

public static void getStringFromXML(org.w3c.dom.Node node,
                    java.lang.String dtdFilename,
                    java.io.Writer outputWriter)
                             throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException