org.daisy.pipeline.client.models

Class Script

java.lang.Object

org.daisy.pipeline.client.models.Script

All Implemented Interfaces:

Comparable<Script>

public class Script
extends Object
implements Comparable<Script>

A representation of a Pipeline 2 script.

Author:

jostein

Constructor Summary

Constructors

Constructor and Description
Script(Node scriptXml) Parse the script described by the provided XML document/node.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Script other)
Argument	getArgument(String name) Get an argument (inputs, options or outputs) by its name.
List<Argument>	getArguments() Get all arguments, both inputs and outputs.
String	getDescription()
String	getHomepage()
String	getHref()
String	getId()
List<String>	getInputFilesets()
List<Argument>	getInputs()
String	getNicename()
List<String>	getOutputFilesets()
List<Argument>	getOutputs()
String	getVersion()
static List<Script>	parseScriptsXml(Node scriptsXml) Parse the list of scripts described by the provided XML document/node.
void	setDescription(String description)
void	setHomepage(String homepage)
void	setHref(String href)
void	setId(String id)
void	setInputFilesets(List<String> inputFilesets)
void	setInputs(List<Argument> inputs)
void	setNicename(String nicename)
void	setOutputFilesets(List<String> outputFilesets)
void	setOutputs(List<Argument> outputs)
void	setVersion(String version)
Document	toXml()

Methods inherited from class java.lang.Object

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

Constructor Detail

Script

public Script(Node scriptXml)
       throws Pipeline2Exception

Parse the script described by the provided XML document/node. Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/script.xml

Parameters:

scriptXml -

Throws:

Pipeline2Exception

Method Detail

getArgument

public Argument getArgument(String name)

Get an argument (inputs, options or outputs) by its name.

Parameters:

name -

kind -

Returns:

parseScriptsXml

public static List<Script> parseScriptsXml(Node scriptsXml)
                                    throws Pipeline2Exception

Parse the list of scripts described by the provided XML document/node. Example: http://daisy-pipeline.googlecode.com/hg/webservice/samples/xml-formats/scripts.xml

Parameters:

response -

Returns:

Throws:

Pipeline2Exception

compareTo

public int compareTo(Script other)

Specified by:

compareTo in interface Comparable<Script>

getId

public String getId()

getHref

public String getHref()

getInputFilesets

public List<String> getInputFilesets()

getOutputFilesets

public List<String> getOutputFilesets()

getNicename

public String getNicename()

getDescription

public String getDescription()

getVersion

public String getVersion()

getHomepage

public String getHomepage()

getInputs

public List<Argument> getInputs()

getOutputs

public List<Argument> getOutputs()

setId

public void setId(String id)

setHref

public void setHref(String href)

setInputFilesets

public void setInputFilesets(List<String> inputFilesets)

setOutputFilesets

public void setOutputFilesets(List<String> outputFilesets)

setNicename

public void setNicename(String nicename)

setDescription

public void setDescription(String description)

setVersion

public void setVersion(String version)

setHomepage

public void setHomepage(String homepage)

setInputs

public void setInputs(List<Argument> inputs)

setOutputs

public void setOutputs(List<Argument> outputs)

toXml

public Document toXml()

getArguments

public List<Argument> getArguments()

Get all arguments, both inputs and outputs. See also getInputs and getOutputs.

Returns:

a list of all arguments.