com.xmlcalabash.model
Class Step

java.lang.Object
  extended by com.xmlcalabash.model.SourceArtifact
      extended by com.xmlcalabash.model.Step
Direct Known Subclasses:
CompoundStep, Import, PipelineLibrary

public class Step
extends SourceArtifact

Author:
ndw

Field Summary
protected  DeclareStep declaration
           
protected  Environment env
           
protected  java.util.Vector<Input> inputs
           
protected  java.util.Vector<Output> outputs
           
protected  Step parent
           
protected  java.lang.String stepName
           
protected  net.sf.saxon.s9api.QName stepType
           
protected  java.lang.Double version
           
 
Fields inherited from class com.xmlcalabash.model.SourceArtifact
extnAttrs, logger, node, runtime
 
Constructor Summary
Step(XProcRuntime xproc, net.sf.saxon.s9api.XdmNode node, net.sf.saxon.s9api.QName type)
          Creates a new instance of Step
Step(XProcRuntime xproc, net.sf.saxon.s9api.XdmNode node, net.sf.saxon.s9api.QName type, java.lang.String name)
           
 
Method Summary
protected  void addDependency(java.lang.String stepName)
           
 void addInput(Input input)
           
 void addLog(Log log)
           
 void addOption(Option option)
           
 void addOutput(Output output)
           
 void addParameter(Parameter param)
           
 void addStep(Step step)
           
 void addVariable(Variable variable)
           
 void augment()
           
protected  void augmentIO()
           
protected  void augmentOptions()
           
protected  boolean checkBinding(Input input)
           
protected  void checkDuplicateVars(java.util.HashSet<net.sf.saxon.s9api.QName> vars)
           
protected  void checkForBindings(java.util.HashSet<Output> outputs)
           
protected  boolean checkOptionBinding(EndPoint endpoint)
           
protected  boolean checkOptionBinding(EndPoint endpoint, boolean defEmpty)
           
 void checkVariables()
           
 boolean containsStep(java.lang.String stepName)
           
protected  boolean dependsOn(java.lang.String stepName)
           
 void dump()
           
protected  void dump(int depth)
           
 DeclareStep getDeclaration()
           
 net.sf.saxon.s9api.QName getDeclaredType()
           
 Output getDefaultOutput()
           
protected  java.util.HashSet<java.lang.String> getDependencies()
           
 Environment getEnvironment()
           
 Input getInput(java.lang.String portName)
           
 Log getLog(java.lang.String port)
           
 java.lang.String getName()
           
 net.sf.saxon.s9api.XdmNode getNode()
           
 Option getOption(net.sf.saxon.s9api.QName name)
           
 java.util.List<net.sf.saxon.s9api.QName> getOptions()
           
 Output getOutput(java.lang.String portName)
           
 Parameter getParameter(net.sf.saxon.s9api.QName name)
           
 java.util.List<net.sf.saxon.s9api.QName> getParameters()
           
 Step getPipeline()
           
 Output getPrimaryOutput()
           
 Step getStep()
           
 net.sf.saxon.s9api.QName getType()
           
 java.util.Collection<Variable> getVariables()
           
 java.lang.Double getVersion()
           
 java.util.Vector<Input> inputs()
           
 boolean insideALoop()
           
 boolean isAnonymous()
           
 boolean isPipeline()
           
 boolean isPipelineCall()
           
 boolean loops()
           
protected  boolean matchesDeclaration()
           
 java.util.Vector<Option> options()
           
 boolean orderSteps()
           
 java.util.Vector<Output> outputs()
           
 java.util.Vector<Parameter> parameters()
           
protected  void patchEnvironment(Environment env)
           
protected  void patchInputBindings(EndPoint endpoint)
           
 void patchPipeBindings()
           
 void setDeclaration(DeclareStep decl)
           
protected  void setEnvironment(Environment newEnvironment)
           
 void setSubpipeline(java.util.Vector<Step> pipeline)
           
protected  void setVersion(java.lang.Double version)
           
 java.util.Vector<Step> subpipeline()
           
 java.lang.String toString()
           
 boolean valid()
           
protected  boolean validBindings()
           
protected  boolean validOptions()
           
