gr.uoa.di.madgik.execution.plan.element
Class ConditionalPlanElement

java.lang.Object
  gr.uoa.di.madgik.execution.plan.element.PlanElementBase
      gr.uoa.di.madgik.execution.plan.element.ConditionalPlanElement

All Implemented Interfaces:

IPlanElement, Observer

public class ConditionalPlanElement
extends PlanElementBase

This class represents a set of flows that are only executed in case their respective conditions are met. The element follows the known pattern of if (IfFlow) / else if (ElseIfFlows) / else (ElseFlow) construct. The if (IfFlow) and else if (ElseIfFlows) flows are only executed in case their respective conditions are met. The else flow (ElseFlow) can be left null. When the execution is started, the conditions of the ConditionalFlows are initialized using the ConditionalFlow.InitializeCondition() method. After that the if (IfFlow) / else if (ElseIfFlows) conditions are evaluated in turn until the first condition that is evaluated o true is found. The respective flow is executed. If none of the conditions are met, the else flow (ElseFlow) is executed if it is available.

Author:

gpapanikos

Nested Class Summary

Nested classes/interfaces inherited from class gr.uoa.di.madgik.execution.plan.element.PlanElementBase

PlanElementBase.ClockType

Nested classes/interfaces inherited from interface gr.uoa.di.madgik.execution.plan.element.IPlanElement

IPlanElement.PlanElementType

Field Summary

IPlanElement	ElseFlow The Else flow.
List<ConditionalFlow>	ElseIfFlows The Else if flows.
ConditionalFlow	IfFlow The If flow.

Constructor Summary

ConditionalPlanElement()

Method Summary

void	ExecuteExtender(ExecutionHandle Handle) Execute extender.
void	FromXML(Element XML) Populate the element from its xml serialization as returned by IPlanElement.ToXML()
void	FromXML(String XML) Populate the element from its xml serialization as returned by IPlanElement.ToXML()
List<ContingencyTrigger>	GetContingencyTriggers() Gets the contingency triggers.
org.slf4j.Logger	GetExtenderLogger() Gets the extender logger.
String	GetID() Gets the id.
Set<String>	GetModifiedVariableNames() Gets the modified variable names of the element and of the elements contained.
String	GetName() Gets the name.
Set<String>	GetNeededVariableNames() Gets the needed variable names of the element and of the elements contained.
IPlanElement.PlanElementType	GetPlanElementType() Gets the plan element type.
IPlanElement	Locate(String ID) Locate the plan element with the provided id.
Set<IPlanElement>	LocateActionElements() Retrieves the Action elements under this elements
void	SetContingencyResourcePick(ExecutionHandle Handle, String Pick) Sets the picked resource in case the IContingencyReaction.ReactionType#Pick reaction is supported
void	SetName(String Name) Sets the name.
IContingencyReaction.ReactionType[]	SupportedContingencyTriggers() Retrieves the supported contingency triggers.
boolean	SupportsContingencyTriggers() Checks if the element supports contingency triggers.
String	ToXML() Serialize to xml the element and all its contained elements
void	Validate() Validate the element and any sub element it contains
void	ValidatePreExecution(ExecutionHandle Handle) Validate the element and any sub element it contains before it is executed

Methods inherited from class gr.uoa.di.madgik.execution.plan.element.PlanElementBase

CheckStatus, Execute, ExecuteWithStateAwareness, GetPerformanceEvent, RegisterToRunningActionElementsRestriction, ResetClocks, StartClock, StopClock, UnregisterToRunningActionElementsRestriction, update

Methods inherited from class java.lang.Object

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

Field Detail

IfFlow

public ConditionalFlow IfFlow

The If flow.

ElseIfFlows

public List<ConditionalFlow> ElseIfFlows

The Else if flows.

ElseFlow

public IPlanElement ElseFlow

The Else flow.

Constructor Detail

ConditionalPlanElement

public ConditionalPlanElement()

Method Detail

FromXML

public void FromXML(String XML)
             throws ExecutionSerializationException

Description copied from interface: IPlanElement

Populate the element from its xml serialization as returned by IPlanElement.ToXML()

Parameters:

XML - the xML serialization

Throws:

ExecutionSerializationException - A serialization error occurred

FromXML

public void FromXML(Element XML)
             throws ExecutionSerializationException

Description copied from interface: IPlanElement

Populate the element from its xml serialization as returned by IPlanElement.ToXML()

