org.trancecode.xproc.step

Class Step

java.lang.Object

org.trancecode.xml.AbstractHasLocation

org.trancecode.xproc.step.Step

All Implemented Interfaces:

HasLocation, StepContainer

public final class Step
extends AbstractHasLocation
implements StepContainer

Author:

Herve Quiroz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Step.Log

Field Summary

Fields inherited from class org.trancecode.xml.AbstractHasLocation

location

Method Summary

Methods

Modifier and Type	Method and Description
Step	addChildStep(Step step)
Step	addLog(String port, String href)
void	checkDeclaredStep()
void	checkInstanceStep()
Step	declarePort(Port port)
Step	declarePorts(Iterable<Port> ports)
Step	declareVariable(Variable variable)
Step	declareVariables(Map<net.sf.saxon.s9api.QName,Variable> variables)
boolean	equals(Object o)
Iterable<Step>	getAllSteps()
Iterable<Port>	getInputPorts()
Iterable<Port>	getInputPorts(boolean includeParameterPorts)
String	getInternalName()
Iterable<Step.Log>	getLogs()
String	getName()
net.sf.saxon.s9api.XdmNode	getNode()
Iterable<Port>	getOutputPorts()
Iterable<Port>	getParameterPorts()
Map<net.sf.saxon.s9api.QName,Variable>	getParameters()
Port	getPort(String name)
PortReference	getPortReference(String portName)
Map<String,Port>	getPorts()
Port	getPrimaryInputPort()
Port	getPrimaryOutputPort()
Port	getPrimaryParameterPort()
Step	getStepByName(String name)
StepProcessor	getStepProcessor()
List<Step>	getSubpipeline()
protected Map<Step,Iterable<Step>>	getSubpipelineStepDependencies()
protected static Map<Step,Iterable<Step>>	getSubpipelineStepDependencies(Iterable<Step> steps)
net.sf.saxon.s9api.QName	getType()
Variable	getVariable(net.sf.saxon.s9api.QName name)
Map<net.sf.saxon.s9api.QName,Variable>	getVariables()
Port	getXPathContextPort()
int	hashCode()
boolean	hasLogDeclaredForPort(String port)
boolean	hasOptionDeclared(net.sf.saxon.s9api.QName name)
boolean	hasPortDeclared(String name)
boolean	isCompoundStep()
boolean	isPipelineStep()
static Step	newStep(net.sf.saxon.s9api.QName type, StepProcessor stepProcessor, boolean compoundStep)
static Step	newStep(net.sf.saxon.s9api.XdmNode node, net.sf.saxon.s9api.QName type, StepProcessor stepProcessor, boolean compoundStep)
protected boolean	readsExternalResources()
Environment	run(Environment environment)
Step	setLocation(Location location)
Step	setName(String name)
Step	setNode(net.sf.saxon.s9api.XdmNode node)
Step	setPortBindings(String portName, Iterable<PortBinding> portBindings)
Step	setPortBindings(String portName, PortBinding... portBindings)
Step	setSubpipeline(Iterable<Step> steps)
String	toString()
Step	withOption(net.sf.saxon.s9api.QName name, String select, net.sf.saxon.s9api.XdmNode node)
Step	withOption(net.sf.saxon.s9api.QName name, String select, net.sf.saxon.s9api.XdmNode node, PortBinding portBinding)
Step	withOptionValue(net.sf.saxon.s9api.QName name, String value)
Step	withOptionValue(net.sf.saxon.s9api.QName name, String value, net.sf.saxon.s9api.XdmNode node)
Step	withParam(net.sf.saxon.s9api.QName name, String select, String value, Location location)
Step	withParam(net.sf.saxon.s9api.QName name, String select, String value, Location location, net.sf.saxon.s9api.XdmNode node)
Step	withParam(net.sf.saxon.s9api.QName name, String select, String value, Location location, net.sf.saxon.s9api.XdmNode node, PortBinding portBinding)
Step	withPort(Port port)
protected boolean	writesExternalResources()

Methods inherited from class org.trancecode.xml.AbstractHasLocation

getLocation

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newStep

public static Step newStep(net.sf.saxon.s9api.QName type,
           StepProcessor stepProcessor,
           boolean compoundStep)

newStep

public static Step newStep(net.sf.saxon.s9api.XdmNode node,
           net.sf.saxon.s9api.QName type,
           StepProcessor stepProcessor,
           boolean compoundStep)

