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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMLDocument.Builder

Method Summary

Modifier and Type	Method and Description
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)
Node	selectNode(String xPath)
List<Node>	selectNodes(Node context, String locationPath)
List<Node>	selectNodes(String xPath)
void	setNamespaceContext(NamespaceContext namespaceContext)
void	setRootElement(String location, 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 location,
                           NamespaceContext nsContext)
                    throws XPathExpressionException

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

Parameters:

location - 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.

selectNode

public Node selectNode(String xPath)
                throws XPathExpressionException

Throws:

XPathExpressionException

selectNode

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

Throws:

XPathExpressionException

selectNodes

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

Throws:

XPathExpressionException

selectNodes

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

Throws:

XPathExpressionException

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()