io.inbot.xmltools

Class XPathBrowser

java.lang.Object

io.inbot.xmltools.XPathBrowser

public class XPathBrowser
extends Object

Simple browser abstraction over XML documents that allows you to browse the XML document using xpath expressions against a current node. It reuses xpath expressions using the XPathExpressionCache. This is a lot faster than recompiling the expressions every time. Note, you should use the XPathBrowserFactory for creating instances. Note, this class does not support namespaces currently. TODO: check here for potential solution http://blog.davber.com/2006/09/17/xpath-with-namespaces-in-java/

Method Summary

Modifier and Type	Method and Description
XPathBrowser	browse(Node node)
XPathBrowser	browseFirst(String expression)
Iterator<XPathBrowser>	browseMatching(Node n, String expr)
Iterable<XPathBrowser>	browseMatching(String expr)
Iterable<XPathBrowser>	browseSubNodes()
Object	eval(String expr, Node node, QName resultType) Efficient xpath expression evaluator that uses the XPathExpressionCache.
Optional<BigDecimal>	getBigDecimal(Locale locale, Node n, String expr)
Optional<BigDecimal>	getBigDecimal(Locale locale, String expr)
Optional<BigInteger>	getBigInteger(Node n, String expr)
Optional<BigInteger>	getBigInteger(String expr)
boolean	getBoolean()
boolean	getBoolean(Node n, String expr) Evaluate expression to a boolean value.
boolean	getBoolean(String expr) Evaluate expression to a boolean value.
Optional<Double>	getDouble()
Optional<Double>	getDouble(Node n, String expr) Evaluate expression to a double value.
Optional<Double>	getDouble(String expr) Evaluate expression to a double value.
Optional<Node>	getFirstNode(Node n, String expr)
Optional<Node>	getFirstNode(String expr)
Optional<Integer>	getInt()
Optional<Integer>	getInt(Node n, String expr) Evaluate expression to a int value.
Optional<Integer>	getInt(String expr) Evaluate expression to a int value.
Optional<Long>	getLong()
Optional<Long>	getLong(Node n, String expr) Evaluate expression to a long value.
Optional<Long>	getLong(String expr) Evaluate expression to a long value.
Optional<String>	getNodeAttribute(String key)
NodeList	getNodeList(Node n, String expr) Evaluate an expression that should result in a Node set (relative to the provided node).
NodeList	getNodeList(String expr) Evaluate an expression that should result in a Node set (relative to the root).
Optional<Number>	getNumber(Locale locale, Node n, String expr)
Optional<Number>	getNumber(Locale locale, String expr)
Optional<String>	getString()
Optional<String>	getString(Node n, String expr) Evaluate an expression that should result in a String (relative to the provided node).
Optional<String>	getString(String expr) Evaluate an expression that should result in a String (relative to the root).
String[]	getStringValues(Node n, String expr) Get array of values that match specified expression.
String[]	getStringValues(String expr) Get array of values that match specified expression.
Node	getSubNode(Node parent, String name) Get a named sub node from the parent.
Node	node()
Map<String,String>	nodeAttributes()
java.util.stream.Stream<XPathBrowser>	streamMatching(String expr)
java.util.stream.Stream<XPathBrowser>	streamSubNodes()

Methods inherited from class java.lang.Object

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

Method Detail

eval

public Object eval(String expr,
                   Node node,
                   QName resultType)

Efficient xpath expression evaluator that uses the XPathExpressionCache. Use this if none of the other methods do what you need.

Parameters:

expr - expr

node - node

resultType - type

Returns:

DOM object of the specified type or null.

getBoolean

public boolean getBoolean(Node n,
                          String expr)

Evaluate expression to a boolean value.

Parameters:

n - node from which the (relative) expression is evaluated.

expr - xpath expression.

Returns:

result of the expression or false if the node was absent or empty.

getBoolean

public boolean getBoolean(String expr)

Evaluate expression to a boolean value.

Parameters:

expr - xpath expression.

Returns:

result of the expression.

getBoolean

public boolean getBoolean()

Returns:

current node as a boolean

getDouble

public Optional<Double> getDouble(Node n,
                                  String expr)

Evaluate expression to a double value.

Parameters:

n - node from which the (relative) expression is evaluated.

expr - xpath expression.

Returns:

result of the expression.

getDouble

public Optional<Double> getDouble(String expr)

