Package adams.flow.execution

Interface FlowExecutionListener

All Superinterfaces:

CleanUpHandler

All Known Subinterfaces:

GraphicalFlowExecutionListener, TimedFlowExecutionListener

All Known Implementing Classes:

AbstractFlowExecutionListener, AbstractFlowExecutionListenerWithTable, AbstractGraphicalFlowExecutionListener, AbstractTimedFlowExecutionListenerWithTable, CurrentlyExecuted, Debug, ExecutionCounter, ExecutionLog, MultiListener, NullListener, RemoteFlowListener, Time, TraceExecutionTime

public interface FlowExecutionListener
extends CleanUpHandler

Interface for classes that record flow execution events.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
void	finishListening()	Gets called when the flow execution ends.
Flow	getOwner()	Returns the owning flow.
void	postExecute(Actor actor)	Gets called after the actor was executed.
void	postInput(Actor actor)	Gets called after the actor received the token.
void	postOutput(Actor actor, Token token)	Gets called after a token was acquired from the actor.
void	preExecute(Actor actor)	Gets called before the actor gets executed.
void	preInput(Actor actor, Token token)	Gets called before the actor receives the token.
void	preOutput(Actor actor)	Gets called before a token gets obtained from the actor.
void	setOwner(Flow value)	Sets the owning flow.
void	startListening()	Gets called when the flow execution starts.

Methods inherited from interface adams.core.CleanUpHandler

cleanUp

Method Detail

setOwner

void setOwner(Flow value)

Sets the owning flow.

Parameters:

value - the owner

getOwner

Flow getOwner()

Returns the owning flow.

Returns:

the owner

startListening

void startListening()

Gets called when the flow execution starts.

preInput

void preInput(Actor actor,
              Token token)

Gets called before the actor receives the token.

Parameters:

actor - the actor that will receive the token

token - the token that the actor will receive

postInput

void postInput(Actor actor)

Gets called after the actor received the token.

Parameters:

actor - the actor that received the token

preExecute

void preExecute(Actor actor)

Gets called before the actor gets executed.

Parameters:

actor - the actor that will get executed

postExecute

void postExecute(Actor actor)

Gets called after the actor was executed.

Parameters:

actor - the actor that was executed

preOutput

void preOutput(Actor actor)

Gets called before a token gets obtained from the actor.

Parameters:

actor - the actor the token gets obtained from

postOutput

void postOutput(Actor actor,
                Token token)

Gets called after a token was acquired from the actor.

Parameters:

actor - the actor that the token was acquired from

token - the token that was acquired from the actor

finishListening

void finishListening()

Gets called when the flow execution ends.