Package org.vast.process

Class ExecutableProcessImpl

java.lang.Object

org.vast.process.ExecutableProcessImpl

All Implemented Interfaces:

IProcessExec

Direct Known Subclasses:

ExecutableChainImpl

public abstract class ExecutableProcessImpl
extends Object
implements IProcessExec

Abstract base for all executable process implementations.

Since:

Feb 28, 2015

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	EXEC_ERROR_MSG
protected Future<?>	execFuture
protected static final String	INIT_ERROR_MSG
protected boolean	initialized
protected Map<String,DataConnectionList>	inputConnections
protected IOPropertyList	inputData
protected String	instanceName
protected static final String	IO_ERROR_MSG
protected Map<String,DataConnectionList>	outputConnections
protected IOPropertyList	outputData
protected Map<String,DataConnectionList>	paramConnections
protected IOPropertyList	paramData
protected ProcessInfo	processInfo
protected boolean	started
protected boolean	usingOutputQueues

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExecutableProcessImpl(ProcessInfo processInfo)

Method Summary

Modifier and Type	Method	Description
boolean	canRun()	Check that all needed connections are ready for the process to run
protected boolean	checkAvailability(Map<String,DataConnectionList> connectionGroup, boolean availability)
protected boolean	checkAvailability(DataConnectionList connectionList, boolean availability)
protected void	checkInitialized()
protected void	connect(String portName, DataComponent component, boolean isSource, IDataConnection connection, Map<String,DataConnectionList> connectionGroup)
void	connect(DataComponent component, IDataConnection connection)	Connects one of this process ports with the given connection
protected void	consumeData(Map<String,DataConnectionList> connectionGroup, boolean block)
protected void	consumeInputData()	Consume data from input ports. The default implementation waits for data to be available from all connected inputs
protected void	consumeParamData()	Consume data from parameter ports. The default implementation tries to fetch data from all connected parameters but will not wait if data is not available.
protected void	disconnect(DataComponent parentPort, IDataConnection connection)
void	disconnect(IDataConnection connection)	Detach connection from this process input, output or parameter
void	dispose()	Override to dispose of all resources allocated for the process (stop threads, OS resources, etc...)
protected void	finalize()
protected Map<String,DataConnectionList>	findConnectionGroup(DataComponent parentPort)
Map<String,DataConnectionList>	getInputConnections()
IOPropertyList	getInputList()
String	getInstanceName()
protected org.slf4j.Logger	getLogger()
Map<String,DataConnectionList>	getOutputConnections()
IOPropertyList	getOutputList()
Map<String,DataConnectionList>	getParamConnections()
IOPropertyList	getParameterList()
ProcessInfo	getProcessInfo()
void	init()	Initialize the process and its internal variables (fixed parameters).
protected void	initPortData()
protected void	initPortData(DataComponent port)
boolean	needSync()
void	notifyParamChange()	Notifies the process that one or more parameter values have changed before or during execution
protected void	publishData()
protected void	publishData(String outputName)
protected void	renewOutputData(String outputName)
void	reportError(String msg)	Helper method to log an error on the logger attached to this process and throw a ProcessException
void	reportError(String msg, Throwable e)	Helper method to log an error on the logger attached to this process and throw a ProcessException
void	run()	Runs the process which includes fetching input data, calling execute and producing output data
void	setInstanceName(String name)	Sets the name of this process instance
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	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
void	stop()	Stop process thread gracefully
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vast.process.IProcessExec

execute

Field Details

IO_ERROR_MSG

protected static final String IO_ERROR_MSG

See Also:

• Constant Field Values

INIT_ERROR_MSG

protected static final String INIT_ERROR_MSG

See Also:

• Constant Field Values

EXEC_ERROR_MSG

protected static final String EXEC_ERROR_MSG

See Also:

• Constant Field Values

inputData

protected IOPropertyList inputData

outputData

protected IOPropertyList outputData

paramData

protected IOPropertyList paramData

inputConnections

protected Map<String,DataConnectionList> inputConnections

outputConnections

protected Map<String,DataConnectionList> outputConnections

paramConnections

protected Map<String,DataConnectionList> paramConnections

processInfo

protected ProcessInfo processInfo

instanceName

protected String instanceName

initialized

protected volatile boolean initialized

started

protected volatile boolean started

usingOutputQueues

protected boolean usingOutputQueues

execFuture

protected Future<?> execFuture

Constructor Details

ExecutableProcessImpl

protected ExecutableProcessImpl(ProcessInfo processInfo)

Method Details

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

Throws:

ProcessException

initPortData

protected void initPortData()

initPortData

protected void initPortData(DataComponent port)

checkInitialized