Evaluate expression to a double value.

Parameters:

expr - xpath expression.

Returns:

result of the expression.

getDouble

public Optional<Double> getDouble()

Returns:

current node as a double.

getInt

public Optional<Integer> getInt(Node n,
                                String expr)

Evaluate expression to a int value.

Parameters:

n - node from which the (relative) expression is evaluated.

expr - xpath expression.

Returns:

result of the expression.

getInt

public Optional<Integer> getInt(String expr)

Evaluate expression to a int value.

Parameters:

expr - xpath expression.

Returns:

result of the expression.

getInt

public Optional<Integer> getInt()

Returns:

current node as an int

getNumber

public Optional<Number> getNumber(Locale locale,
                                  String expr)

getNumber

public Optional<Number> getNumber(Locale locale,
                                  Node n,
                                  String expr)

getBigDecimal

public Optional<BigDecimal> getBigDecimal(Locale locale,
                                          String expr)

getBigDecimal

public Optional<BigDecimal> getBigDecimal(Locale locale,
                                          Node n,
                                          String expr)

getBigInteger

public Optional<BigInteger> getBigInteger(String expr)

getBigInteger

public Optional<BigInteger> getBigInteger(Node n,
                                          String expr)

getLong

public Optional<Long> getLong(Node n,
                              String expr)

Evaluate expression to a long value.

Parameters:

n - node from which the (relative) expression is evaluated.

expr - xpath expression.

Returns:

result of the expression.

getLong

public Optional<Long> getLong(String expr)

Evaluate expression to a long value.

Parameters:

expr - xpath expression.

Returns:

result of the expression.

getLong

public Optional<Long> getLong()

Returns:

current node as a long

getString

public Optional<String> getString(Node n,
                                  String expr)

Evaluate an expression that should result in a String (relative to the provided node).

Parameters:

n - node from which the (relative) expression is evaluated.

expr - xpath expression.

Returns:

result of the expression.

getString

public Optional<String> getString(String expr)

Evaluate an expression that should result in a String (relative to the root).

Parameters:

expr - xpath expression.

Returns:

result of the expression.

getString

public Optional<String> getString()

Returns:

current node as a String

getFirstNode

public Optional<Node> getFirstNode(String expr)

Parameters:

expr - expression

Returns:

the first node that matches the expression

Throws:

IllegalArgumentException - if the node does not exist

getFirstNode

public Optional<Node> getFirstNode(Node n,
                                   String expr)

Parameters:

n - node

expr - expression

Returns:

the first node that matches the expression

Throws:

IllegalArgumentException - if the node does not exist

getNodeList

public NodeList getNodeList(Node n,
                            String expr)

Evaluate an expression that should result in a Node set (relative to the provided node).

Parameters:

n - node from which the (relative) expression is evaluated.

expr - expr xpath expression.

Returns:

a list of Nodes matching the expression.

getNodeList

public NodeList getNodeList(String expr)

Evaluate an expression that should result in a Node set (relative to the root).

Parameters:

expr - xpath expression.

Returns:

a list of nodes matching the expression

getStringValues

public String[] getStringValues(Node n,
                                String expr)

Get array of values that match specified expression.

Parameters:

n - node from which the (relative) expression is evaluated.

expr - xpath expression.

Returns:

array with matching values

getStringValues

public String[] getStringValues(String expr)

Get array of values that match specified expression.

Parameters:

expr - xpath expression.

Returns:

array with matching values

getSubNode

public Node getSubNode(Node parent,
                       String name)

Get a named sub node from the parent.

Parameters:

parent - parent node

name - name

Returns:

a Node instance

node

public Node node()

Returns:

the current node; expressions are evaluated relative to this node.

getNodeAttribute

public Optional<String> getNodeAttribute(String key)

nodeAttributes

public Map<String,String> nodeAttributes()

browse

public XPathBrowser browse(Node node)

browseFirst

public XPathBrowser browseFirst(String expression)

streamSubNodes

public java.util.stream.Stream<XPathBrowser> streamSubNodes()

streamMatching

public java.util.stream.Stream<XPathBrowser> streamMatching(String expr)

browseSubNodes

public Iterable<XPathBrowser> browseSubNodes()

browseMatching

public Iterable<XPathBrowser> browseMatching(String expr)

browseMatching

public Iterator<XPathBrowser> browseMatching(Node n,
                                             String expr)