org.mule.module.xml.internal.operation

Class XPathOperation

java.lang.Object

org.mule.module.xml.internal.operation.PooledTransformerOperation<org.mule.module.xml.internal.operation.XPathOperation.XPathKey,XPathEvaluator>

org.mule.module.xml.internal.operation.XPathOperation

All Implemented Interfaces:

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

public class XPathOperation
extends PooledTransformerOperation<org.mule.module.xml.internal.operation.XPathOperation.XPathKey,XPathEvaluator>
implements org.mule.runtime.api.lifecycle.Initialisable

Operation for extracting values from an XML document using XPath

Since:

1.0

Field Summary

Fields inherited from class org.mule.module.xml.internal.operation.PooledTransformerOperation

documentBuilderFactory, entityResolver, expandEntities

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
XPathOperation()
XPathOperation(EntityExpansion expandEntities)

Method Summary

Modifier and Type	Method and Description
protected org.apache.commons.pool2.BasePooledObjectFactory<XPathEvaluator>	createPooledObjectFactory(org.mule.module.xml.internal.operation.XPathOperation.XPathKey key)
List<String>	xpathExtract(InputStream content, String xpath, Map<String,Object> contextProperties, List<NamespaceMapping> namespaces, NamespaceDirectory namespaceDirectory, XmlModule config, boolean addTrailingNewlines) Evaluates an XPath expression the input content and returns the result.

Methods inherited from class org.mule.module.xml.internal.operation.PooledTransformerOperation

doInitialise, initialise, start, stop, testOnReturn, withTransformer

Methods inherited from class java.lang.Object

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

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

initialise

Constructor Detail

XPathOperation

public XPathOperation()

XPathOperation

public XPathOperation(EntityExpansion expandEntities)

Method Detail

xpathExtract

@Execution(value=CPU_INTENSIVE)
 @Throws(value=XPathErrorTypeProvider.class)
public List<String> xpathExtract(@Content(primary=true)
                                                                                                              InputStream content,
                                                                                                              String xpath,
                                                                                                              @Optional @Content @NullSafe
                                                                                                              Map<String,Object> contextProperties,
                                                                                                              @Optional @NullSafe
                                                                                                              List<NamespaceMapping> namespaces,
                                                                                                              @Optional @ParameterDsl(allowInlineDefinition=false)
                                                                                                              NamespaceDirectory namespaceDirectory,
                                                                                                              @Config
                                                                                                              XmlModule config,
                                                                                                              @Optional(defaultValue="false")
                                                                                                              boolean addTrailingNewlines)

Evaluates an XPath expression the input content and returns the result.

Because XPath expressions can match any number of individual elements, this operation returns a List of Strings. If no element matched the expression, an empty list will be returned.

XPath expressions are also namespace aware, which is why this operation allows setting namespace mappings. These mappings will be merged with those optionally defined in the referenced namespace-directory, meaning that the evaluation will combine both sets of namespace mappings.

Parameters:

content - the XML content on which the XPath is evaluated

xpath - the XPath script

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

namespaces - namespace mappings that will be used in this evaluation. They will be combined with the ones in the config element

namespaceDirectory - the namespace directory from which take base namespace mappings

config - the config

addTrailingNewlines - adds a newline character (\n) at the end of every xml-part result

Returns:

a List of Strings with all the matching elements

createPooledObjectFactory

protected org.apache.commons.pool2.BasePooledObjectFactory<XPathEvaluator> createPooledObjectFactory(org.mule.module.xml.internal.operation.XPathOperation.XPathKey key)

Specified by:

createPooledObjectFactory in class PooledTransformerOperation<org.mule.module.xml.internal.operation.XPathOperation.XPathKey,XPathEvaluator>