B G I L N O P R T V W X

B

build() - Method in class org.daisy.common.xproc.XProcInput.Builder

Builds the input object

build() - Method in class org.daisy.common.xproc.XProcOutput.Builder

Builds the xproc output object

build() - Method in class org.daisy.common.xproc.XProcPipelineInfo.Builder

Builds the XProcPipelineInfo object

Builder() - Constructor for class org.daisy.common.xproc.XProcInput.Builder

Instantiates a new builder.

Builder(XProcPipelineInfo) - Constructor for class org.daisy.common.xproc.XProcInput.Builder

Instantiates a new builder.

Builder() - Constructor for class org.daisy.common.xproc.XProcOutput.Builder

Builder() - Constructor for class org.daisy.common.xproc.XProcPipelineInfo.Builder

Instantiates a new builder.

G

getCause() - Method in class org.daisy.common.xproc.XProcError

getCode() - Method in class org.daisy.common.xproc.XProcError

getCode() - Method in exception org.daisy.common.xproc.XProcErrorException

getInfo(URI) - Method in interface org.daisy.common.xproc.XProcEngine

Gets the info from the pipeline located at the URI.

getInfo() - Method in interface org.daisy.common.xproc.XProcPipeline

Gets the pipeline info object associated to this pipeline.

getInputPort(String) - Method in class org.daisy.common.xproc.XProcPipelineInfo

Gets the input port.

getInputPorts() - Method in class org.daisy.common.xproc.XProcPipelineInfo

Gets the input ports.

getInputs(String) - Method in class org.daisy.common.xproc.XProcInput

Gets the inputs.

getKind() - Method in class org.daisy.common.xproc.XProcPortInfo

The kind of port.

getLocation() - Method in class org.daisy.common.xproc.XProcError

getMessage() - Method in class org.daisy.common.xproc.XProcError

getMessage() - Method in exception org.daisy.common.xproc.XProcErrorException

getMessageAppender() - Method in interface org.daisy.common.xproc.XProcMonitor

MessageAppender to which the pipeline should append messages.

getName() - Method in class org.daisy.common.xproc.XProcOptionInfo

Gets the name.

getName() - Method in class org.daisy.common.xproc.XProcPortInfo

The port name.

getNamespaceContext() - Method in class org.daisy.common.xproc.XProcOptionInfo

Namespace context for the type and select statements.

getOption(QName) - Method in class org.daisy.common.xproc.XProcPipelineInfo

Gets the option.

getOptions() - Method in class org.daisy.common.xproc.XProcInput

Gets the options.

getOptions() - Method in class org.daisy.common.xproc.XProcPipelineInfo

Gets the options.

getOutputPort(String) - Method in class org.daisy.common.xproc.XProcPipelineInfo

Gets the output port.

getOutputPorts() - Method in class org.daisy.common.xproc.XProcPipelineInfo

Gets the output ports.

getParameterPorts() - Method in class org.daisy.common.xproc.XProcPipelineInfo

Gets the parameter ports.

getParameters(String) - Method in class org.daisy.common.xproc.XProcInput

Gets the parameters.

getResultProvider(String) - Method in class org.daisy.common.xproc.XProcOutput

Gets the result provider for the given port name

getSelect() - Method in class org.daisy.common.xproc.XProcOptionInfo

Gets the select statement.

getType() - Method in class org.daisy.common.xproc.XProcOptionInfo

Gets the value type of the option This corresponds with the "as" attribute in XProc 3.0 (or the XMLCalabash specific "cx:as" attribute for XProc 1.0).

getURI() - Method in class org.daisy.common.xproc.XProcPipelineInfo

Gets the uRI.

getXProcError() - Method in exception org.daisy.common.xproc.XProcErrorException

I

isPrimary() - Method in class org.daisy.common.xproc.XProcPortInfo

Whether it is a primary port.

isRequired() - Method in class org.daisy.common.xproc.XProcOptionInfo

Whether the option is required.

isRequired() - Method in class org.daisy.common.xproc.XProcPortInfo

Whether a connection is required on the port.

isSequence() - Method in class org.daisy.common.xproc.XProcPortInfo

Whether the port can accept/produce a sequence of documents.

L

load(URI) - Method in interface org.daisy.common.xproc.XProcEngine

Loads the pipeline at the given URI.

N

newInputPort(String, boolean, boolean, boolean) - Static method in class org.daisy.common.xproc.XProcPortInfo

Instantiates a new XProcPortInfo for an input port.

newOption(QName, NamespaceContext, String, boolean, String) - Static method in class org.daisy.common.xproc.XProcOptionInfo

newOption(QName, String, boolean, String) - Static method in class org.daisy.common.xproc.XProcOptionInfo

