XMLCalabash/com.xmlcalabash.datamodel/DeclareStepInstruction

DeclareStepInstruction

class DeclareStepInstruction(parent: XProcInstruction?, val stepConfig: InstructionConfiguration) : CompoundStepDeclaration, StepContainerInterface(source)

Constructors

constructor(parent: XProcInstruction)

constructor(parent: XProcInstruction, type: QName)

constructor(parent: XProcInstruction?, stepConfig: InstructionConfiguration)

Properties

_extensionAttributes

protected val _extensionAttributes: <Error class: unknown class>

checkedCoherent

var checkedCoherent: Boolean

children

val children: List<XProcInstruction>

elaboratedInstructions

var elaboratedInstructions: Boolean

expandText

var expandText: Boolean?

extensionAttributes

var extensionAttributes: Map<QName, String>

foundDeclarations

var foundDeclarations: Boolean

val id: String

inscopeNamespaces

val inscopeNamespaces: Map<String, NamespaceUri>

inscopeVariables

val inscopeVariables: Map<QName, VariableBindingContainer>

instructionType

val instructionType: QName

isAtomic

val isAtomic: Boolean

location

val location: Location

name

var name: String

parent

val parent: XProcInstruction?

pipeinfo

val pipeinfo: List<XdmNode>

psviRequired

open override var psviRequired: Boolean?

staticOptions

val staticOptions: Map<QName, StaticOptionDetails>

stepConfig

val stepConfig: InstructionConfiguration

type

var type: QName?

version

open override var version: Double?

visibility

var visibility: Visibility?

xpathVersion

open override var xpathVersion: Double?

Functions

addInstruction

protected fun addInstruction(instruction: XProcInstruction, type: QName = instruction.instructionType)

addIOType

fun addIOType(instruction: XProcInstruction)

addVariable

fun addVariable(binding: VariableBindingContainer)

addVisibleStepName

fun addVisibleStepName(decl: StepDeclaration)

addVisibleStepType

fun addVisibleStepType(decl: DeclareStepInstruction)

atomicStep

open fun atomicStep(type: QName): AtomicStepInstruction

open fun atomicStep(type: QName, name: String): AtomicStepInstruction

checkImplicitOutput

open override fun checkImplicitOutput(lastStep: StepDeclaration)

checkInputBindings

open override fun checkInputBindings()

checkOpen

protected fun checkOpen()

choose

open fun choose(): ChooseInstruction

coherentPortDeclarations

protected fun coherentPortDeclarations(portList: List<PortBindingContainer>, error: (String) -> XProcError)

coherentStepDeclarations

fun coherentStepDeclarations()

declareStep

open override fun declareStep(): DeclareStepInstruction

defaultReadablePort

protected open fun defaultReadablePort(): PortBindingContainer?

depends

fun depends(steplist: String)

elaborateInstructionInfo

protected fun elaborateInstructionInfo()

findAlternativeStepDeclarations

protected fun findAlternativeStepDeclarations(stepTypes: Map<QName, DeclareStepInstruction>, stepNames: Map<String, StepDeclaration>, bindings: Map<QName, VariableBindingContainer>)

findOutputDeclarations

open fun findOutputDeclarations(): OutputInstruction?

findStepDeclaration

protected fun findStepDeclaration(stepType: QName): DeclareStepInstruction?

findStepNames

protected fun findStepNames(stepNames: Map<String, StepDeclaration>): Map<String, StepDeclaration>

forEach

open fun forEach(): ForEachInstruction

getExecutable

fun getExecutable(): XProcPipeline

getInput

fun getInput(port: String): InputInstruction?

getInputs

fun getInputs(): List<InputInstruction>

getOption

fun getOption(name: QName): OptionInstruction?

getOptions

fun getOptions(): List<OptionInstruction>

getOutput

fun getOutput(port: String): OutputInstruction?

getOutputs

fun getOutputs(): List<OutputInstruction>

getPrimaryInput

fun getPrimaryInput(): InputInstruction?

getPrimaryOutput

fun getPrimaryOutput(): OutputInstruction?

group

open fun group(): GroupInstruction

ifInstruction

open fun ifInstruction(): IfInstruction

import

open override fun import(import: StepContainerInterface)

importFunctions

open override fun importFunctions(href: URI, contentType: MediaType?, namespace: String?): ImportFunctionsInstruction

input

fun input(): InputInstruction

fun input(port: String, primary: Boolean? = null, sequence: Boolean? = null): InputInstruction

inputs

fun inputs(): List<PortBindingContainer>

message

open fun message(message: XProcAvtExpression)

namedInput

fun namedInput(name: String): PortBindingContainer?

namedOutput

fun namedOutput(name: String): PortBindingContainer?

option

open override fun option(name: QName): OptionInstruction

open override fun option(name: QName, staticValue: XProcExpression): OptionInstruction

output

open fun output(port: String? = null): OutputInstruction

open fun output(port: String, primary: Boolean? = null, sequence: Boolean = false): OutputInstruction

outputs

fun outputs(): List<PortBindingContainer>

primaryInput

open fun primaryInput(): PortBindingContainer?

primaryOutput

open fun primaryOutput(): PortBindingContainer?

resolveAnonymousWithInput

protected fun resolveAnonymousWithInput()

rewriteBindings

open fun rewriteBindings(): List<AtomicStepInstruction>

runStep

open fun runStep(): RunInstruction

runtime

fun runtime(): XProcRuntime

setExtensionAttribute

fun setExtensionAttribute(name: QName, value: String)

sinkUnreadablePort

protected open fun sinkUnreadablePort(wo: PortBindingContainer)

sinkUnreadPorts

protected fun sinkUnreadPorts()

stepAvailable

fun stepAvailable(name: QName): Boolean

stepDeclaration

fun stepDeclaration(name: QName): DeclareStepInstruction?

timeout

fun timeout(value: String)

toString

open override fun toString(): String

tryInstruction

open fun tryInstruction(): TryInstruction

untilInstruction

open fun untilInstruction(): UntilInstruction

updateStepConfig

protected fun updateStepConfig(stepTypes: Map<QName, DeclareStepInstruction>, stepNames: Map<String, StepDeclaration>, bindings: Map<QName, VariableBindingContainer>)

variable

open fun variable(name: QName): VariableInstruction

variableBindings

protected open fun variableBindings(expr: XProcExpression, step: StepDeclaration)

viewport

open fun viewport(): ViewportInstruction

whileInstruction

open fun whileInstruction(): WhileInstruction

withInput

open fun withInput(): WithInputInstruction

open fun withInput(port: String? = null): WithInputInstruction

withOutput

fun withOutput(): WithOutputInstruction