wt.rule.init
Interface AlgoValue

All Superinterfaces:

InitRuleElem

All Known Implementing Classes:

AbstractAlgoValue

public interface AlgoValue

extends InitRuleElem

Supported API: false

Extendable: false

Field Summary

static String	ALGORITHM Label for the attribute; The name of the algorithm class than can be usd to compute this attribute's value.
static String	ARGS Label for the attribute; The list of arguments that are passed to the algorithm in order to compute this attribute value.

Method Summary

void	addArg(Attr arg) Add the specified value to the list of arguments to be passed to this specification's algorithm.
void	addArg(String arg) Add the specified value to the list of arguments to be passed to this specification's algorithm.
void	addArg(Value arg) Add the specified value to the list of arguments to be passed to this specification's algorithm.
String	getAlgorithm() Gets the value of the attribute: ALGORITHM.
Object	getArg(int index) Returns the arg at the specified position in the argument list.
List	getArgs() Gets the value of the attribute: ARGS.
Object	removeArg(int index) Removes the argument at the specified position in the argument list.
Object	setArg(int index, Object arg) Replaces the argument at the specified position in the argument list with the specified argument.

Methods inherited from interface wt.rule.init.InitRuleElem

getObjType, writeXML

Field Detail

ALGORITHM

public static final String ALGORITHM

Label for the attribute; The name of the algorithm class than can be usd to compute this attribute's value.

Supported API: false

See Also:

Constant Field Values

ARGS

public static final String ARGS

Label for the attribute; The list of arguments that are passed to the algorithm in order to compute this attribute value.

Supported API: false

See Also:

Constant Field Values

Method Detail

getAlgorithm

public String getAlgorithm()

Gets the value of the attribute: ALGORITHM. The name of the algorithm class than can be usd to compute this attribute's value.

Supported API: false

Returns:

String

getArgs

public List getArgs()

Gets the value of the attribute: ARGS. The list of arguments that are passed to the algorithm in order to compute this attribute value.

Supported API: false

Returns:

List

addArg

public void addArg(String arg)

Add the specified value to the list of arguments to be passed to this specification's algorithm.

Supported API: false

Parameters:

arg - an argument for this specification's algorithm

addArg

public void addArg(Attr arg)

Add the specified value to the list of arguments to be passed to this specification's algorithm.

Supported API: false

Parameters:

arg -

addArg

public void addArg(Value arg)

Add the specified value to the list of arguments to be passed to this specification's algorithm.

Supported API: false

Parameters:

arg -

getArg

public Object getArg(int index)
              throws IndexOutOfBoundsException

Returns the arg at the specified position in the argument list.

Supported API: false

Parameters:

index - index of argument to return

Returns:

Object

Throws:

IndexOutOfBoundsException

setArg

public Object setArg(int index,
                     Object arg)
              throws IndexOutOfBoundsException,
                     IllegalArgumentException

Replaces the argument at the specified position in the argument list with the specified argument. Returns the argument previously at the specified position.

Supported API: false

Parameters:

index - index of argument to replace

arg - argument to be stored at the specified position

Returns:

Object

Throws:

IndexOutOfBoundsException

IllegalArgumentException

removeArg

public Object removeArg(int index)
                 throws IndexOutOfBoundsException

Removes the argument at the specified position in the argument list. Shifts any subsequent arguments to the left (subtracts one from their indices). Returns the argument that was removed from the list.

Supported API: false

Parameters:

index - the index of the argument to removed

Returns:

Object

Throws:

IndexOutOfBoundsException