Package org.vast.process

Class ExecutableChainImpl

java.lang.Object

org.vast.process.ExecutableProcessImpl

org.vast.process.ExecutableChainImpl

All Implemented Interfaces:

IProcessChainExec, IProcessExec

public class ExecutableChainImpl
extends ExecutableProcessImpl
implements IProcessChainExec

Implementation of an executable process chain.
This class can be associated with an AggregateProcess to provide execution capability, but this will only work if all components of the aggregate also have an executable implementation associated to them.

Since:

Feb 28, 2015

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	childrenThreadsStarted
static final ProcessInfo	INFO
protected Map<String,DataConnectionList>	internalInputConnections
protected Map<String,DataConnectionList>	internalOutputConnections
protected Map<String,DataConnectionList>	internalParamConnections
protected boolean	needSync
protected List<IProcessExec>	processExecList
protected Map<String,IProcessExec>	processTable
protected ExecutorService	threadPool
protected boolean	useChildrenThreads

Fields inherited from class org.vast.process.ExecutableProcessImpl

EXEC_ERROR_MSG, execFuture, INIT_ERROR_MSG, initialized, inputConnections, inputData, instanceName, IO_ERROR_MSG, outputConnections, outputData, paramConnections, paramData, processInfo, started, usingOutputQueues

Constructor Summary

Constructors

Constructor	Description
ExecutableChainImpl()
ExecutableChainImpl(boolean childrenThreadsOn)

Method Summary

