org.soaplab.services.metadata
Class ParamDef

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

Direct Known Subclasses:

ChoiceParamDef, StdParamDef

public class ParamDef
extends java.lang.Object

A general class defining a parameter for an analysis tool.

Version:

$Id: ParamDef.java,v 1.8 2007/11/12 04:29:14 marsenger Exp $

Author:

Martin Senger

Field Summary

static int	BASE_PARAMETER
static int	CHOICE_LIST_PARAMETER
static int	CHOICE_PARAMETER
CondDef[]	conds
int	createdFor
java.lang.String	dflt
static java.lang.String	ENVAR
static java.lang.String	FALSEVALUE
java.lang.String	id
static int	IO_PARAMETER
static java.lang.String	MANDATORY
static java.lang.String	METHOD
static java.lang.String	NODISPLAY
PropertiesBag	options
static java.lang.String	ORDERING
static int	RANGE_PARAMETER
static java.lang.String	READONLY
static java.lang.String	SEPARATOR
static java.lang.String	SERVER_CLASS
static int	STANDARD_PARAMETER
static java.lang.String	TAG
static java.lang.String	TAGSEPAR
static java.lang.String	TRUEVALUE
java.lang.String	type
static java.lang.String	USE_DEFAULTS

Constructor Summary

ParamDef()
Constructor

Method Summary

void	add(PropertiesBag newOptions)
boolean	canBeRepeatable() This method does nothing much here but it's supposed to be overritten.
boolean	exists(java.lang.String key)
java.lang.String	format(int indent) As toString() but with indentations.
java.lang.String	get(java.lang.String key)
java.lang.String	get(java.lang.String key, int serNo) Several extensions to the convenience methods accessing 'options'.
int	getInt(java.lang.String key)
int	getInt(java.lang.String key, int serNo)
boolean	is(java.lang.String key) Convenient methods for accessing 'options'
boolean	is(java.lang.String key, int serNo)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

METHOD

public static final java.lang.String METHOD

See Also:

Constant Field Values

MANDATORY

public static final java.lang.String MANDATORY

See Also:

Constant Field Values

TAGSEPAR

public static final java.lang.String TAGSEPAR

See Also:

Constant Field Values

USE_DEFAULTS

public static final java.lang.String USE_DEFAULTS

See Also:

Constant Field Values

NODISPLAY

public static final java.lang.String NODISPLAY

See Also:

Constant Field Values

READONLY

public static final java.lang.String READONLY

See Also:

Constant Field Values

SERVER_CLASS

public static final java.lang.String SERVER_CLASS

See Also:

Constant Field Values

ENVAR

public static final java.lang.String ENVAR

See Also:

Constant Field Values

SEPARATOR

public static final java.lang.String SEPARATOR

See Also:

Constant Field Values

ORDERING

public static final java.lang.String ORDERING

See Also:

Constant Field Values

TRUEVALUE

public static final java.lang.String TRUEVALUE

See Also:

Constant Field Values

FALSEVALUE

public static final java.lang.String FALSEVALUE

See Also:

Constant Field Values

BASE_PARAMETER

public static final int BASE_PARAMETER

See Also:

Constant Field Values

STANDARD_PARAMETER

public static final int STANDARD_PARAMETER

See Also:

Constant Field Values

RANGE_PARAMETER

public static final int RANGE_PARAMETER

See Also:

Constant Field Values

IO_PARAMETER

public static final int IO_PARAMETER

See Also:

Constant Field Values

CHOICE_PARAMETER

public static final int CHOICE_PARAMETER

See Also:

Constant Field Values

CHOICE_LIST_PARAMETER

public static final int CHOICE_LIST_PARAMETER

See Also:

Constant Field Values

id

public java.lang.String id

type

public java.lang.String type

dflt

public java.lang.String dflt

conds

public CondDef[] conds

options

public PropertiesBag options

createdFor

public int createdFor

Constructor Detail

ParamDef

public ParamDef()

Constructor

Method Detail

is

public boolean is(java.lang.String key)

Convenient methods for accessing 'options'

is

public boolean is(java.lang.String key,
                  int serNo)

exists

public boolean exists(java.lang.String key)

get

public java.lang.String get(java.lang.String key)

getInt

public int getInt(java.lang.String key)

add

public void add(PropertiesBag newOptions)

get

public java.lang.String get(java.lang.String key,
                            int serNo)

Several extensions to the convenience methods accessing 'options'. The search key is extended by 'serNo' at its end (but only if serNo > 0). If the extended key was not found, a normal (plain) key is tried.

For example, you can look for 'size1' by calling get ('size', 1).

getInt

public int getInt(java.lang.String key,
                  int serNo)

canBeRepeatable

public boolean canBeRepeatable()

This method does nothing much here but it's supposed to be overritten.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

format

public java.lang.String format(int indent)

As toString() but with indentations.