com.github.dexecutor.core

Interface DexecutorState<T extends Comparable<T>,R>

Type Parameters:

T - Type of Node/Task ID

R - Type of Node/Task result

All Known Implementing Classes:

DefaultDexecutorState

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

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

Methods

Modifier and Type	Method and Description
void	addAsDependencyToAllInitialNodes(T nodeValue) Adds the node as dependency to all initial nodes (at the time of adding), meaning this given node would be evaluated first and then all initial nodes would run in parallel
void	addAsDependentOnAllLeafNodes(T nodeValue) Adds the node as dependent on all leaf nodes (at the time of adding), meaning all leaf nodes would be evaluated first and then the given node
void	addDependency(T evalFirstValue, T evalAfterValue) Add Two dependent nodes into the graph, creating the nodes if not already present
void	addIndependent(T nodeValue) Add a node as independent, it does not require any dependent node
void	decrementUnProcessedNodesCount() decrements the count of total number of unprocessed nodes
Phase	getCurrentPhase()
Collection<Node<T,R>>	getDiscontinuedNodes()
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.
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
void	initState() Initialize the Dexecutor state, either to new or existing state
boolean	isDiscontinuedNodesNotEmpty()
void	markDiscontinuedNodesProcessed() clear (or marks) all the discontinued nodes till this point as processed
void	markProcessingDone(Node<T,R> node) Mark the node as processed.
void	print(Traversar<T,R> traversar, Writer writer) 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	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

Method Detail

initState

void initState()

Initialize the Dexecutor state, either to new or existing state

addIndependent

void addIndependent(T nodeValue)

Add a node as independent, it does not require any dependent node

Parameters:

nodeValue -

addDependency

void addDependency(T evalFirstValue,
                 T evalAfterValue)

Add Two dependent nodes into the graph, creating the nodes if not already present

evalFirstValue would be executed first and then evalAfterValue

Parameters:

evalFirstValue -

evalAfterValue -

addAsDependentOnAllLeafNodes

void addAsDependentOnAllLeafNodes(T nodeValue)

Adds the node as dependent on all leaf nodes (at the time of adding), meaning all leaf nodes would be evaluated first and then the given node

Parameters:

nodeValue -

addAsDependencyToAllInitialNodes

void addAsDependencyToAllInitialNodes(T nodeValue)

Adds the node as dependency to all initial nodes (at the time of adding), meaning this given node would be evaluated first and then all initial nodes would run in parallel

Parameters:

nodeValue -

getInitialNodes

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

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

Returns:

set of initial nodes

getGraphNode

Node<T,R> getGraphNode(T id)

Returns the node with the given id

Parameters:

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

print

void print(Traversar<T,R> traversar,
         Writer writer)

Prints the graph into the writer using the Traversar

Parameters:

traversar -

writer -

validate

void validate(Validator<T,R> validator)

validates the graph using the validator

Parameters:

validator -

setCurrentPhase

void setCurrentPhase(Phase currentPhase)

sets the phase to that of provided

Parameters:

currentPhase -

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 -

Returns:

weather the node should be processed by dexecutor or not

markProcessingDone

void markProcessingDone(Node<T,R> node)

Mark the node as processed.

Parameters:

node -

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 -