org.mule.module.xml.internal.operation

Class XQueryOperation

java.lang.Object

org.mule.module.xml.internal.operation.PooledTransformerOperation<String,javax.xml.xquery.XQPreparedExpression>

org.mule.module.xml.internal.operation.XQueryOperation

All Implemented Interfaces:

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

public class XQueryOperation
extends PooledTransformerOperation<String,javax.xml.xquery.XQPreparedExpression>

Operation to transform an XML document using XQuery

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
XQueryOperation()

Method Summary

Modifier and Type	Method and Description
protected org.apache.commons.pool2.BasePooledObjectFactory<javax.xml.xquery.XQPreparedExpression>	createPooledObjectFactory(String xquery)
protected void	doInitialise()
protected boolean	testOnReturn()
List<String>	xqueryTransform(InputStream content, String xquery, Map<String,Object> contextProperties, XmlModule config, boolean addTrailingNewlines) Uses XQuery to transform the input content.

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

initialise, start, stop, withTransformer

Methods inherited from class java.lang.Object

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

Constructor Detail

XQueryOperation

public XQueryOperation()

Method Detail

doInitialise

protected void doInitialise()
                     throws org.mule.runtime.api.lifecycle.InitialisationException

Overrides:

doInitialise in class PooledTransformerOperation<String,javax.xml.xquery.XQPreparedExpression>

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

xqueryTransform

@Execution(value=CPU_INTENSIVE)
 @Throws(value=StandardXmlErrorTypeProvider.class)
public List<String> xqueryTransform(@Content(primary=true)
                                                                                                                       InputStream content,
                                                                                                                       @Text
                                                                                                                       String xquery,
                                                                                                                       @Optional @Content @NullSafe
                                                                                                                       Map<String,Object> contextProperties,
                                                                                                                       @Config
                                                                                                                       XmlModule config,
                                                                                                                       @Optional(defaultValue="false")
                                                                                                                       boolean addTrailingNewlines)

Uses XQuery to transform the input content. You can set transformation context properties which will be made available on the XQuery execution

Parameters:

content - the XML content to transform

xquery - The XQuery script definition

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

config - the config object

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

Returns:

the transformed document

createPooledObjectFactory

protected org.apache.commons.pool2.BasePooledObjectFactory<javax.xml.xquery.XQPreparedExpression> createPooledObjectFactory(String xquery)

Specified by:

createPooledObjectFactory in class PooledTransformerOperation<String,javax.xml.xquery.XQPreparedExpression>

testOnReturn

protected boolean testOnReturn()

Overrides:

testOnReturn in class PooledTransformerOperation<String,javax.xml.xquery.XQPreparedExpression>