net.obvj.jep.util

Class XmlUtils

java.lang.Object

net.obvj.jep.util.XmlUtils

public class XmlUtils
extends Object

Utility methods for working with XML and XPath

Author:

oswaldo.bapvic.jr

Method Summary

Modifier and Type	Method and Description
static List<Object>	asList(NodeList n)
static XPathExpression	compileXPath(String expression) Compiles the given XPath expression.
static Document	convertToXML(Object object) Converts an object into an XML Document.
static Document	convertToXML(String xmlContent) Converts a String to an XML Document.
static NodeList	evaluateXPath(Document xmlDocument, String expression) Returns a list of XML nodes that match the given XPath expression.
static NodeList	evaluateXPath(String xmlContent, String expression) Returns a list of XML nodes that match the given XPath expression.
static List<Object>	evaluateXPathAsObjectList(Document xmlDocument, String expression) Returns a list of Objects that match the given XPath expression.
static List<Object>	evaluateXPathAsObjectList(String xmlContent, String expression) Returns a list of Objects that match the given XPath expression.

Methods inherited from class java.lang.Object

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

Method Detail

compileXPath

public static XPathExpression compileXPath(String expression)
                                    throws XPathExpressionException

Compiles the given XPath expression.

Parameters:

expression - the XPath expression to be compiled

Returns:

an XPathExpression object that can be used for further evaluation

Throws:

XPathExpressionException - if the expression cannot be compiled

evaluateXPath

public static NodeList evaluateXPath(Document xmlDocument,
                                     String expression)
                              throws XPathExpressionException

Returns a list of XML nodes that match the given XPath expression.

Parameters:

xmlDocument - the XML object to be evaluated

expression - the XPath expression to be used for evaluation

Returns:

A list of XML nodes that match the given XPath expression or null if the XML Document is null.

Throws:

XPathExpressionException - if the expression cannot be evaluated.

evaluateXPath

public static NodeList evaluateXPath(String xmlContent,
                                     String expression)
                              throws XPathExpressionException,
                                     ParserConfigurationException,
                                     SAXException,
                                     IOException

Returns a list of XML nodes that match the given XPath expression.

Parameters:

xmlContent - a string in XML format representing the content to be evaluated

expression - the XPath expression to be used for evaluation

Returns:

a list of XML nodes that match the given XPath expression or null if the XML content is null.

Throws:

XPathExpressionException - if the expression cannot be compiled.

SAXException - if any error occurs trying to parse the XML content string

IOException - if the input string cannot be converted

ParserConfigurationException - if a DocumentBuilder cannot be created

evaluateXPathAsObjectList

public static List<Object> evaluateXPathAsObjectList(Document xmlDocument,
                                                     String expression)
                                              throws XPathExpressionException

Returns a list of Objects that match the given XPath expression.

Parameters:

xmlDocument - the XML object to be evaluated

expression - the XPath expression to be used for evaluation

Returns:

A list of Objects that match the given XPath expression or null if the XML Document is null.

Throws:

XPathExpressionException - If the expression cannot be compiled.

evaluateXPathAsObjectList

public static List<Object> evaluateXPathAsObjectList(String xmlContent,
                                                     String expression)
                                              throws XPathExpressionException,
                                                     ParserConfigurationException,
                                                     SAXException,
                                                     IOException

Returns a list of Objects that match the given XPath expression.

Parameters:

xmlContent - a string in XML format representing the content to be evaluated

expression - the XPath expression to be used for evaluation

Returns:

The value that matches the given XPath expression or null if the XML Document is null.

Throws:

XPathExpressionException - if the expression cannot be compiled.

SAXException - if any parse error occurs trying to parse the XML content string

IOException - if the input string cannot be converted

ParserConfigurationException - if a DocumentBuilder cannot be created

asList

public static List<Object> asList(NodeList n)

convertToXML

public static Document convertToXML(Object object)
                             throws ParserConfigurationException,
                                    SAXException,
                                    IOException

Converts an object into an XML Document.

Parameters:

object - the object to be converted in to an XML Document

Returns:

the object as an XML Document

Throws:

ParserConfigurationException - if a DocumentBuilder cannot be created

SAXException - if any parse error occurs

IOException - if the input string cannot be converted

convertToXML

public static Document convertToXML(String xmlContent)
                             throws ParserConfigurationException,
                                    SAXException,
                                    IOException

Converts a String to an XML Document.

Parameters:

xmlContent - the object to be converted in to an XML Document

Returns:

the object as an XML Document

Throws:

ParserConfigurationException - if a DocumentBuilder cannot be created

SAXException - if any parse error occurs

IOException - if the input string cannot be converted