Modifier and Type	Method	Description
IProcessExec	addProcess(String name, IProcessExec process)	Adds a child process to this process chain
void	combineInputBlocks()
void	combineOutputBlocks()
protected void	combineOutputBlocks(String outputName)
IDataConnection	connect(IProcessExec srcProcess, DataComponent srcComponent, IProcessExec destProcess, DataComponent destComponent)	Create connection between ports of two child processes
void	connectInternal(DataComponent component, IDataConnection connection)
protected void	disconnect(DataComponent parentPort, IDataConnection connection)
void	dispose()	Override to dispose of all resources allocated for the process (stop threads, OS resources, etc...)
void	execute()	Execute contains the logic to transform input/parameter values into output values.
protected Map<String,DataConnectionList>	findInternalConnectionGroup(DataComponent parentPort)
Map<String,IProcessExec>	getChildProcesses()
Collection<IDataConnection>	getInternalConnections()
void	init()	Initialize the process and its internal variables (fixed parameters).
boolean	isUseChildrenThreads()
boolean	needSync()
void	removeInternalConnection(IDataConnection connection)	Completely remove an internal connection between two child processes or between a chain internal port and a child process
void	removeProcess(String name)	Removes a process from the chain and all connections to/from it
protected void	setNeededInputs(Map<String,DataConnectionList> externalConnections, Map<String,DataConnectionList> internalConnections)
protected void	setNeededOutputs(Map<String,DataConnectionList> externalConnections, Map<String,DataConnectionList> internalConnections)
void	setOutputNeeded(String outputName, boolean needed)	Indicates if data from the specified output is needed or not
void	setParentLogger(org.slf4j.Logger log)	Set the parent logger for this process. The parent logger is used to group log events occuring in all processes that are part of the same processing component (e.g.
void	setUseChildrenThreads(boolean useThreads)
void	start(ExecutorService threadPool, Consumer<Throwable> onError)	Start process using threads from the given thread pool
void	start(Consumer<Throwable> onError)	Start process in its own thread
protected void	startChildrenThreads()
protected void	startChildrenThreads(ExecutorService threadPool, Consumer<Throwable> onError)
void	stop()	Stop process thread gracefully
String	toString()
protected void	transferInputData(Map<String,DataConnectionList> externalConnections, Map<String,DataConnectionList> internalConnections)

Methods inherited from class org.vast.process.ExecutableProcessImpl

canRun, checkAvailability, checkAvailability, checkInitialized, connect, connect, consumeData, consumeInputData, consumeParamData, disconnect, finalize, findConnectionGroup, getInputConnections, getInputList, getInstanceName, getLogger, getOutputConnections, getOutputList, getParamConnections, getParameterList, getProcessInfo, initPortData, initPortData, notifyParamChange, publishData, publishData, renewOutputData, reportError, reportError, run, setInstanceName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vast.process.IProcessExec

canRun, connect, disconnect, getInputConnections, getInputList, getInstanceName, getOutputConnections, getOutputList, getParamConnections, getParameterList, getProcessInfo, notifyParamChange, run, setInstanceName

Field Details

INFO

public static final ProcessInfo INFO

internalInputConnections

protected Map<String,DataConnectionList> internalInputConnections

internalOutputConnections

protected Map<String,DataConnectionList> internalOutputConnections

internalParamConnections

protected Map<String,DataConnectionList> internalParamConnections

processTable

protected Map<String,IProcessExec> processTable

processExecList

protected List<IProcessExec> processExecList

useChildrenThreads

protected boolean useChildrenThreads

needSync

protected boolean needSync

childrenThreadsStarted

protected boolean childrenThreadsStarted

threadPool

protected ExecutorService threadPool

Constructor Details

ExecutableChainImpl

public ExecutableChainImpl()

ExecutableChainImpl

public ExecutableChainImpl(boolean childrenThreadsOn)

Method Details

getChildProcesses

public Map<String,IProcessExec> getChildProcesses()

Specified by:

getChildProcesses in interface IProcessChainExec

Returns:

Read-only map of processes included in this chain

addProcess

public IProcessExec addProcess(String name,
 IProcessExec process)

Description copied from interface: IProcessChainExec

Adds a child process to this process chain

Specified by:

addProcess in interface IProcessChainExec

Returns:

the added process

removeProcess

public void removeProcess(String name)

Description copied from interface: IProcessChainExec

Removes a process from the chain and all connections to/from it

Specified by:

removeProcess in interface IProcessChainExec

getInternalConnections

public Collection<IDataConnection> getInternalConnections()

Specified by:

getInternalConnections in interface IProcessChainExec

Returns:

Read-only list of all connections between child processes

connect

public IDataConnection connect(IProcessExec srcProcess,
 DataComponent srcComponent,
 IProcessExec destProcess,
 DataComponent destComponent)
                        throws ProcessException

Description copied from interface: IProcessChainExec

Create connection between ports of two child processes

Specified by:

connect in interface IProcessChainExec

Throws:

ProcessException

connectInternal

public void connectInternal(DataComponent component,
 IDataConnection connection)
                     throws ProcessException

Throws:

ProcessException

findInternalConnectionGroup

protected Map<String,DataConnectionList> findInternalConnectionGroup(DataComponent parentPort)

removeInternalConnection

public void removeInternalConnection(IDataConnection connection)

Description copied from interface: IProcessChainExec

Completely remove an internal connection between two child processes or between a chain internal port and a child process

Specified by:

removeInternalConnection in interface IProcessChainExec

disconnect

protected void disconnect(DataComponent parentPort,
 IDataConnection connection)

Overrides:

disconnect in class ExecutableProcessImpl

init

public void init()
          throws ProcessException

Description copied from interface: IProcessExec

Initialize the process and its internal variables (fixed parameters). This is called only once before the process is executed.

Specified by:

init in interface IProcessExec

Overrides:

init in class ExecutableProcessImpl

Throws:

ProcessException

execute

public void execute()
             throws ProcessException

Description copied from interface: IProcessExec

Execute contains the logic to transform input/parameter values into output values. This method should be optimized as much as possible.

Specified by:

execute in interface IProcessExec

Throws:

ProcessException

transferInputData

protected void transferInputData(Map<String,DataConnectionList> externalConnections,
 Map<String,DataConnectionList> internalConnections)
                          throws InterruptedException

Throws:

InterruptedException

setNeededInputs

protected void setNeededInputs(Map<String,DataConnectionList> externalConnections,
 Map<String,DataConnectionList> internalConnections)

setNeededOutputs

protected void setNeededOutputs(Map<String,DataConnectionList> externalConnections,
 Map<String,DataConnectionList> internalConnections)

start

public void start(Consumer<Throwable> onError)
           throws ProcessException

Description copied from interface: IProcessExec

Start process in its own thread

Specified by:

start in interface IProcessExec

Overrides:

start in class ExecutableProcessImpl

Parameters:

onError - Called when the process ends with an unrecoverable error

Throws:

ProcessException

start

public void start(ExecutorService threadPool,
 Consumer<Throwable> onError)
           throws ProcessException

Description copied from interface: IProcessExec

Start process using threads from the given thread pool

Specified by:

start in interface IProcessExec

Overrides:

start in class ExecutableProcessImpl

onError - Called when the process ends with an unrecoverable error

Throws:

ProcessException

startChildrenThreads

protected void startChildrenThreads()
                             throws ProcessException

Throws:

ProcessException

startChildrenThreads

protected void startChildrenThreads(ExecutorService threadPool,
 Consumer<Throwable> onError)
                             throws ProcessException

Throws:

ProcessException

stop

public void stop()

Description copied from interface: IProcessExec

Stop process thread gracefully

Specified by:

stop in interface IProcessExec

Overrides:

stop in class ExecutableProcessImpl

combineInputBlocks

public void combineInputBlocks()

combineOutputBlocks

public void combineOutputBlocks()

combineOutputBlocks

protected void combineOutputBlocks(String outputName)

isUseChildrenThreads

public boolean isUseChildrenThreads()

setUseChildrenThreads

public void setUseChildrenThreads(boolean useThreads)

needSync

public boolean needSync()

Specified by:

needSync in interface IProcessExec

Overrides:

needSync in class ExecutableProcessImpl

Returns:

True if this process is asynchronous (i.e. outputs are not generated everytime inputs are read) and thus need synchronization with other processes in the chain

setOutputNeeded

public void setOutputNeeded(String outputName,
 boolean needed)

Description copied from interface: IProcessChainExec

Indicates if data from the specified output is needed or not

Specified by:

setOutputNeeded in interface IProcessChainExec

dispose

public void dispose()

Description copied from interface: IProcessExec

Override to dispose of all resources allocated for the process (stop threads, OS resources, etc...)

Specified by:

dispose in interface IProcessExec

Overrides:

dispose in class ExecutableProcessImpl

toString

public String toString()

Overrides:

toString in class ExecutableProcessImpl

setParentLogger

public void setParentLogger(org.slf4j.Logger log)

Description copied from interface: IProcessExec

Set the parent logger for this process.
The parent logger is used to group log events occuring in all processes that are part of the same processing component (e.g. a process chain for instance) while still allowing to differentiate the actual process instance that issued the log.

Specified by:

setParentLogger in interface IProcessExec

Overrides:

setParentLogger in class ExecutableProcessImpl