ch.tatool.app.service.exec.impl

Class ExecutionContextImpl

java.lang.Object

ch.tatool.app.service.exec.impl.ExecutionContextImpl

All Implemented Interfaces:

PropertyHolder, ExecutionContext

public class ExecutionContextImpl
extends Object
implements ExecutionContext

Execution context object This is sort of a one stop shop for elements during execution. Please note that the context can change from one to the next execution, therefore do not cache the object inside the element.

Author:

Michael Ruflin

Constructor Summary

Constructors

Constructor and Description
ExecutionContextImpl(ExecutorImpl executor, ExecutionData executionData, DataService dataService, ExecutionDisplay executionDisplay)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearProperties() Clear all properties
Element	getActiveElement() Get the active Element.
Executable	getActiveExecutable() Get the currently scheduled or executed ExecutableElement.
DataService	getDataService() Get the data service that allows access to the data layer of Tatool.
List<Element>	getElementStack() Get the element stack, the stack of elements being executed.
ExecutionData	getExecutionData() Get access to the execution data.
ExecutionDisplay	getExecutionDisplay() Get the display object that allows the elements to interact with the display.
Executor	getExecutor() Get the executor of this module.
String	getId() Get the id of this property holder, usable to store the property in a DataContainer.
Set<String>	getKeys() Get all properties contained in this holder
ExecutionPhase	getPhase() Get the current phase of the execution.
Object	getProperty(String name) Get a specific element property.
void	removeProperty(String name) Remove the property for the given key.
void	setPhase(ExecutionPhase executionPhase)
void	setProperty(String name, Object value) Set a specific element property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionContextImpl

public ExecutionContextImpl(ExecutorImpl executor,
                    ExecutionData executionData,
                    DataService dataService,
                    ExecutionDisplay executionDisplay)

Method Detail

getId

public String getId()

Description copied from interface: PropertyHolder

Get the id of this property holder, usable to store the property in a DataContainer. The id can be arbitrary. For tree structures it is encouraged to concatenate the node ids to form unique ids among the complete tree structure.

Specified by:

getId in interface PropertyHolder

getProperty

public Object getProperty(String name)

Description copied from interface: PropertyHolder

Get a specific element property.

Specified by:

getProperty in interface PropertyHolder

Returns:

the property value or null if the property is not present.

setProperty

public void setProperty(String name,
               Object value)

Description copied from interface: PropertyHolder

Set a specific element property.

Specified by:

setProperty in interface PropertyHolder

removeProperty

public void removeProperty(String name)

Description copied from interface: PropertyHolder

Remove the property for the given key.

Specified by:

removeProperty in interface PropertyHolder

getKeys

public Set<String> getKeys()

Get all properties contained in this holder

Specified by:

getKeys in interface PropertyHolder

clearProperties

public void clearProperties()

Clear all properties

Specified by:

clearProperties in interface PropertyHolder

getPhase

public ExecutionPhase getPhase()

Description copied from interface: ExecutionContext

Get the current phase of the execution.

Specified by:

getPhase in interface ExecutionContext

Returns:

the current phase

setPhase

public void setPhase(ExecutionPhase executionPhase)

getExecutor

public Executor getExecutor()

Description copied from interface: ExecutionContext

Get the executor of this module. Provides access to execution specific functionality.

Specified by:

getExecutor in interface ExecutionContext

Returns:

the Executor object

getDataService

public DataService getDataService()

Description copied from interface: ExecutionContext

Get the data service that allows access to the data layer of Tatool.

Specified by:

getDataService in interface ExecutionContext

Returns:

the DataService object

getExecutionDisplay

public ExecutionDisplay getExecutionDisplay()

Description copied from interface: ExecutionContext

Get the display object that allows the elements to interact with the display.

Specified by:

getExecutionDisplay in interface ExecutionContext

Returns:

the ExecutionDisplay object

getExecutionData

public ExecutionData getExecutionData()

Description copied from interface: ExecutionContext

Get access to the execution data.

Specified by:

getExecutionData in interface ExecutionContext

getActiveExecutable

public Executable getActiveExecutable()

Get the currently scheduled or executed ExecutableElement. This object is available between PRE_PROCESS and POST_PROCESS.

Specified by:

getActiveExecutable in interface ExecutionContext

Returns:

the ExecutableElement object or null

getActiveElement

public Element getActiveElement()

Get the active Element.

Specified by:

getActiveElement in interface ExecutionContext

getElementStack

public List<Element> getElementStack()

Get the element stack, the stack of elements being executed. This object is always available, but empty before and including SESSION_START and after and including SESSION_END

Specified by:

getElementStack in interface ExecutionContext

Returns:

the list of elements, beginning with the root element, containing the executable element as last element