All Implemented Interfaces:: com.xmlcalabash.datamodel.StepContainerInterface


public final class DeclareStepInstruction
extends CompoundStepDeclaration implements StepContainerInterface

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private Boolean`	`psviRequired`
`private Double`	`xpathVersion`
`private Double`	`version`
`private QName`	`type`
`private Visibility`	`visibility`
`private final Boolean`	`isAtomic`
`private Boolean`	`checkedCoherent`
`private Boolean`	`foundDeclarations`
`private Boolean`	`elaboratedInstructions`
`private String`	`name`
`private final Location`	`location`
`private final Map<QName, StaticOptionDetails>`	`staticOptions`
`private final String`	`id`
`private Boolean`	`expandText`
`private final XProcInstruction`	`parent`
`private final List<XProcInstruction>`	`children`
`private Map<QName, String>`	`extensionAttributes`
`private final List<XdmNode>`	`pipeinfo`
`private final Map<String, NamespaceUri>`	`inscopeNamespaces`
`private final Map<QName, VariableBindingContainer>`	`inscopeVariables`
`private final InstructionConfiguration`	`stepConfig`
`private final QName`	`instructionType`

Constructor Summary

Constructors
Constructor	Description
`DeclareStepInstruction(XProcInstruction parent)`
`DeclareStepInstruction(XProcInstruction parent, QName type)`
`DeclareStepInstruction(XProcInstruction parent, InstructionConfiguration stepConfig)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Boolean`	`getPsviRequired()`
`Unit`	`setPsviRequired(Boolean psviRequired)`
`Double`	`getXpathVersion()`
`Unit`	`setXpathVersion(Double xpathVersion)`
`Double`	`getVersion()`
`Unit`	`setVersion(Double version)`
`final QName`	`getType()`
`final Unit`	`setType(QName type)`
`final Visibility`	`getVisibility()`
`final Unit`	`setVisibility(Visibility visibility)`
`final Boolean`	`isAtomic()`
`final Boolean`	`getCheckedCoherent()`
`final Unit`	`setCheckedCoherent(Boolean checkedCoherent)`
`final Boolean`	`getFoundDeclarations()`
`final Unit`	`setFoundDeclarations(Boolean foundDeclarations)`
`final Boolean`	`getElaboratedInstructions()`
`final Unit`	`setElaboratedInstructions(Boolean elaboratedInstructions)`
`final Unit`	`coherentStepDeclarations()`
`Unit`	`checkInputBindings()`
`Unit`	`checkImplicitOutput(StepDeclaration lastStep)`
`final XProcRuntime`	`runtime()`
`final XProcPipeline`	`getExecutable()`
`final XdmNode`	`description()`
`final List<InputInstruction>`	`getInputs()`
`final InputInstruction`	`getPrimaryInput()`
`final InputInstruction`	`getInput(String port)`
`final List<OutputInstruction>`	`getOutputs()`
`final OutputInstruction`	`getPrimaryOutput()`
`final OutputInstruction`	`getOutput(String port)`
`final OptionInstruction`	`getOption(QName name)`
`Unit`	`import(StepContainerInterface import)`
`ImportFunctionsInstruction`	`importFunctions(URI href, MediaType contentType, String namespace)`
`final Unit`	`addIOType(XProcInstruction instruction)`
`final InputInstruction`	`input()`
`final InputInstruction`	`input(String port, Boolean primary, Boolean sequence)`
`OptionInstruction`	`option(QName name)`
`OptionInstruction`	`option(QName name, XProcExpression staticValue)`
`DeclareStepInstruction`	`declareStep()`
`String`	`toString()`

Methods inherited from class com.xmlcalabash.datamodel.StepDeclaration
depends, getLocation, getName, getStaticOptions, inputs, namedInput, namedOutput, outputs, primaryInput, primaryOutput, rewriteBindings, setName, timeout
Methods inherited from class com.xmlcalabash.datamodel.XProcInstruction
addVariable, addVisibleStepName, addVisibleStepType, fromString, getChildren, getExpandText, getExtensionAttributes, getId, getInscopeNamespaces, getInscopeVariables, getInstructionType, getParent, getPipeinfo, getStepConfig, setExpandText, setExtensionAttribute, setExtensionAttributes, stepAvailable, stepDeclaration
Methods inherited from class com.xmlcalabash.datamodel.CompoundStepDeclaration
atomicStep, atomicStep, choose, findOutputDeclarations, forEach, group, ifInstruction, message, output, output, runStep, tryInstruction, variable, viewport
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeclareStepInstruction

DeclareStepInstruction(XProcInstruction parent)

DeclareStepInstruction

DeclareStepInstruction(XProcInstruction parent, QName type)

DeclareStepInstruction

DeclareStepInstruction(XProcInstruction parent, InstructionConfiguration stepConfig)

Method Detail

getPsviRequired
```
 Boolean getPsviRequired()
