org.daisy.common.transform

Interface XMLTransformer

All Known Implementing Classes:

SingleInSingleOutXMLTransformer

public interface XMLTransformer

Transform a number of input values to output values, at least one input or output being XML or convertable to/from XML. Note that this interface does not extend javax.xml.transform.Transformer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	XMLTransformer.InputType
static interface	XMLTransformer.OutputType

Method Summary

Modifier and Type	Method and Description
default Runnable	transform(InputValue<?> input, OutputValue<?> output)
Runnable	transform(Map<QName,InputValue<?>> input, Map<QName,OutputValue<?>> output)
static Map<QName,InputValue<?>>	validateInput(Map<QName,InputValue<?>> input, Map<QName,XMLTransformer.InputType> types) Check that the expected inputs are present and are of the expected type.
static Map<QName,OutputValue<?>>	validateOutput(Map<QName,OutputValue<?>> output, Map<QName,XMLTransformer.OutputType> types) Check that the expected outputs are present and are of the expected type.

Method Detail

transform

Runnable transform(Map<QName,InputValue<?>> input,
                   Map<QName,OutputValue<?>> output)

Parameters:

input - Supplier of XDM values as a map from port name (QName) to InputValue object. If the map returns null for a certain key it means that port is not connected. If the map itself is null it means no input ports are connected.

output - Consumer of XDM values as a map from port name (QName) to OutputValue object. If the map returns null for a certain key it means that port is not connected. If the map itself is null it means no output ports are connected.

Returns:

a Runnable that executes the transformation. Transformations can be run inside threads to keep the buffers between transformers small. If not run inside threads, the transformations must be executed in the correct order. Runnable.run() may throw a TransformerException if an input could not be read, the transformation failed, or an output could not be written.

Throws:

IllegalArgumentException - if an invalid input or output value was provided or if an input or output value is missing.

transform

default Runnable transform(InputValue<?> input,
                           OutputValue<?> output)

validateInput

static Map<QName,InputValue<?>> validateInput(Map<QName,InputValue<?>> input,
                                              Map<QName,XMLTransformer.InputType> types)
                                       throws IllegalArgumentException

Check that the expected inputs are present and are of the expected type.

Throws:

IllegalArgumentException

validateOutput

static Map<QName,OutputValue<?>> validateOutput(Map<QName,OutputValue<?>> output,
                                                Map<QName,XMLTransformer.OutputType> types)
                                         throws IllegalArgumentException

Check that the expected outputs are present and are of the expected type.

Throws:

IllegalArgumentException