com.whitestein.lsps.engine

Class AchieveGoalHandler

java.lang.Object

com.whitestein.lsps.engine.AchieveGoalHandler

public final class AchieveGoalHandler
extends Object

Class for AchieveGoal handlers.

Author:

rba

Constructor Summary

Constructors

Constructor and Description
AchieveGoalHandler(Goal instance, com.whitestein.lsps.engine.GoalAchieveStrategy achieveStrategy, ProcessInterpreterContext pic) Creates new AchieveGoalHandler.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates the goal.
void	checkState(ProcessingType processingType)
void	deactivate() Deactivates the goal and its achieve strategy.
protected com.whitestein.lsps.engine.GoalAchieveStrategy	getAchieveStrategy() Returns goal achieve strategy of this handler.
protected Goal	getElement() Returns the go element instance.
protected GoalState	getGoalState() Returns goal state of the handled goal.
protected com.whitestein.lsps.model.AchieveGoal	getModel() Returns the model element.
void	inactivate() Inactivates the goal and its achieve strategy if in finished state.
protected boolean	interpret(Expression expression, ExpressionOrigin origin, boolean defaultValue, InterpreterStackTrace stackTrace) Interprets given boolean expression.
protected Object	interpret(Expression expression, ExpressionOrigin origin, InterpreterStackTrace stackTrace) Interprets given boolean expression.
boolean	isActive()
boolean	isFinished()
void	setGoalState(GoalState newState) Sets goal state of the handled goal.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AchieveGoalHandler

public AchieveGoalHandler(Goal instance,
                          com.whitestein.lsps.engine.GoalAchieveStrategy achieveStrategy,
                          ProcessInterpreterContext pic)

Creates new AchieveGoalHandler.

Parameters:

instance - achieve goal instance

achieveStrategy - achieve goal strategy

pic -

Throws:

NullPointerException - if any argument is null

Method Detail

getModel

protected com.whitestein.lsps.model.AchieveGoal getModel()

Returns the model element.

Returns:

the model element

checkState

public void checkState(ProcessingType processingType)
                throws ErrorException

Throws:

ErrorException

getElement

protected Goal getElement()

Returns the go element instance.

Returns:

the go element instance

getAchieveStrategy

protected final com.whitestein.lsps.engine.GoalAchieveStrategy getAchieveStrategy()

Returns goal achieve strategy of this handler.

Returns:

goal achieve strategy of this handler

getGoalState

protected final GoalState getGoalState()

Returns goal state of the handled goal.

Returns:

goal state of the handled goal

setGoalState

public final void setGoalState(GoalState newState)

Sets goal state of the handled goal.

Parameters:

newState -

activate

public final void activate()

Activates the goal.

deactivate

public final void deactivate()
                      throws ErrorException

Deactivates the goal and its achieve strategy. If the goal is in finished state then the goal stays in its state. Otherwise the goal goes to GoalState.DEACTIVATED state.

Throws:

ErrorException

inactivate

public final void inactivate()

Inactivates the goal and its achieve strategy if in finished state. If the goal is active the method does nothing.

isActive

public boolean isActive()

isFinished

public boolean isFinished()

toString

public String toString()

Overrides:

toString in class Object

interpret

protected boolean interpret(Expression expression,
                            ExpressionOrigin origin,
                            boolean defaultValue,
                            InterpreterStackTrace stackTrace)
                     throws ErrorException

Interprets given boolean expression.

Parameters:

expression -

origin -

defaultValue -

stackTrace -

Returns:

the result of interpretation or defaultValue if the expression is null

Throws:

ErrorException

IllegalArgumentException - if the result of interpretation is not boolean

interpret

protected Object interpret(Expression expression,
                           ExpressionOrigin origin,
                           InterpreterStackTrace stackTrace)
                    throws ErrorException

Interprets given boolean expression. Returns null if the expression is null.

Parameters:

expression -

origin -

stackTrace -

Returns:

the result of interpretation

Throws:

ErrorException