```

setPsviRequired

 Unit setPsviRequired(Boolean psviRequired)

getXpathVersion
```
 Double getXpathVersion()
```

setXpathVersion

 Unit setXpathVersion(Double xpathVersion)

getVersion
```
 Double getVersion()
```

setVersion
```
 Unit setVersion(Double version)
```

getType
```
 final QName getType()
```

setType
```
 final Unit setType(QName type)
```

getVisibility
```
 final Visibility getVisibility()
```

setVisibility

 final Unit setVisibility(Visibility visibility)

isAtomic
```
 final Boolean isAtomic()
```

getCheckedCoherent
```
 final Boolean getCheckedCoherent()
```

setCheckedCoherent

 final Unit setCheckedCoherent(Boolean checkedCoherent)

getFoundDeclarations
```
 final Boolean getFoundDeclarations()
```

setFoundDeclarations

 final Unit setFoundDeclarations(Boolean foundDeclarations)

getElaboratedInstructions

 final Boolean getElaboratedInstructions()

setElaboratedInstructions

 final Unit setElaboratedInstructions(Boolean elaboratedInstructions)

coherentStepDeclarations
```
 final Unit coherentStepDeclarations()
```

checkInputBindings
```
 Unit checkInputBindings()
```

checkImplicitOutput

 Unit checkImplicitOutput(StepDeclaration lastStep)

runtime
```
 final XProcRuntime runtime()
```

getExecutable
```
 final XProcPipeline getExecutable()
```

description
```
 final XdmNode description()
```

getInputs

 final List<InputInstruction> getInputs()

getPrimaryInput

 final InputInstruction getPrimaryInput()

getInput

 final InputInstruction getInput(String port)

getOutputs

 final List<OutputInstruction> getOutputs()

getPrimaryOutput

 final OutputInstruction getPrimaryOutput()

getOutput

 final OutputInstruction getOutput(String port)

getOption

 final OptionInstruction getOption(QName name)

import

 Unit import(StepContainerInterface import)

importFunctions

 ImportFunctionsInstruction importFunctions(URI href, MediaType contentType, String namespace)

addIOType

 final Unit addIOType(XProcInstruction instruction)

input
```
 final InputInstruction input()
```

input

 final InputInstruction input(String port, Boolean primary, Boolean sequence)

option
```
 OptionInstruction option(QName name)
```

option

 OptionInstruction option(QName name, XProcExpression staticValue)

declareStep
```
 DeclareStepInstruction declareStep()
```

toString
```
 String toString()
```

Class DeclareStepInstruction

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.xmlcalabash.datamodel.StepDeclaration

Methods inherited from class com.xmlcalabash.datamodel.XProcInstruction

Methods inherited from class com.xmlcalabash.datamodel.CompoundStepDeclaration

Methods inherited from class java.lang.Object

Constructor Detail

DeclareStepInstruction

DeclareStepInstruction

DeclareStepInstruction

Method Detail

getPsviRequired

setPsviRequired

getXpathVersion

setXpathVersion

getVersion

setVersion

getType

setType

getVisibility

setVisibility

isAtomic

getCheckedCoherent

setCheckedCoherent

getFoundDeclarations

setFoundDeclarations

getElaboratedInstructions

setElaboratedInstructions

coherentStepDeclarations

checkInputBindings

checkImplicitOutput

runtime

getExecutable

description

getInputs

getPrimaryInput

getInput

getOutputs

getPrimaryOutput

getOutput

getOption

import

importFunctions

addIOType

input

input

option

option

declareStep

toString