org.trancecode.xproc.step

Class AbstractStepProcessor.StepInput

java.lang.Object

org.trancecode.xproc.step.AbstractStepProcessor.StepInput

All Implemented Interfaces:

HasLocation

Enclosing class:

AbstractStepProcessor

protected static final class AbstractStepProcessor.StepInput
extends Object
implements HasLocation

Input for a step execution.

Method Summary

Methods

Modifier and Type	Method and Description
net.sf.saxon.s9api.XdmValue	evaluateXPath(String select) Evaluates an XPath query.
net.sf.saxon.s9api.XdmValue	evaluateXPath(String select, net.sf.saxon.s9api.XdmNode xpathContextNode) Evaluates an XPath query with the specified node as a context.
net.sf.saxon.s9api.XdmValue	evaluateXPath(String select, net.sf.saxon.s9api.XdmNode xpathContextNode, Map<net.sf.saxon.s9api.QName,String> additionalParameters) Evaluates an XPath query with the specified node as a context and the given parameters as variables
URI	getBaseUri() Returns the base URI of the pipeline being executed.
Location	getLocation() Returns the Location of the current step in the pipeline.
String	getOptionValue(net.sf.saxon.s9api.QName name) Returns the value of an option from the current step.
String	getOptionValue(net.sf.saxon.s9api.QName name, String defaultValue) Returns the value of an option from the current step or the specified default value if there is no value for this option on the current step.
Map<net.sf.saxon.s9api.QName,String>	getParameters(String portName) Returns a map of parameters for the specified port.
PipelineContext	getPipelineContext() Returns the pipeline context, from which extra facilities can be retrieved.
Step	getStep() Returns the step being executed.
net.sf.saxon.s9api.XdmNode	newResultElement(String value) Creates a c:result element to be used as the result of step execution.
net.sf.saxon.s9api.XdmNode	readNode(String portName) Reads a single node from the specified port.
Iterable<net.sf.saxon.s9api.XdmNode>	readNodes(String portName) Reads nodes from the specified port.

Methods inherited from class java.lang.Object

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

Method Detail

getLocation

public Location getLocation()

Returns the Location of the current step in the pipeline.

Specified by:

getLocation in interface HasLocation

getPipelineContext

public PipelineContext getPipelineContext()

Returns the pipeline context, from which extra facilities can be retrieved.

getBaseUri

public URI getBaseUri()

Returns the base URI of the pipeline being executed.

newResultElement

public net.sf.saxon.s9api.XdmNode newResultElement(String value)

Creates a c:result element to be used as the result of step execution.

See Also:

c:result

getStep

public Step getStep()

Returns the step being executed.

readNode

public net.sf.saxon.s9api.XdmNode readNode(String portName)

Reads a single node from the specified port.

The port is necessarily a declared one from the current step.

readNodes

public Iterable<net.sf.saxon.s9api.XdmNode> readNodes(String portName)

Reads nodes from the specified port.

The port is necessarily a declared one from the current step.

getOptionValue

public String getOptionValue(net.sf.saxon.s9api.QName name)

Returns the value of an option from the current step.

getOptionValue

public String getOptionValue(net.sf.saxon.s9api.QName name,
                    String defaultValue)

Returns the value of an option from the current step or the specified default value if there is no value for this option on the current step.

getParameters

public Map<net.sf.saxon.s9api.QName,String> getParameters(String portName)

Returns a map of parameters for the specified port.

evaluateXPath

public net.sf.saxon.s9api.XdmValue evaluateXPath(String select)

Evaluates an XPath query.

evaluateXPath

public net.sf.saxon.s9api.XdmValue evaluateXPath(String select,
                                        net.sf.saxon.s9api.XdmNode xpathContextNode)

Evaluates an XPath query with the specified node as a context.

evaluateXPath

public net.sf.saxon.s9api.XdmValue evaluateXPath(String select,
                                        net.sf.saxon.s9api.XdmNode xpathContextNode,
                                        Map<net.sf.saxon.s9api.QName,String> additionalParameters)

Evaluates an XPath query with the specified node as a context and the given parameters as variables