org.mule.module.xml.xpath

Interface XPathEvaluator

All Known Implementing Classes:

JaxpXPathEvaluator, SaxonXpathEvaluator

public interface XPathEvaluator

A simple component of evaluation XPath expressions in full conformance of the XPath 2.0 spec and basic conformance of the XPath 3.0 (everything except features which require schema awareness and high order functions).

All implementations are require to support the ability to pass parameters into the query. For that reason, all the evaluation methods will require the current MuleEvent to be passed on, in order to resolve those parameters against the flow variables.

All implementations are required to be thread-safe

Since:

3.6.0

Method Summary

Modifier and Type	Method and Description
String	evaluate(String xpathExpression, Node input, MuleEvent event) Evaluates the xpathExpression over the input and returns the evaluation as a String.
Object	evaluate(String xpathExpression, Node input, XPathReturnType returnType, MuleEvent event) Evaluates the xpathExpression over the input and returns the evaluation as a type in concordance with returnType.
Map<String,String>	getRegisteredNamespaces() Returns a Map with the registered namespaces.
void	registerNamespaces(Map<String,String> namespaces) Registers the given namespaces so that they can be recognized during evaluation
void	registerNamespaces(NamespaceManager namespaceManager) Registers the namespaces in namespaceManager

Method Detail

evaluate

String evaluate(String xpathExpression,
                Node input,
                MuleEvent event)

Evaluates the xpathExpression over the input and returns the evaluation as a String.

If xpathExpression contains parameters, they will be resolved against the flow variables in event

Parameters:

xpathExpression - the xpathExpression to be evaluated

input - a Node

event - the current MuleEvent.

Returns:

the result of the evaluation as a String

evaluate

Object evaluate(String xpathExpression,
                Node input,
                XPathReturnType returnType,
                MuleEvent event)

Evaluates the xpathExpression over the input and returns the evaluation as a type in concordance with returnType.

If xpathExpression contains parameters, they will be resolved against the flow variables in event

Parameters:

xpathExpression - the xpathExpression to be evaluated

input - a Node

returnType - a XPathReturnType that will be used to decide the return type of the evaluation

event - the current MuleEvent.

Returns:

the result of the evaluation in concordance with returnType

registerNamespaces

void registerNamespaces(Map<String,String> namespaces)

Registers the given namespaces so that they can be recognized during evaluation

Parameters:

namespaces - a Map in which the key is a namespace prefix and the value is its URI as a String

registerNamespaces

void registerNamespaces(NamespaceManager namespaceManager)

Registers the namespaces in namespaceManager

Parameters:

namespaceManager - a NamespaceManager

getRegisteredNamespaces

Map<String,String> getRegisteredNamespaces()

Returns a Map with the registered namespaces. The key of the map is the namespace prefix and the value is its URI as a String

Returns:

a Map