com.whitestein.lsps.engine

Class PlanHandler

java.lang.Object

com.whitestein.lsps.engine.PlanHandler

public final class PlanHandler
extends Object

Handler class for handling interpretation of Plan.

Author:

rba

Constructor Summary

Constructors

Constructor and Description
PlanHandler(Plan instance, ProcessInterpreterContext pic) Creates new PlanHandler.

Method Summary

Modifier and Type	Method and Description
void	checkState(ProcessingType processingType)
void	deactivate() Deactivates (puts into PlanState.INACTIVE state) the plan if running.
protected Plan	getElement() Returns the go element instance.
protected E	getModel() Returns the model element.
void	inactivate() Inactivates the plan state if the plan is 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()
boolean	preconditionSatisfied() Returns true if the plan precondition is satisfied.
void	run() Starts the plan.
void	setPlanState(PlanState newState) Sets plan state of the handled plan.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanHandler

public PlanHandler(Plan instance,
                   ProcessInterpreterContext pic)

Creates new PlanHandler.

Parameters:

instance - plan instance

pic -

Throws:

NullPointerException - if any argument is null

Method Detail

getElement

protected Plan getElement()

Returns the go element instance.

Returns:

the go element instance

setPlanState

public void setPlanState(PlanState newState)

Sets plan state of the handled plan.

Parameters:

newState -

run

public void run()
         throws ErrorException

Starts the plan.

Throws:

ErrorException

deactivate

public void deactivate()
                throws ErrorException

Deactivates (puts into PlanState.INACTIVE state) the plan if running.

Throws:

ErrorException

inactivate

public void inactivate()

Inactivates the plan state if the plan is in finished state. If the plan is running the method does nothing.

preconditionSatisfied

public boolean preconditionSatisfied()
                              throws ErrorException

Returns true if the plan precondition is satisfied.

Returns:

true if the plan precondition is satisfied

Throws:

ErrorException

RuntimeException - when an interpretation error occurs

checkState

public void checkState(ProcessingType processingType)
                throws ErrorException

Throws:

ErrorException

toString

public String toString()

Overrides:

toString in class Object

isActive

public boolean isActive()

isFinished

public boolean isFinished()

getModel

protected E getModel()

Returns the model element.

Returns:

the model element

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