org.trancecode.xproc

Class Environment

java.lang.Object

org.trancecode.xproc.Environment

public final class Environment
extends Object

Author:

Herve Quiroz

Method Summary

Methods

Modifier and Type	Method and Description
Environment	addPorts(EnvironmentPort... ports)
Environment	addPorts(Iterable<EnvironmentPort> ports)
Environment	addPorts(Map<PortReference,EnvironmentPort> ports)
net.sf.saxon.s9api.XdmValue	evaluateXPath(String select)
net.sf.saxon.s9api.XdmValue	evaluateXPath(String select, net.sf.saxon.s9api.XdmNode xpathContextNode)
net.sf.saxon.s9api.XdmValue	evaluateXPath(String select, net.sf.saxon.s9api.XdmNode xpathContextNode, Map<net.sf.saxon.s9api.QName,String> additionalParameters)
URI	getBaseUri()
static Environment	getCurrentEnvironment()
static net.sf.saxon.s9api.XdmNode	getCurrentNamespaceContext()
static net.sf.saxon.s9api.XdmNode	getCurrentXPathContext()
EnvironmentPort	getDefaultParametersPort()
EnvironmentPort	getDefaultReadablePort()
EnvironmentPort	getEnvironmentPort(Port port)
EnvironmentPort	getEnvironmentPort(PortReference portReference)
Map<net.sf.saxon.s9api.QName,String>	getInheritedVariables()
Map<net.sf.saxon.s9api.QName,String>	getLocalVariables()
Iterable<EnvironmentPort>	getOutputPorts()
Step	getPipeline()
PipelineContext	getPipelineContext()
Map<PortReference,EnvironmentPort>	getPorts()
String	getVariable(net.sf.saxon.s9api.QName name)
String	getVariable(net.sf.saxon.s9api.QName name, String defaultValue)
net.sf.saxon.s9api.XdmNode	getXPathContextNode()
net.sf.saxon.s9api.XdmNode	getXPathContextNode(Variable variable)
EnvironmentPort	getXPathContextPort()
Environment	newChildStepEnvironment()
static Environment	newEnvironment(Step pipeline, PipelineContext configuration)
Environment	newFollowingStepEnvironment()
Environment	newFollowingStepEnvironment(Step step)
Environment	newFollowingStepEnvironment(Step step, boolean evaluateVariables)
net.sf.saxon.s9api.XdmNode	newParameterElement(net.sf.saxon.s9api.QName name, String value)
net.sf.saxon.s9api.XdmNode	newResultElement(String value)
net.sf.saxon.s9api.XdmNode	readNode(PortReference portReference)
Iterable<net.sf.saxon.s9api.XdmNode>	readNodes(PortReference portReference)
Map<net.sf.saxon.s9api.QName,String>	readParameters(PortReference portReference)
void	setCurrentEnvironment()
static void	setCurrentEnvironment(Environment environment)
static void	setCurrentNamespaceContext(net.sf.saxon.s9api.XdmNode node)
static void	setCurrentXPathContext(net.sf.saxon.s9api.XdmNode node)
Environment	setDefaultParametersPort(EnvironmentPort defaultParametersPort)
Environment	setDefaultReadablePort(EnvironmentPort defaultReadablePort)
Environment	setDefaultReadablePort(PortReference portReference)
Environment	setDefaultReadablePortAsXPathContextPort()
void	setLocalVariable(net.sf.saxon.s9api.QName name, String value)
Environment	setLocalVariables(Map<net.sf.saxon.s9api.QName,String> localVariables)
Environment	setPrimaryOutputPortAsDefaultReadablePort(Step step, Environment sourceEnvironment)
Environment	setupOutputPorts(Step step)
Environment	setupOutputPorts(Step step, Environment sourceEnvironment)
Environment	setupVariables(Step step)
Environment	setXPathContextPort(EnvironmentPort xpathContextPort)
Environment	writeNodes(PortReference portReference, Iterable<net.sf.saxon.s9api.XdmNode> nodes)
Environment	writeNodes(PortReference portReference, net.sf.saxon.s9api.XdmNode... nodes)

Methods inherited from class java.lang.Object

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

Method Detail

setCurrentNamespaceContext

public static void setCurrentNamespaceContext(net.sf.saxon.s9api.XdmNode node)