protected  boolean validParams()
           
 
Methods inherited from class com.xmlcalabash.model.SourceArtifact
addExtensionAttribute, error, error, getExtensionAttribute, getExtensionAttributes, getXProc, xplFile, xplLine
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

stepType

protected net.sf.saxon.s9api.QName stepType

stepName

protected java.lang.String stepName

inputs

protected java.util.Vector<Input> inputs

outputs

protected java.util.Vector<Output> outputs

env

protected Environment env

parent

protected Step parent

declaration

protected DeclareStep declaration

version

protected java.lang.Double version
Constructor Detail

Step

public Step(XProcRuntime xproc,
            net.sf.saxon.s9api.XdmNode node,
            net.sf.saxon.s9api.QName type)
Creates a new instance of Step


Step

public Step(XProcRuntime xproc,
            net.sf.saxon.s9api.XdmNode node,
            net.sf.saxon.s9api.QName type,
            java.lang.String name)
Method Detail

isPipeline

public boolean isPipeline()

isAnonymous

public boolean isAnonymous()

setDeclaration

public void setDeclaration(DeclareStep decl)

getDeclaration

public DeclareStep getDeclaration()

isPipelineCall

public boolean isPipelineCall()

getType

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

getStep

public Step getStep()

setVersion

protected void setVersion(java.lang.Double version)

getVersion

public java.lang.Double getVersion()

getDeclaredType

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

getName

public java.lang.String getName()

getNode

public net.sf.saxon.s9api.XdmNode getNode()
Overrides:
getNode in class SourceArtifact

getPipeline

public Step getPipeline()

containsStep

public boolean containsStep(java.lang.String stepName)

addStep

public void addStep(Step step)

setSubpipeline

public void setSubpipeline(java.util.Vector<Step> pipeline)

subpipeline

public java.util.Vector<Step> subpipeline()

addVariable

public void addVariable(Variable variable)

getVariables

public java.util.Collection<Variable> getVariables()

addInput

public void addInput(Input input)

inputs

public java.util.Vector<Input> inputs()

getInput

public Input getInput(java.lang.String portName)

addOutput

public void addOutput(Output output)

outputs

public java.util.Vector<Output> outputs()

getPrimaryOutput

public Output getPrimaryOutput()

getOutput

public Output getOutput(java.lang.String portName)

addOption

public void addOption(Option option)

options

public java.util.Vector<Option> options()

getOption

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

getOptions

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

addLog

public void addLog(Log log)

getLog

public Log getLog(java.lang.String port)

addParameter

public void addParameter(Parameter param)

getParameter

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

getParameters

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

parameters

public java.util.Vector<Parameter> parameters()

loops

public boolean loops()

insideALoop

public boolean insideALoop()

getDefaultOutput

public Output getDefaultOutput()

addDependency

protected void addDependency(java.lang.String stepName)

getDependencies

protected java.util.HashSet<java.lang.String> getDependencies()

dependsOn

protected boolean dependsOn(java.lang.String stepName)

matchesDeclaration

protected boolean matchesDeclaration()

validOptions

protected boolean validOptions()

validParams

protected boolean validParams()

validBindings

protected boolean validBindings()

checkDuplicateVars

protected void checkDuplicateVars(java.util.HashSet<net.sf.saxon.s9api.QName> vars)

checkBinding

protected boolean checkBinding(Input input)

checkOptionBinding

protected boolean checkOptionBinding(EndPoint endpoint)

checkOptionBinding

protected boolean checkOptionBinding(EndPoint endpoint,
                                     boolean defEmpty)

checkForBindings

protected void checkForBindings(java.util.HashSet<Output> outputs)

orderSteps

public boolean orderSteps()

checkVariables

public void checkVariables()

valid

public boolean valid()

augmentIO

protected void augmentIO()

augmentOptions

protected void augmentOptions()

augment

public void augment()

patchPipeBindings

public void patchPipeBindings()

patchInputBindings

protected void patchInputBindings(EndPoint endpoint)

setEnvironment

protected void setEnvironment(Environment newEnvironment)

patchEnvironment

protected void patchEnvironment(Environment env)

getEnvironment

public Environment getEnvironment()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

dump

public void dump()

dump

protected void dump(int depth)