org.mule.module.xml.internal.xpath

Class XPathFunction

java.lang.Object

org.mule.module.xml.internal.xpath.XPathFunction

All Implemented Interfaces:

org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

public class XPathFunction
extends Object
implements org.mule.runtime.api.lifecycle.Initialisable, org.mule.runtime.api.lifecycle.Startable, org.mule.runtime.api.lifecycle.Stoppable

Similar to the xpath-extract operation but in the form of a DataWeave function.

Since:

1.0

Field Summary

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
XPathFunction()

Method Summary

Modifier and Type	Method and Description
void	initialise()
void	start()
void	stop()
List<String>	xpath(String xpath, InputStream content, Map<String,Object> contextProperties, NamespaceMapping... ns) Evaluates the xpath expression over the given XML content using the contextProperties.

Methods inherited from class java.lang.Object

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

Constructor Detail

XPathFunction

public XPathFunction()

Method Detail

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

start

public void start()
           throws org.mule.runtime.api.exception.MuleException

Specified by:

start in interface org.mule.runtime.api.lifecycle.Startable

Throws:

org.mule.runtime.api.exception.MuleException

stop

public void stop()
          throws org.mule.runtime.api.exception.MuleException

Specified by:

stop in interface org.mule.runtime.api.lifecycle.Stoppable

Throws:

org.mule.runtime.api.exception.MuleException

xpath

public List<String> xpath(String xpath,
                          InputStream content,
                          Map<String,Object> contextProperties,
                          @Optional
                          NamespaceMapping... ns)

Evaluates the xpath expression over the given XML content using the contextProperties.

Parameters:

xpath - the XPath script

content - the XML content on which the XPath is evaluated

contextProperties - Properties that will be made available to the transform context.

ns - NamespaceMapping Maps a prefix to a namespace URI

Returns:

a List of Strings with all the matching elements