com.xmlcalabash.runtime
Class XStep

java.lang.Object
  extended by com.xmlcalabash.runtime.XStep
All Implemented Interfaces:
XProcRunnable
Direct Known Subclasses:
XAtomicStep

public abstract class XStep
extends java.lang.Object
implements XProcRunnable

Created by IntelliJ IDEA. User: ndw Date: Oct 7, 2008 Time: 8:02:28 AM To change this template use File | Settings | File Templates.


Field Summary
protected  java.util.Hashtable<net.sf.saxon.s9api.QName,RuntimeValue> inScopeOptions
           
protected  java.util.logging.Logger logger
           
protected  java.lang.String name
           
protected  XCompoundStep parent
           
protected  XProcRuntime runtime
           
protected  Step step
           
 
Constructor Summary
XStep(XProcRuntime runtime, Step step)
           
 
Method Summary
 void addInput(XInput input)
           
 void addOutput(XOutput output)
           
 void clearOptions()
           
 void clearParameters()
           
 void error(net.sf.saxon.s9api.XdmNode node, java.lang.String message, net.sf.saxon.s9api.QName code)
           
 void fine(net.sf.saxon.s9api.XdmNode node, java.lang.String message)
           
 void finer(net.sf.saxon.s9api.XdmNode node, java.lang.String message)
           
 void finest(net.sf.saxon.s9api.XdmNode node, java.lang.String message)
           
 DeclareStep getDeclareStep()
           
 java.lang.String getExtensionAttribute(net.sf.saxon.s9api.QName name)
           
 java.lang.String getInheritedExtensionAttribute(net.sf.saxon.s9api.QName name)
           
 XInput getInput(java.lang.String port)
           
 java.util.Hashtable<net.sf.saxon.s9api.QName,RuntimeValue> getInScopeOptions()
           
 java.lang.String getName()
           
 net.sf.saxon.s9api.XdmNode getNode()
           
 RuntimeValue getOption(net.sf.saxon.s9api.QName name)
           
 java.util.Set<net.sf.saxon.s9api.QName> getOptions()
           
 XOutput getOutput(java.lang.String port)
           
 RuntimeValue getParameter(net.sf.saxon.s9api.QName name)
           
 RuntimeValue getParameter(java.lang.String port, net.sf.saxon.s9api.QName name)
           
 java.util.Set<java.lang.String> getParameterPorts()
           
 java.util.Set<net.sf.saxon.s9api.QName> getParameters()
           
 java.util.Set<net.sf.saxon.s9api.QName> getParameters(java.lang.String port)
           
 XCompoundStep getParent()
           
 Step getStep()
           
 net.sf.saxon.s9api.QName getType()
           
 boolean hasInScopeVariableBinding(net.sf.saxon.s9api.QName name)
           
 boolean hasInScopeVariableValue(net.sf.saxon.s9api.QName name)
           
 void info(net.sf.saxon.s9api.XdmNode node, java.lang.String message)
           
abstract  void instantiate(Step step)
           
abstract  RuntimeValue optionAvailable(net.sf.saxon.s9api.QName optName)
           
abstract  void reset()
           
abstract  void run()
           
 void setOption(net.sf.saxon.s9api.QName name, RuntimeValue value)
           
 void setParameter(net.sf.saxon.s9api.QName name, RuntimeValue value)
           
 void setParameter(java.lang.String port, net.sf.saxon.s9api.QName name, RuntimeValue value)
           
 void warning(net.sf.saxon.s9api.XdmNode node, java.lang.String message)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

runtime

protected XProcRuntime runtime

step

protected Step step

name

protected java.lang.String name

parent

protected XCompoundStep parent

logger

protected java.util.logging.Logger logger

inScopeOptions

protected java.util.Hashtable<net.sf.saxon.s9api.QName,RuntimeValue> inScopeOptions
Constructor Detail

XStep

public XStep(XProcRuntime runtime,
             Step step)
Method Detail

getStep

public Step getStep()

getNode

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

getType

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

getName

public java.lang.String getName()

getDeclareStep

public DeclareStep getDeclareStep()

getParent

public XCompoundStep getParent()

addInput

public void addInput(XInput input)

addOutput

public void addOutput(XOutput output)

getInput

public XInput getInput(java.lang.String port)

getOutput

public XOutput getOutput(java.lang.String port)

setParameter

public void setParameter(net.sf.saxon.s9api.QName name,
                         RuntimeValue value)

setParameter

public void setParameter(java.lang.String port,
                         net.sf.saxon.s9api.QName name,
                         RuntimeValue value)

getOptions

public java.util.Set<net.sf.saxon.s9api.QName> getOptions()

getOption

public RuntimeValue getOption(net.sf.saxon.s9api.QName name)

setOption

public void setOption(net.sf.saxon.s9api.QName name,
                      RuntimeValue value)

clearOptions

public void clearOptions()

clearParameters

public void clearParameters()

getParameters

public java.util.Set<net.sf.saxon.s9api.QName> getParameters()

getParameter

public RuntimeValue getParameter(net.sf.saxon.s9api.QName name)

getParameterPorts

public java.util.Set<java.lang.String> getParameterPorts()

getParameters

public java.util.Set<net.sf.saxon.s9api.QName> getParameters(java.lang.String port)

getParameter

public RuntimeValue getParameter(java.lang.String port,
                                 net.sf.saxon.s9api.QName name)

getExtensionAttribute

public java.lang.String getExtensionAttribute(net.sf.saxon.s9api.QName name)

getInheritedExtensionAttribute

public java.lang.String getInheritedExtensionAttribute(net.sf.saxon.s9api.QName name)

hasInScopeVariableBinding

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

hasInScopeVariableValue

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

getInScopeOptions

public java.util.Hashtable<net.sf.saxon.s9api.QName,RuntimeValue> getInScopeOptions()

optionAvailable

public abstract RuntimeValue optionAvailable(net.sf.saxon.s9api.QName optName)

instantiate

public abstract void instantiate(Step step)

reset

public abstract void reset()
Specified by:
reset in interface XProcRunnable

run

public abstract void run()
                  throws net.sf.saxon.s9api.SaxonApiException
Specified by:
run in interface XProcRunnable
Throws:
net.sf.saxon.s9api.SaxonApiException

error

public void error(net.sf.saxon.s9api.XdmNode node,
                  java.lang.String message,
                  net.sf.saxon.s9api.QName code)

warning

public void warning(net.sf.saxon.s9api.XdmNode node,
                    java.lang.String message)

info

public void info(net.sf.saxon.s9api.XdmNode node,
                 java.lang.String message)

fine

public void fine(net.sf.saxon.s9api.XdmNode node,
                 java.lang.String message)

finer

public void finer(net.sf.saxon.s9api.XdmNode node,
                  java.lang.String message)

finest

public void finest(net.sf.saxon.s9api.XdmNode node,
                   java.lang.String message)