org.daisy.pipeline.script

Class Script

java.lang.Object

org.daisy.pipeline.script.Script

Direct Known Subclasses:

XProcScript

public abstract class Script
extends Object

Script description. Contains scripts metadata and descriptions of inputs, outputs and options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Script.Builder Builder for Script objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Script(String id, String version, String name, String description, String homepage, Map<String,ScriptPort> inputPorts, Map<String,ScriptPort> outputPorts, Map<String,ScriptOption> options, List<String> inputFilesets, List<String> outputFilesets)

Method Summary

Modifier and Type	Method and Description
String	getDescription() The description.
String	getHomepage() The homepage.
String	getId() The ID.
Iterable<String>	getInputFilesets() The input media types.
ScriptPort	getInputPort(String name) Get the input port for the given name.
Iterable<ScriptPort>	getInputPorts() Get all the input ports.
String	getName() The name.
ScriptOption	getOption(String name) Get the option for the given name.
Iterable<ScriptOption>	getOptions() Get all the options.
Iterable<String>	getOutputFilesets() The output media types.
ScriptPort	getOutputPort(String name) Get the output port for the given name.
Iterable<ScriptPort>	getOutputPorts() Get all the input ports.
String	getVersion() The version.
abstract Job.Status	run(ScriptInput input, Map<String,String> properties, MessageAppender messages, JobResultSet.Builder resultBuilder, File resultDir) Run the script with an input
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Script

protected Script(String id,
                 String version,
                 String name,
                 String description,
                 String homepage,
                 Map<String,ScriptPort> inputPorts,
                 Map<String,ScriptPort> outputPorts,
                 Map<String,ScriptOption> options,
                 List<String> inputFilesets,
                 List<String> outputFilesets)

Method Detail

run

public abstract Job.Status run(ScriptInput input,
                               Map<String,String> properties,
                               MessageAppender messages,
                               JobResultSet.Builder resultBuilder,
                               File resultDir)
                        throws IOException

Run the script with an input

Parameters:

propertiess - Properties that may influence the behavior of the script

resultBuilder - For storing the results

Throws:

IOException

getId

public String getId()

The ID.

getVersion

public String getVersion()

The version.

getName

public String getName()

The name.

getDescription

public String getDescription()

The description.

getHomepage

public String getHomepage()

The homepage.

getInputPorts

public Iterable<ScriptPort> getInputPorts()

Get all the input ports.

getInputPort

public ScriptPort getInputPort(String name)

Get the input port for the given name.

getOutputPorts

public Iterable<ScriptPort> getOutputPorts()

Get all the input ports.

getOutputPort

public ScriptPort getOutputPort(String name)

Get the output port for the given name.

getOptions

public Iterable<ScriptOption> getOptions()

Get all the options.

getOption

public ScriptOption getOption(String name)

Get the option for the given name.

getInputFilesets

public Iterable<String> getInputFilesets()

The input media types.

getOutputFilesets

public Iterable<String> getOutputFilesets()

The output media types.

toString

public String toString()

Overrides:

toString in class Object