Parameters:

XML - the xML serialization

Throws:

ExecutionSerializationException - A serialization error occurred

GetID

public String GetID()

Description copied from interface: IPlanElement

Gets the id.

Returns:

the id of the element

GetName

public String GetName()

Description copied from interface: IPlanElement

Gets the name.

Returns:

the name

GetPlanElementType

public IPlanElement.PlanElementType GetPlanElementType()

Description copied from interface: IPlanElement

Gets the plan element type.

Returns:

the plan element type

Locate

public IPlanElement Locate(String ID)

Description copied from interface: IPlanElement

Locate the plan element with the provided id. If this is the element requested return this instance. Otherwise forward the request to any sub elements contained. If the element does not belong to the hierarchy under this element, return null

Parameters:

ID - the iD

Returns:

the plan element with the provided id. or null if not found

LocateActionElements

public Set<IPlanElement> LocateActionElements()

Description copied from interface: IPlanElement

Retrieves the Action elements under this elements

Returns:

The action ELements

SetName

public void SetName(String Name)

Description copied from interface: IPlanElement

Sets the name.

Parameters:

Name - the name

ToXML

public String ToXML()
             throws ExecutionSerializationException

Description copied from interface: IPlanElement

Serialize to xml the element and all its contained elements

Returns:

the serialization

Throws:

ExecutionSerializationException - A serialization error occurred

Validate

public void Validate()
              throws ExecutionValidationException

Description copied from interface: IPlanElement

Validate the element and any sub element it contains

Throws:

ExecutionValidationException - A validation error occurred

SupportedContingencyTriggers

public IContingencyReaction.ReactionType[] SupportedContingencyTriggers()

Description copied from interface: IPlanElement

Retrieves the supported contingency triggers.

Returns:

the supported contingency triggers types.

SupportsContingencyTriggers

public boolean SupportsContingencyTriggers()

Description copied from interface: IPlanElement

Checks if the element supports contingency triggers.

Returns:

true, if it does

GetContingencyTriggers

public List<ContingencyTrigger> GetContingencyTriggers()

Description copied from interface: IPlanElement

Gets the contingency triggers.

Returns:

the list of contingency trigger that are applicable to the element.

SetContingencyResourcePick

public void SetContingencyResourcePick(ExecutionHandle Handle,
                                       String Pick)
                                throws ExecutionRunTimeException

Description copied from interface: IPlanElement

Sets the picked resource in case the IContingencyReaction.ReactionType#Pick reaction is supported

Parameters:

Handle - the execution handle handle

Pick - the picked resource

Throws:

ExecutionRunTimeException - A runtime error occurred

GetNeededVariableNames

public Set<String> GetNeededVariableNames()

Description copied from interface: IPlanElement

Gets the needed variable names of the element and of the elements contained. These include the variables that are needed to be present for the element and its hierarchy to be executed.

Returns:

the set of the variable names that are needed by this element and its contained elements

GetModifiedVariableNames

public Set<String> GetModifiedVariableNames()

Description copied from interface: IPlanElement

Gets the modified variable names of the element and of the elements contained. These include the variables that are modified by the element and its hierarchy when executed.

Returns:

the set of the variable names that are modified by this element and its contained elements

GetExtenderLogger

public org.slf4j.Logger GetExtenderLogger()

Description copied from class: PlanElementBase

Gets the extender logger.

Specified by:

GetExtenderLogger in class PlanElementBase

Returns:

the logger

ExecuteExtender

public void ExecuteExtender(ExecutionHandle Handle)
                     throws ExecutionRunTimeException,
                            ExecutionInternalErrorException,
                            ExecutionCancelException,
                            ExecutionBreakException

Description copied from class: PlanElementBase

Execute extender. This class is implemented by extenders of the class

Specified by:

ExecuteExtender in class PlanElementBase

Parameters:

Handle - the execution handle

Throws:

ExecutionRunTimeException - A runtime error occurred

ExecutionInternalErrorException - An internal error occurred

ExecutionCancelException - The execution was canceled

ExecutionBreakException - The execution was terminated

ValidatePreExecution

public void ValidatePreExecution(ExecutionHandle Handle)
                          throws ExecutionValidationException

Description copied from interface: IPlanElement

Validate the element and any sub element it contains before it is executed

Parameters:

Handle - the execution handle

Throws:

ExecutionValidationException - A validation error occurred