org.gesis.commons.xml

Class XMLDocument

java.lang.Object

org.gesis.commons.xml.XMLDocument

public class XMLDocument
extends Object

Abstracts a Document and provides easy-to-use XPath APIs using a single object.

The XMLDocument class is not thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLDocument.Builder

Method Summary

Modifier and Type	Method and Description
static XMLDocument	createDocumentFromElement(Element element) Create a new XML document using the specified Element as the root node.
Optional<org.gesis.commons.xml.LocationInfo>	getLocationInfo(Node node)
String	getNamespace() The namespace of the root element of the document.
static XMLDocument.Builder	newBuilder()
Node	selectNode(Node context, String xPath) Select a Node by evaluating a XPath expression using the provided node as a context the XPath expression will be evaluated in.
Node	selectNode(String xPath) Select a Node by evaluating a XPath expression using the document element as the context the XPath will be evaluated in.
List<Node>	selectNodes(Node context, String xPath) Select a list of Nodes by evaluating a XPath expression using the provided node as a context the XPath expression will be evaluated in.
List<Node>	selectNodes(String xPath) Select a list of Nodes by evaluating a XPath expression using the document element as the context the XPath will be evaluated in.
void	setNamespaceContext(NamespaceContext namespaceContext)
void	setRootElement(String xPath, NamespaceContext nsContext) Set the root of the document to the element located at the given XPath.

Methods inherited from class java.lang.Object

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

Method Detail

setNamespaceContext

public void setNamespaceContext(NamespaceContext namespaceContext)

setRootElement

public void setRootElement(String xPath,
                           NamespaceContext nsContext)
                    throws XPathExpressionException,
                           NoSuchNodeException

Set the root of the document to the element located at the given XPath. The document is modified by this method.

Parameters:

xPath - the XPath of the element that should become the root.

nsContext - the namespace context of the XPath.

Throws:

XPathExpressionException - if the XPath cannot be evaluated.

NoSuchNodeException - if the XPath does not resolve an Element.

createDocumentFromElement

public static XMLDocument createDocumentFromElement(Element element)

Create a new XML document using the specified Element as the root node.

The element and all its descendants are adopted into the new document and will be removed from the source document.

Parameters:

element - the root element.

Returns:

a new document with the element as the root node.

selectNode

public Node selectNode(String xPath)
                throws XPathExpressionException

Select a Node by evaluating a XPath expression using the document element as the context the XPath will be evaluated in.

Parameters:

xPath - the XPath expression to evaluate.

Returns:

the first matching node, or null if no nodes matched.

Throws:

XPathExpressionException - if the XPath expression cannot be compiled.

selectNode

public Node selectNode(Node context,
                       String xPath)
                throws XPathExpressionException

Select a Node by evaluating a XPath expression using the provided node as a context the XPath expression will be evaluated in.

Parameters:

context - the context the XPath expression will be evaluated in.

xPath - the XPath expression to evaluate.

Returns:

the first matching node, or null if no nodes matched.

Throws:

XPathExpressionException - if the XPath expression cannot be compiled.

selectNodes

public List<Node> selectNodes(Node context,
                              String xPath)
                       throws XPathExpressionException

Select a list of Nodes by evaluating a XPath expression using the provided node as a context the XPath expression will be evaluated in.

Parameters:

context - the context the XPath expression will be evaluated in.

xPath - the XPath expression to evaluate.

Returns:

a list of matching nodes.

Throws:

XPathExpressionException - if the XPath expression cannot be compiled.

selectNodes

public List<Node> selectNodes(String xPath)
                       throws XPathExpressionException

Select a list of Nodes by evaluating a XPath expression using the document element as the context the XPath will be evaluated in.

Parameters:

xPath - the XPath expression to evaluate.

Returns:

a list of matching nodes.

Throws:

XPathExpressionException - if the XPath expression cannot be compiled.

getLocationInfo

public Optional<org.gesis.commons.xml.LocationInfo> getLocationInfo(Node node)

getNamespace

public String getNamespace()

The namespace of the root element of the document.

newBuilder

public static XMLDocument.Builder newBuilder()