org.soaplab.services.metadata
Class IOParamDef

java.lang.Object
  org.soaplab.services.metadata.ParamDef
      org.soaplab.services.metadata.StdParamDef
          org.soaplab.services.metadata.IOParamDef

public class IOParamDef
extends StdParamDef

A data structure defining input/output types of an analysis tools. For input data, it defines how to feed an application with the input data, and for output, it specifies where to catch the output data from an application.

Supported types are:

 input    an input data which are not eaten by the app's standard input
 stdin    send data to app's standard input
 output   an output data which are not produced by standard stream
 stdout   catch data from app's standard output
 stderr   catch data from app's standard error stream

Version:

$Id: IOParamDef.java,v 1.13 2007/12/04 16:26:57 marsenger Exp $

Author:

Martin Senger

Field Summary

static int	FORMAT_DIRECT
static int	FORMAT_UNSPECIFIED
static int	FORMAT_URL
static java.lang.String	INPUT_ADAPTOR An option name.
int	ioFormat
int	ioType
static java.lang.String	OUTPUT_ADAPTOR An option name.
static java.lang.String	SPECIAL_TYPE An option name.
static int	TYPE_INPUT Input/output types.
static int	TYPE_OUTPUT
static int	TYPE_STDERR
static int	TYPE_STDIN
static int	TYPE_STDOUT

Fields inherited from class org.soaplab.services.metadata.StdParamDef

lists, repeat

Fields inherited from class org.soaplab.services.metadata.ParamDef

BASE_PARAMETER, CHOICE_LIST_PARAMETER, CHOICE_PARAMETER, conds, createdFor, dflt, ENVAR, FALSEVALUE, id, IO_PARAMETER, MANDATORY, METHOD, NODISPLAY, options, ORDERING, RANGE_PARAMETER, READONLY, SEPARATOR, SERVER_CLASS, STANDARD_PARAMETER, TAG, TAGSEPAR, TRUEVALUE, type, USE_DEFAULTS

Constructor Summary

IOParamDef()
A default constructor.

Method Summary

java.lang.String	format(int indent) As toString() but with indentations.
java.lang.String	getIOFormatAsString()
java.lang.String	getIOTypeAsString()
java.lang.String	getStrippedName() Return the beginning of its own name, stripped of the endings indicating the 'ioFormat' type.
boolean	isDirectData() Return true if this definition represents direct data (and not reference nor unspecified data).
boolean	isInput() Return true if this definition represents an input (either a regular or a standard input).
boolean	isOutput() Return true if this definition represents an output (either a regular or a standard stream).
boolean	isReferenceData() Return true if this definition represents reference data (and not direct nor unspecified data).
boolean	isRegularInput() Return true if this definition represents a regular input (which excludes the standard input).
boolean	isRegularOutput() Return true if this definition represents a regular output (which excludes the standard output and standard error output).
boolean	isStandardStream() Return true if this definition represents any of the standard streams.
boolean	isStderr() Return true if this definition represents a standard error.
boolean	isStdin() Return true if this definition represents a standard input.
boolean	isStdout() Return true if this definition represents a standard output.
java.lang.String	toString()

Methods inherited from class org.soaplab.services.metadata.StdParamDef

canBeRepeatable

Methods inherited from class org.soaplab.services.metadata.ParamDef

add, exists, get, get, getInt, getInt, is, is

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INPUT_ADAPTOR

public static final java.lang.String INPUT_ADAPTOR

An option name. Its value (of type String) is a class name of an adaptor for pre-processing an input.

See Also:

Constant Field Values

OUTPUT_ADAPTOR

public static final java.lang.String OUTPUT_ADAPTOR

An option name. Its value (of type String) is a class name of an adaptor for post-processing an output (result).

See Also:

Constant Field Values

SPECIAL_TYPE

public static final java.lang.String SPECIAL_TYPE

An option name. Its value (of type String) makes this output special. Usual value is "url" which means that the output should be made also available as an HTTP/GET target.

See Also:

Constant Field Values

TYPE_INPUT

public static final int TYPE_INPUT

Input/output types.

See Also:

Constant Field Values

TYPE_STDIN

public static final int TYPE_STDIN

See Also:

Constant Field Values

TYPE_OUTPUT

public static final int TYPE_OUTPUT

See Also:

Constant Field Values

TYPE_STDOUT

public static final int TYPE_STDOUT

See Also:

Constant Field Values

TYPE_STDERR

public static final int TYPE_STDERR

See Also:

Constant Field Values

FORMAT_DIRECT

public static final int FORMAT_DIRECT

See Also:

Constant Field Values

FORMAT_URL

public static final int FORMAT_URL

See Also:

Constant Field Values

FORMAT_UNSPECIFIED

public static final int FORMAT_UNSPECIFIED

See Also:

Constant Field Values

ioType

public int ioType

ioFormat

public int ioFormat

Constructor Detail

IOParamDef

public IOParamDef()

A default constructor.

Method Detail

getIOTypeAsString

public java.lang.String getIOTypeAsString()

getIOFormatAsString

public java.lang.String getIOFormatAsString()

isInput

public boolean isInput()

Return true if this definition represents an input (either a regular or a standard input).

isOutput

public boolean isOutput()

Return true if this definition represents an output (either a regular or a standard stream).

isRegularInput

public boolean isRegularInput()

Return true if this definition represents a regular input (which excludes the standard input).

isStdout

public boolean isStdout()

Return true if this definition represents a standard output.

isStderr

public boolean isStderr()

Return true if this definition represents a standard error.

isStdin

public boolean isStdin()

Return true if this definition represents a standard input.

isRegularOutput

public boolean isRegularOutput()

Return true if this definition represents a regular output (which excludes the standard output and standard error output).

isStandardStream

public boolean isStandardStream()

Return true if this definition represents any of the standard streams.

isDirectData

public boolean isDirectData()

Return true if this definition represents direct data (and not reference nor unspecified data).

isReferenceData

public boolean isReferenceData()

Return true if this definition represents reference data (and not direct nor unspecified data).

getStrippedName

public java.lang.String getStrippedName()

Return the beginning of its own name, stripped of the endings indicating the 'ioFormat' type.

toString

public java.lang.String toString()

Overrides:

toString in class StdParamDef

format

public java.lang.String format(int indent)

As toString() but with indentations.

Overrides:

format in class StdParamDef