uk.ac.rdg.resc.jstyx.gridservice.config
Class SGSParam

java.lang.Object
  uk.ac.rdg.resc.jstyx.gridservice.config.SGSParam

public class SGSParam
extends java.lang.Object

Class containing information about the command-line parameters expected by the Styx Grid Service

Author:

Jon Blower $Revision: 534 $ $Date: 2005-12-07 17:53:34 +0000 (Wed, 07 Dec 2005) $ $Log$ Revision 1.4 2005/12/07 17:53:34 jonblower Added type to SGSParam (STRING, INPUT_FILE and OUTPUT_FILE) Revision 1.3 2005/11/10 08:56:41 jonblower Added link to output file Revision 1.2 2005/11/09 17:46:30 jonblower setInputFile() now only works for Options Revision 1.1 2005/11/07 20:59:34 jonblower Refactored SGS config classes to new package

Field Summary

static int	INPUT_FILE
static int	OUTPUT_FILE
static int	STRING

TypeMeaning STRINGPlain string INPUT_FILEFile that the executable will read: must be uploaded OUTPUT_FILEFile that the executable will write: can be downloaded

Method Summary

SGSInput	getInputFile()
java.lang.String	getName()
SGSOutput	getOutputFile()
com.martiansoftware.jsap.Parameter	getParameter()
int	getType() Gets the type of this parameter:
void	setInputFile(SGSInput inputFile) Sets the input file that is linked to this parameter
void	setOutputFile(SGSOutput outputFile) Sets the output file that is linked to this parameter

Methods inherited from class java.lang.Object

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

Field Detail

STRING

public static final int STRING

See Also:

Constant Field Values

INPUT_FILE

public static final int INPUT_FILE

See Also:

Constant Field Values

OUTPUT_FILE

public static final int OUTPUT_FILE

See Also:

Constant Field Values

Method Detail

getParameter

public com.martiansoftware.jsap.Parameter getParameter()

Returns:

the JSAP parameter object associated with this parameter

getName

public java.lang.String getName()

Returns:

the name of this parameter

getType

public int getType()

Gets the type of this parameter:

Type	Meaning
STRING	Plain string
INPUT_FILE	File that the executable will read: must be uploaded
OUTPUT_FILE	File that the executable will write: can be downloaded

Returns:

The parameter type as an integer

setInputFile

public void setInputFile(SGSInput inputFile)
                  throws SGSConfigException

Sets the input file that is linked to this parameter

Throws:

java.lang.NullPointerException - if inputFile is null

SGSConfigException - if this parameter is not an Option, or if the parameter is already linked to an output file

setOutputFile

public void setOutputFile(SGSOutput outputFile)
                   throws SGSConfigException

Sets the output file that is linked to this parameter

Throws:

java.lang.NullPointerException - if outputFile is null

SGSConfigException - if this parameter is not an Option, or if the parameter is already linked to an input file

getInputFile

public SGSInput getInputFile()

Returns:

the input file that is linked to this parameter, or null if this parameter is not linked to an input file

getOutputFile

public SGSOutput getOutputFile()

Returns:

the output file that is linked to this parameter, or null if this parameter is not linked to an output file