isPipelineStep

public boolean isPipelineStep()

setName

public Step setName(String name)

isCompoundStep

public boolean isCompoundStep()

declareVariable

public Step declareVariable(Variable variable)

declareVariables

public Step declareVariables(Map<net.sf.saxon.s9api.QName,Variable> variables)

getName

public String getName()

getInternalName

@ReturnsNullable
public String getInternalName()

declarePort

public Step declarePort(Port port)

declarePorts

public Step declarePorts(Iterable<Port> ports)

getPort

public Port getPort(String name)

hasPortDeclared

public boolean hasPortDeclared(String name)

getPorts

public Map<String,Port> getPorts()

run

public Environment run(Environment environment)

getPrimaryInputPort

@ReturnsNullable
public Port getPrimaryInputPort()

getPrimaryParameterPort

@ReturnsNullable
public Port getPrimaryParameterPort()

getPrimaryOutputPort

@ReturnsNullable
public Port getPrimaryOutputPort()

getInputPorts

public Iterable<Port> getInputPorts()

getInputPorts

public Iterable<Port> getInputPorts(boolean includeParameterPorts)

getOutputPorts

public Iterable<Port> getOutputPorts()

getParameterPorts

public Iterable<Port> getParameterPorts()

withOption

public Step withOption(net.sf.saxon.s9api.QName name,
              String select,
              net.sf.saxon.s9api.XdmNode node)

withOption

public Step withOption(net.sf.saxon.s9api.QName name,
              String select,
              net.sf.saxon.s9api.XdmNode node,
              PortBinding portBinding)

withParam

public Step withParam(net.sf.saxon.s9api.QName name,
             String select,
             String value,
             Location location)

withParam

public Step withParam(net.sf.saxon.s9api.QName name,
             String select,
             String value,
             Location location,
             net.sf.saxon.s9api.XdmNode node)

withParam

public Step withParam(net.sf.saxon.s9api.QName name,
             String select,
             String value,
             Location location,
             net.sf.saxon.s9api.XdmNode node,
             PortBinding portBinding)

withOptionValue

public Step withOptionValue(net.sf.saxon.s9api.QName name,
                   String value)

withOptionValue

public Step withOptionValue(net.sf.saxon.s9api.QName name,
                   String value,
                   net.sf.saxon.s9api.XdmNode node)

hasOptionDeclared

public boolean hasOptionDeclared(net.sf.saxon.s9api.QName name)

toString

public String toString()

Overrides:

toString in class Object

setPortBindings

public Step setPortBindings(String portName,
                   PortBinding... portBindings)

setPortBindings

public Step setPortBindings(String portName,
                   Iterable<PortBinding> portBindings)

withPort

public Step withPort(Port port)

getXPathContextPort

@ReturnsNullable
public Port getXPathContextPort()

getParameters

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

getVariables

public Map<net.sf.saxon.s9api.QName,Variable> getVariables()

getType

public net.sf.saxon.s9api.QName getType()

setNode

public Step setNode(net.sf.saxon.s9api.XdmNode node)

getNode

public net.sf.saxon.s9api.XdmNode getNode()

addChildStep

public Step addChildStep(Step step)

setSubpipeline

public Step setSubpipeline(Iterable<Step> steps)

getSubpipeline

public List<Step> getSubpipeline()

setLocation

public Step setLocation(Location location)

getVariable

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

getPortReference

public PortReference getPortReference(String portName)

getStepProcessor

public StepProcessor getStepProcessor()

readsExternalResources

protected boolean readsExternalResources()

writesExternalResources

protected boolean writesExternalResources()

getSubpipelineStepDependencies

protected Map<Step,Iterable<Step>> getSubpipelineStepDependencies()

getSubpipelineStepDependencies

protected static Map<Step,Iterable<Step>> getSubpipelineStepDependencies(Iterable<Step> steps)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getAllSteps

public Iterable<Step> getAllSteps()

Specified by:

getAllSteps in interface StepContainer

getStepByName

public Step getStepByName(String name)

Specified by:

getStepByName in interface StepContainer

getLogs

public Iterable<Step.Log> getLogs()

addLog

public Step addLog(String port,
          String href)

hasLogDeclaredForPort

public boolean hasLogDeclaredForPort(String port)

checkDeclaredStep

public void checkDeclaredStep()

checkInstanceStep

public void checkInstanceStep()