getCurrentNamespaceContext

public static net.sf.saxon.s9api.XdmNode getCurrentNamespaceContext()

setCurrentXPathContext

public static void setCurrentXPathContext(net.sf.saxon.s9api.XdmNode node)

getCurrentXPathContext

public static net.sf.saxon.s9api.XdmNode getCurrentXPathContext()

setCurrentEnvironment

public static void setCurrentEnvironment(Environment environment)

setCurrentEnvironment

public void setCurrentEnvironment()

getCurrentEnvironment

public static Environment getCurrentEnvironment()

newEnvironment

public static Environment newEnvironment(Step pipeline,
                         PipelineContext configuration)

setupOutputPorts

public Environment setupOutputPorts(Step step)

setupOutputPorts

public Environment setupOutputPorts(Step step,
                           Environment sourceEnvironment)

setDefaultReadablePortAsXPathContextPort

public Environment setDefaultReadablePortAsXPathContextPort()

setPrimaryOutputPortAsDefaultReadablePort

public Environment setPrimaryOutputPortAsDefaultReadablePort(Step step,
                                                    Environment sourceEnvironment)

setupVariables

public Environment setupVariables(Step step)

newFollowingStepEnvironment

public Environment newFollowingStepEnvironment(Step step)

newFollowingStepEnvironment

public Environment newFollowingStepEnvironment(Step step,
                                      boolean evaluateVariables)

newFollowingStepEnvironment

public Environment newFollowingStepEnvironment()

newChildStepEnvironment

public Environment newChildStepEnvironment()

setLocalVariables

public Environment setLocalVariables(Map<net.sf.saxon.s9api.QName,String> localVariables)

setLocalVariable

public void setLocalVariable(net.sf.saxon.s9api.QName name,
                    String value)

getDefaultReadablePort

public EnvironmentPort getDefaultReadablePort()

getXPathContextPort

public EnvironmentPort getXPathContextPort()

setXPathContextPort

public Environment setXPathContextPort(EnvironmentPort xpathContextPort)

getPipelineContext

public PipelineContext getPipelineContext()

getVariable

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

getVariable

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

getLocalVariables

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

getInheritedVariables

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

setDefaultReadablePort

public Environment setDefaultReadablePort(EnvironmentPort defaultReadablePort)

setDefaultReadablePort

public Environment setDefaultReadablePort(PortReference portReference)

getPorts

public Map<PortReference,EnvironmentPort> getPorts()

getEnvironmentPort

public EnvironmentPort getEnvironmentPort(Port port)

getEnvironmentPort

public EnvironmentPort getEnvironmentPort(PortReference portReference)

addPorts

public Environment addPorts(EnvironmentPort... ports)

addPorts

public Environment addPorts(Iterable<EnvironmentPort> ports)

addPorts

public Environment addPorts(Map<PortReference,EnvironmentPort> ports)

getPipeline

public Step getPipeline()

getBaseUri

public URI getBaseUri()

getDefaultParametersPort

public EnvironmentPort getDefaultParametersPort()

setDefaultParametersPort

public Environment setDefaultParametersPort(EnvironmentPort defaultParametersPort)

getXPathContextNode

@ReturnsNullable
public net.sf.saxon.s9api.XdmNode getXPathContextNode()

getXPathContextNode

@ReturnsNullable
public net.sf.saxon.s9api.XdmNode getXPathContextNode(Variable variable)

evaluateXPath

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

evaluateXPath

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

evaluateXPath

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

writeNodes

public Environment writeNodes(PortReference portReference,
                     net.sf.saxon.s9api.XdmNode... nodes)

writeNodes

public Environment writeNodes(PortReference portReference,
                     Iterable<net.sf.saxon.s9api.XdmNode> nodes)

readNodes

public Iterable<net.sf.saxon.s9api.XdmNode> readNodes(PortReference portReference)

readNode

public net.sf.saxon.s9api.XdmNode readNode(PortReference portReference)

readParameters

public Map<net.sf.saxon.s9api.QName,String> readParameters(PortReference portReference)

newParameterElement

public net.sf.saxon.s9api.XdmNode newParameterElement(net.sf.saxon.s9api.QName name,
                                             String value)

newResultElement

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

getOutputPorts

public Iterable<EnvironmentPort> getOutputPorts()