newOption(QName, boolean, String) - Static method in class org.daisy.common.xproc.XProcOptionInfo

newOutputPort(String, boolean, boolean) - Static method in class org.daisy.common.xproc.XProcPortInfo

Instantiates a new XProcPortInfo for an output port.

newParameterPort(String, boolean) - Static method in class org.daisy.common.xproc.XProcPortInfo

Instantiates a new XProcPortInfo for a parameter input port.

O

org.daisy.common.xproc - package org.daisy.common.xproc

XProc-api offers an easy-to-use and comprehensive universal xproc api to interact with the underlying xproc engine.

P

parse(XMLStreamReader) - Static method in class org.daisy.common.xproc.XProcError

R

run(URI, XProcInput) - Method in interface org.daisy.common.xproc.XProcEngine

Runs a pipeline located in a given URI.

run(XProcInput) - Method in interface org.daisy.common.xproc.XProcPipeline

Runs the pipeline on the specified input

run(XProcInput, XProcMonitor, Map<String, String>) - Method in interface org.daisy.common.xproc.XProcPipeline

Runs the pipeline on the specified input

T

toString() - Method in class org.daisy.common.xproc.XProcError

toString() - Method in exception org.daisy.common.xproc.XProcErrorException

toString() - Method in class org.daisy.common.xproc.XProcOptionInfo

V

valueOf(String) - Static method in enum org.daisy.common.xproc.XProcPortInfo.Kind

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.daisy.common.xproc.XProcPortInfo.Kind

Returns an array containing the constants of this enum type, in the order they are declared.

W

withInput(String, Supplier<Source>) - Method in class org.daisy.common.xproc.XProcInput.Builder

With input.

withOption(QName, Object) - Method in class org.daisy.common.xproc.XProcInput.Builder

With option.

withOption(XProcOptionInfo) - Method in class org.daisy.common.xproc.XProcPipelineInfo.Builder

With option.

withOutput(String, Supplier<Result>) - Method in class org.daisy.common.xproc.XProcOutput.Builder

With output.

withParameter(String, QName, String) - Method in class org.daisy.common.xproc.XProcInput.Builder

With parameter.

withPort(XProcPortInfo) - Method in class org.daisy.common.xproc.XProcPipelineInfo.Builder

With port.

withURI(URI) - Method in class org.daisy.common.xproc.XProcPipelineInfo.Builder

With uri.

writeTo(XProcOutput) - Method in interface org.daisy.common.xproc.XProcResult

Writes the output.

X

XProcEngine - Interface in org.daisy.common.xproc

The Interface XProcEngine allows to load XProcPipeline objects to run a pipeline located at a given URI.

XProcError - Class in org.daisy.common.xproc

XProcError() - Constructor for class org.daisy.common.xproc.XProcError

XProcErrorException - Exception in org.daisy.common.xproc

XProcErrorException(XProcError, Throwable) - Constructor for exception org.daisy.common.xproc.XProcErrorException

XProcInput - Class in org.daisy.common.xproc

The Class XProcInput maps ports and options with a value for the pipeline execution, this object is immutable.

XProcInput.Builder - Class in org.daisy.common.xproc

The Class Builder builds XProcInput objects to make them immutable.

XProcMonitor - Interface in org.daisy.common.xproc

Observer object to monitor a pipeline execution

XProcOptionInfo - Class in org.daisy.common.xproc

Contains the information of a given option.

XProcOptionInfo(QName, String, boolean, String) - Constructor for class org.daisy.common.xproc.XProcOptionInfo

XProcOptionInfo(QName, NamespaceContext, String, boolean, String) - Constructor for class org.daisy.common.xproc.XProcOptionInfo

XProcOutput - Class in org.daisy.common.xproc

The Class XProcOutput gives access to the result documents generated after the pipeline exection, this class is immutable.

XProcOutput.Builder - Class in org.daisy.common.xproc

The Class Builder.

XProcPipeline - Interface in org.daisy.common.xproc

XProcPipeline gives access to the pipeline info and allows to run a pipeline.

XProcPipelineInfo - Class in org.daisy.common.xproc

The Class XProcPipelineInfo gives access to the collection of ports and options from a pipeline.

XProcPipelineInfo.Builder - Class in org.daisy.common.xproc

The XProcPipelineInfo Builder allows to build the pipline info, this class is for internal use of the xproc implementation bundle.

XProcPortInfo - Class in org.daisy.common.xproc

Info about an XProc port

XProcPortInfo.Kind - Enum in org.daisy.common.xproc

XProcResult - Interface in org.daisy.common.xproc

The Interface XProcResult gives access to the result of executing the pipeline and the message produced during the process.

B G I L N O P R T V W X