org.trianacode.enactment

Class CommandLineExec

java.lang.Object

org.trianacode.enactment.TrianaExec

org.trianacode.enactment.CommandLineExec

public class CommandLineExec
extends TrianaExec

A standalone class for executing a taskgraph using specified input data.

Nested Class Summary

Nested classes/interfaces inherited from class org.trianacode.enactment.TrianaExec

TrianaExec.ExecRun

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_LENGTH

Fields inherited from class org.trianacode.enactment.TrianaExec

DATA_SLEEP_TIME

Constructor Summary

Constructors

Constructor and Description
CommandLineExec(java.lang.String appname, TaskGraph taskgraph) Constructs a TrianaExec to execute a clone of the specified taskgraph.
CommandLineExec(java.lang.String appname, Tool tool) Constructs a TrianaExec to execute a clone of the specified tool.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription(java.lang.String map)
java.lang.String	getFullDescription(java.lang.String map)
java.lang.String	getHelpMessage()
java.lang.String	getItemTag(java.lang.String map)
java.lang.String[]	getMappedParameters(java.lang.String map)
java.lang.Object	getMappedValue(java.lang.String map, java.lang.String paramname)
int	getNumberOfRequiredArguments()
java.lang.Object	getParameter(java.lang.String paramname)
java.lang.String	initParameters(java.lang.String[] args) Initialises the parameters for the specified command line arguments.
boolean	isMapped(java.lang.String map)
boolean	isMappedValue(java.lang.String map, java.lang.String paramname)
static void	main(java.lang.String[] args)
void	mapParameter(java.lang.String map, java.lang.String paramname) Maps a parameter of the form groupname.taskname.paramname to a simple string (e.g.
void	mapParameter(java.lang.String map, java.lang.String paramname, java.lang.Object value) Maps a parameter of the form groupname.taskname.paramname to a simple string (e.g.
void	removeDescription(java.lang.String map) Removes the description for the specified map
void	setDescription(java.lang.String map, java.lang.String description) Sets a description for the specified map string.
void	setNumberOfRequiredArguments(int argnum) Sets the number of required arguments
void	setParameter(java.lang.String paramname, java.lang.Object value) Sets the specified parameter, where paramname is a mapped paramname or of the form groupname.taskname.paramname
void	unmap(java.lang.String map) Unmaps all the mappings from a string.

Methods inherited from class org.trianacode.enactment.TrianaExec

dispose, getDummyToolName, getTask, getTaskGraph, isFinished, run, run, setDummyToolName

Methods inherited from class java.lang.Object

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

Field Detail

MAX_LENGTH

public static int MAX_LENGTH

Constructor Detail

CommandLineExec

public CommandLineExec(java.lang.String appname,
               TaskGraph taskgraph)
                throws TaskGraphException

Constructs a TrianaExec to execute a clone of the specified taskgraph. Uses a default tool table

Throws:

TaskGraphException

CommandLineExec

public CommandLineExec(java.lang.String appname,
               Tool tool)
                throws TaskGraphException

Constructs a TrianaExec to execute a clone of the specified tool. Uses a default tool table.

Throws:

TaskGraphException

Method Detail

setNumberOfRequiredArguments

public void setNumberOfRequiredArguments(int argnum)

Sets the number of required arguments

getNumberOfRequiredArguments

public int getNumberOfRequiredArguments()

Returns:

the number of required arguments

setParameter

public void setParameter(java.lang.String paramname,
                java.lang.Object value)

Sets the specified parameter, where paramname is a mapped paramname or of the form groupname.taskname.paramname

getParameter

public java.lang.Object getParameter(java.lang.String paramname)

Returns:

the specified parameter value, where paramname is a mapped paramname or of the form groupname.taskname.paramname (returns null if parameter not set). Note that if the paramname is mapped to multiple parameters then the value of one is returned (but it is not defined which one!).

mapParameter

public void mapParameter(java.lang.String map,
                java.lang.String paramname)

Maps a parameter of the form groupname.taskname.paramname to a simple string (e.g. file). At the commandline the application user can write java TrianaExec -file afile.dat taskgraph.xml, as opposed to the full parameter name. Note that a string can be mapped to multiple parameter names. Also note that the preceeding - should not be included in the map string.

mapParameter

public void mapParameter(java.lang.String map,
                java.lang.String paramname,
                java.lang.Object value)

Maps a parameter of the form groupname.taskname.paramname to a simple string (e.g. verbose), along with the value that the parameter is set to (e.g. new Boolean(true)). At the commandline the application user can write java TrianaExec -verbose taskgraph.xml. Note that a string can be mapped to multiple parameter names+values.

unmap

public void unmap(java.lang.String map)

Unmaps all the mappings from a string.

isMapped

public boolean isMapped(java.lang.String map)

Returns:

true if the specified string is a map

getMappedParameters

public java.lang.String[] getMappedParameters(java.lang.String map)

Returns:

the parameter names mapped to the specified map

isMappedValue

public boolean isMappedValue(java.lang.String map,
                    java.lang.String paramname)

Returns:

the value mapped to the specified map/paramname pair (or null if not specified)

getMappedValue

public java.lang.Object getMappedValue(java.lang.String map,
                              java.lang.String paramname)

Returns:

the value mapped to the specified map/paramname pair (or null if not specified)

setDescription

public void setDescription(java.lang.String map,
                  java.lang.String description)

Sets a description for the specified map string. This description can take the form " main description" if required.

removeDescription

public void removeDescription(java.lang.String map)

Removes the description for the specified map

getFullDescription

public java.lang.String getFullDescription(java.lang.String map)

Returns:

the full description string for the specified map

getDescription

public java.lang.String getDescription(java.lang.String map)

Returns:

the description string for the specified map. If the description string was specified as " main description" then only the main description is returned.

getItemTag

public java.lang.String getItemTag(java.lang.String map)

Returns:

the item tag for the specified map if the description was specified as " main description". Otherwise null is returned.

initParameters

public java.lang.String initParameters(java.lang.String[] args)

Initialises the parameters for the specified command line arguments.

Returns:

either a help message or error message, or null if no message is needed.

getHelpMessage

public java.lang.String getHelpMessage()

main

public static void main(java.lang.String[] args)