common.logic

Class DefaultExitCondition

java.lang.Object

common.logic.DefaultExitCondition

All Implemented Interfaces:

ExitCondition

public class DefaultExitCondition
extends java.lang.Object
implements ExitCondition

The default exit condition used by the loop unit.

Constructor Summary

Constructors

Constructor and Description
DefaultExitCondition()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getParameter(java.lang.String paramname)
static java.lang.String	getStack(java.util.ArrayList list)
Task	getTask()
void	init() Called when the loop is initialised (before any iterations are run)
boolean	isExitLoop(java.lang.Object[] data) Calculates whether the loop should exit.
void	iteration() Called when an iteration is run
void	setTask(Task task) Sets an interface to the loop task

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultExitCondition

public DefaultExitCondition()

Method Detail

setTask

public void setTask(Task task)

Sets an interface to the loop task

Specified by:

setTask in interface ExitCondition

getTask

public Task getTask()

Specified by:

getTask in interface ExitCondition

Returns:

an interface to the loop task

init

public void init()
          throws InvalidEquationException

Called when the loop is initialised (before any iterations are run)

Specified by:

init in interface ExitCondition

Throws:

InvalidEquationException

iteration

public void iteration()
               throws InvalidEquationException

Called when an iteration is run

Specified by:

iteration in interface ExitCondition

Throws:

InvalidEquationException

isExitLoop

public boolean isExitLoop(java.lang.Object[] data)
                   throws InvalidEquationException

Calculates whether the loop should exit. This decision can be based on a any factors, including the parameters of the loop task and other tasks.

Specified by:

isExitLoop in interface ExitCondition

Returns:

true if the loop should exit

Throws:

InvalidEquationException

getParameter

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

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!).

Throws:

InvalidEquationException

getStack

public static java.lang.String getStack(java.util.ArrayList list)