net.sf.jasperreports.engine.util.xml

Interface JRXPathExecuter

All Known Implementing Classes:

JaxenNsAwareXPathExecuter, JaxenXPathExecuter, XalanNsAwareXPathExecuter, XalanXPathExecuter

public interface JRXPathExecuter

An XPath expression executer.

XML data sources delegate XPath executions to implementations of this interface.

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

See Also:

JRXPathExecuterFactory, JRXPathExecuterUtils

Method Summary

Methods

Modifier and Type	Method and Description
NodeList	selectNodeList(Node contextNode, String expression) Selects a node list by evaluating an XPath expression on a context node.
Object	selectObject(Node contextNode, String expression) Selects an object by evaluating an XPath expression on a context node.

Method Detail

selectNodeList

NodeList selectNodeList(Node contextNode,
                      String expression)
                        throws JRException

Selects a node list by evaluating an XPath expression on a context node.

Parameters:

contextNode - the context node (a document can also be used)

expression - the XPath expression

Returns:

the selected node list

Throws:

JRException - if the XPath evaluation failed

selectObject

Object selectObject(Node contextNode,
                  String expression)
                    throws JRException

Selects an object by evaluating an XPath expression on a context node.

If the expression evaluates to a node list, the first node in the list should be returned. Otherwise, the primitive value resulted from the evaluation should be returned as a java.lang.String, java.lang.Number or java.lang.Boolean.

Parameters:

contextNode - the context node (a document can also be used)

expression - the XPath expression

Returns:

the selected node or value

Throws:

JRException - if the XPath evaluation failed