protected void checkInitialized()

canRun

public boolean canRun()

Description copied from interface: IProcessExec

Check that all needed connections are ready for the process to run

Specified by:

canRun in interface IProcessExec

Returns:

true if so and false if at least one connection is not ready.

checkAvailability

protected boolean checkAvailability(Map<String,DataConnectionList> connectionGroup,
 boolean availability)

checkAvailability

protected boolean checkAvailability(DataConnectionList connectionList,
 boolean availability)

run

public void run()
         throws ProcessException

Description copied from interface: IProcessExec

Runs the process which includes fetching input data, calling execute and producing output data

Specified by:

run in interface IProcessExec

Throws:

ProcessException

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

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

onError - Called when the process ends with an unrecoverable error

Throws:

ProcessException

stop

public void stop()

Description copied from interface: IProcessExec

Stop process thread gracefully

Specified by:

stop in interface IProcessExec

consumeInputData

protected void consumeInputData()
                         throws InterruptedException

Consume data from input ports.
The default implementation waits for data to be available from all connected inputs

Throws:

InterruptedException

consumeParamData

protected void consumeParamData()
                         throws InterruptedException

Consume data from parameter ports.
The default implementation tries to fetch data from all connected parameters but will not wait if data is not available. connected inputs

Throws:

InterruptedException

consumeData

protected void consumeData(Map<String,DataConnectionList> connectionGroup,
 boolean block)
                    throws InterruptedException

Throws:

InterruptedException

publishData

protected void publishData()
                    throws InterruptedException

Throws:

InterruptedException

publishData

protected void publishData(String outputName)
                    throws InterruptedException

Throws:

InterruptedException

renewOutputData

protected void renewOutputData(String outputName)

needSync

public boolean needSync()

Specified by:

needSync in interface IProcessExec

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

getInputConnections

public Map<String,DataConnectionList> getInputConnections()

Specified by:

getInputConnections in interface IProcessExec

Returns:

Read-only list of connections input ports

getOutputConnections

public Map<String,DataConnectionList> getOutputConnections()

Specified by:

getOutputConnections in interface IProcessExec

Returns:

Read-only list of connections output ports

getParamConnections

public Map<String,DataConnectionList> getParamConnections()

Specified by:

getParamConnections in interface IProcessExec

Returns:

Read-only list of connections parameter ports

connect

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

Description copied from interface: IProcessExec

Connects one of this process ports with the given connection

Specified by:

connect in interface IProcessExec

Parameters:

component - input, parameter or output component to connect

connection - connection object to use

Throws:

ProcessException - if connection cannot be validated (this usually happens because source and destination components are not compatible)

findConnectionGroup

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

connect

protected void connect(String portName,
 DataComponent component,
 boolean isSource,
 IDataConnection connection,
 Map<String,DataConnectionList> connectionGroup)
                throws ProcessException

Throws:

ProcessException

disconnect

public void disconnect(IDataConnection connection)

Description copied from interface: IProcessExec

Detach connection from this process input, output or parameter

Specified by:

disconnect in interface IProcessExec

disconnect

protected void disconnect(DataComponent parentPort,
 IDataConnection connection)

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

setInstanceName

public void setInstanceName(String name)

Description copied from interface: IProcessExec

Sets the name of this process instance

Specified by:

setInstanceName in interface IProcessExec

getLogger

protected org.slf4j.Logger getLogger()

getInstanceName

public String getInstanceName()

Specified by:

getInstanceName in interface IProcessExec

Returns:

name of this process instance

getProcessInfo

public ProcessInfo getProcessInfo()

Specified by:

getProcessInfo in interface IProcessExec

Returns:

all process information (name, UID, etc.)

getInputList

public IOPropertyList getInputList()

Specified by:

getInputList in interface IProcessExec

Returns:

List of inputs

getOutputList

public IOPropertyList getOutputList()

Specified by:

getOutputList in interface IProcessExec

Returns:

List of outputs

getParameterList

public IOPropertyList getParameterList()

Specified by:

getParameterList in interface IProcessExec

Returns:

List of parameters

notifyParamChange

public void notifyParamChange()

Description copied from interface: IProcessExec

Notifies the process that one or more parameter values have changed before or during execution

Specified by:

notifyParamChange in interface IProcessExec

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

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object

reportError

public void reportError(String msg)
                 throws ProcessException

Helper method to log an error on the logger attached to this process and throw a ProcessException

Parameters:

msg -

Throws:

ProcessException

reportError

public void reportError(String msg,
 Throwable e)
                 throws ProcessException

Helper method to log an error on the logger attached to this process and throw a ProcessException

Parameters:

msg -

e -

Throws:

ProcessException