org.retro.gis.tools
Interface ActionTreeNode

All Known Implementing Classes:

BasicActionNode

public interface ActionTreeNode

ActionTreeNode is an interface for a Action command, recursion is used heavily to traverse other nodes, scheme is used to determine the next action.

See Also:

ActionTree, BasicActionNode

Method Summary

int	countActionPerformed()
boolean	getCanRunAgain() Peek and see if this action can be run again, it will take into account first runs.
java.lang.String	getKey()
int	getLevel()
int	getLevelThreshold()
double	getMaxScoreThreshold()
double	getMinScoreThreshold()
int	getMultipleRunsFlag()
double	getPoints() RunAction should affect the result here
java.lang.Object	runAction() The following methods keep a tab on where these actions have been run.
void	setForceRunFlag(boolean setting)
void	setKey(java.lang.String _newkey)
void	setLevel(int val)
void	setMultipleRunsFlag(int val) Can this action be run more than once?
void	setProcessThreadNode(BotProcessThread _process)
void	setRunFlag(boolean setting)
void	setScoreHitSet(double points, double pass, double fail)
void	setScoreRangeSet(int travel, double _min, double _max) For scanning a possible solution, the min and max values are used to define the threshold for when to stop executing.
int	travelNullSet(int level) Travel down an empty set of actions, shouldn't be used extensively.

Method Detail

travelNullSet

public int travelNullSet(int level)

Travel down an empty set of actions, shouldn't be used extensively.

runAction

public java.lang.Object runAction()
                           throws java.lang.Exception

The following methods keep a tab on where these actions have been run.

• Two checks are performed, 'can run' and 'force run'
• If an action is forced, nothing can prevent it from being run

Return Vector(array)

• 0. CanRunAgain ;; Boolean
• 1. PointValue ;; Double

Returns:

An Object Vector(an array) of post-run objects, including Score(Double), RunAgainFlag(Boolean)

Throws:

java.lang.Exception

See Also:

NullActionImpl

setForceRunFlag

public void setForceRunFlag(boolean setting)

setRunFlag

public void setRunFlag(boolean setting)

countActionPerformed

public int countActionPerformed()

setMultipleRunsFlag

public void setMultipleRunsFlag(int val)

Can this action be run more than once?

getMultipleRunsFlag

public int getMultipleRunsFlag()

getKey

public java.lang.String getKey()

setKey

public void setKey(java.lang.String _newkey)

setScoreRangeSet

public void setScoreRangeSet(int travel,
                             double _min,
                             double _max)
                      throws InvalidScoreException

For scanning a possible solution, the min and max values are used to define the threshold for when to stop executing. A run will stop based on the following conditions:

• Travel level hit, for example 300
• Score value less than the min, for example -1000
• All nodes have been hit and you can traverse again

Throws:

InvalidScoreException

setScoreHitSet

public void setScoreHitSet(double points,
                           double pass,
                           double fail)
                    throws InvalidScoreException

Throws:

InvalidScoreException

getPoints

public double getPoints()
                 throws InvalidScoreException

RunAction should affect the result here

Throws:

InvalidScoreException

setLevel

public void setLevel(int val)

getLevel

public int getLevel()

getLevelThreshold

public int getLevelThreshold()

getMaxScoreThreshold

public double getMaxScoreThreshold()

getMinScoreThreshold

public double getMinScoreThreshold()

getCanRunAgain

public boolean getCanRunAgain()

Peek and see if this action can be run again, it will take into account first runs. You can still force a run, using the force run flag. This value is a reflection of runAction being called.

setProcessThreadNode

public void setProcessThreadNode(BotProcessThread _process)
                          throws java.lang.Exception

Throws:

java.lang.Exception