com.github.dexecutor.core

Interface DexecutorState<T,R>

Type Parameters:

T - Type of Node/Task ID

R - Type of Node/Task result

All Superinterfaces:

DependencyAware<T>

All Known Implementing Classes:

DefaultDexecutorState

public interface DexecutorState<T,R>
extends DependencyAware<T>

Represents Dexecutor state at any given moment of time, It basically tracks

• Phase : Current Phase Dexecutor is in
• Graph : Exposes API around building graph
• unprocessed nodes count : How many nodes are waiting to be processed
• processed nodes : Nodes which are processed till that point
• Discontinued nodes : Nodes for which processing should continue after system comes to valid state

Author:

Nadeem Mohammad

Method Summary

Modifier and Type	Method and Description
void	addErrored(ExecutionResult<T,R> task) Add to errored collection
void	decrementUnProcessedNodesCount() decrements the count of total number of unprocessed nodes
int	erroredCount()
void	forcedStop() called to force stop
Phase	getCurrentPhase()
Collection<Node<T,R>>	getDiscontinuedNodes()
ExecutionResults<T,R>	getErrored()
Node<T,R>	getGraphNode(T id) Returns the node with the given id
Set<Node<T,R>>	getInitialNodes() Returns the Set of nodes for which there is no incoming dependencies.
Set<Node<T,R>>	getNonProcessedRootNodes()
Collection<Node<T,R>>	getProcessedNodes()
int	getUnProcessedNodesCount()
int	graphSize() Returns the total number of nodes in this graph
void	incrementUnProcessedNodesCount() increments the count of total number of unprocessed nodes
boolean	isDiscontinuedNodesNotEmpty()
void	markDiscontinuedNodesProcessed() clear (or marks) all the discontinued nodes till this point as processed
void	markProcessingDone(Node<T,R> node)
void	onRecover() called where Dexecutor is Recovered
void	onTerminate() called when Dexecutor is finished execution
void	print(Traversar<T,R> traversar, TraversarAction<T,R> action) Prints the graph into the writer using the Traversar
void	processAfterNoError(Collection<Node<T,R>> nodes) Add to existing collection of discontinued nodes to be processed later, if system come to valid state.
void	removeErrored(ExecutionResult<T,R> task) Remove errored collection
void	setCurrentPhase(Phase currentPhase) sets the phase to that of provided
boolean	shouldProcess(Node<T,R> node)
void	validate(Validator<T,R> validator) validates the graph using the validator

Methods inherited from interface com.github.dexecutor.core.graph.DependencyAware

addAsDependencyToAllInitialNodes, addAsDependentOnAllLeafNodes, addDependency, addIndependent

Method Detail

getGraphNode

Node<T,R> getGraphNode(T id)

Returns the node with the given id

Parameters:

id - The Unique node id

Returns:

the @Node with the given id

graphSize

int graphSize()

Returns the total number of nodes in this graph

Returns:

total number of nodes in this graph

getInitialNodes

Set<Node<T,R>> getInitialNodes()

Returns the Set of nodes for which there is no incoming dependencies.

Returns:

set of initial nodes

getNonProcessedRootNodes

Set<Node<T,R>> getNonProcessedRootNodes()

Returns:

the root non processed nodes

print

void print(Traversar<T,R> traversar,
           TraversarAction<T,R> action)

Prints the graph into the writer using the Traversar

Parameters:

traversar - would traverse the graph

action - callback which would be called based on traverse

validate

void validate(Validator<T,R> validator)

validates the graph using the validator

Parameters:

validator - based on which validation would happen

setCurrentPhase

void setCurrentPhase(Phase currentPhase)

sets the phase to that of provided

Parameters:

currentPhase - the phase that should be set to

getCurrentPhase

Phase getCurrentPhase()

Returns:

the current phase of execution

getUnProcessedNodesCount

int getUnProcessedNodesCount()

Returns:

the total number of unprocessed nodes(Waiting for execution result) at any given moment of time.

incrementUnProcessedNodesCount

void incrementUnProcessedNodesCount()

increments the count of total number of unprocessed nodes

decrementUnProcessedNodesCount

void decrementUnProcessedNodesCount()

decrements the count of total number of unprocessed nodes

shouldProcess

boolean shouldProcess(Node<T,R> node)

Parameters:

node - on which test should happen

Returns:

weather the node should be processed by dexecutor or not

markProcessingDone

void markProcessingDone(Node<T,R> node)

Parameters:

node - Mark the node as processed.

getProcessedNodes

Collection<Node<T,R>> getProcessedNodes()

Returns:

processedNodes

isDiscontinuedNodesNotEmpty

boolean isDiscontinuedNodesNotEmpty()

Returns:

true if there nodes that should be processed, if some were discontinued due to error. false otherwise

getDiscontinuedNodes

Collection<Node<T,R>> getDiscontinuedNodes()

Returns:

the @nodes that are waiting to be processed, which were discontinued due to error

markDiscontinuedNodesProcessed

void markDiscontinuedNodesProcessed()

clear (or marks) all the discontinued nodes till this point as processed

processAfterNoError

void processAfterNoError(Collection<Node<T,R>> nodes)

Add to existing collection of discontinued nodes to be processed later, if system come to valid state.

Parameters:

nodes - which should be processed after retry success

addErrored

void addErrored(ExecutionResult<T,R> task)

Add to errored collection

Parameters:

task - to add to errored collection

removeErrored

void removeErrored(ExecutionResult<T,R> task)

Remove errored collection

Parameters:

task - to remove from errored collection

erroredCount

int erroredCount()

Returns:

Number of errors at this instance of time

getErrored

ExecutionResults<T,R> getErrored()

Returns:

thre errored result

forcedStop

void forcedStop()

called to force stop

onTerminate

void onTerminate()

called when Dexecutor is finished execution

onRecover

void onRecover()

called where Dexecutor is Recovered