org.vast.sensorML

Class ExecutableProcessImpl

java.lang.Object

org.vast.sensorML.ExecutableProcessImpl

All Implemented Interfaces:

Runnable, IProcessExec

Direct Known Subclasses:

ExecutableChainImpl

public abstract class ExecutableProcessImpl
extends Object
implements IProcessExec, Runnable

Abstract base for all executable process implementations.
This class provides logic to run a process synchronously by simply calling execute() or in its own thread using start() and stop().

Since:

Feb 28, 2015

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	execError
protected static String	initError
protected List<DataConnectionList>	inputConnections
protected IOPropertyList	inputData
protected static String	ioError
protected boolean	needSync
protected List<DataConnectionList>	outputConnections
protected IOPropertyList	outputData
protected List<DataConnectionList>	paramConnections
protected IOPropertyList	paramData
protected Thread	processThread
protected boolean	started
protected boolean	usingQueueBuffers
protected AbstractProcess	wrapperProcess

Constructor Summary

Constructors

Constructor and Description
ExecutableProcessImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assignWrapperProcess(AbstractProcess wrapperProcess)
boolean	canRun() Check that all needed connections are ready for the process to run in sync mode (not threaded).
protected boolean	checkAvailability(DataConnectionList connectionList, boolean availability) Checks that the availability flags of all connections in the list is equal to the specified state.
protected boolean	checkAvailability(List<DataConnectionList> allConnections, boolean availability) Checks if all connections in the list and marked as needed have the specified availability state.
void	connectInput(String inputName, String dataPath, DataConnection connection) Connects one of this process inputs with the given connection
void	connectOutput(String outputName, String dataPath, DataConnection connection) Connects one of this process outputs with the given connection
void	connectParameter(String paramName, String dataPath, DataConnection connection) Connects one of this process parameters with the given connection
void	createNewInputBlocks() Creates new DataBlock for each input signal
void	createNewOutputBlocks() Creates new DataBlock for each output signal
void	dispose() Override to dispose of all resources allocated for the process (stop threads, OS resources, etc...) Default method does nothing.
abstract void	execute() Execute is typically called several times on a process and should contain all the logic to transform input/parameter values to output values.
protected void	fetchData(List<DataConnectionList> allConnections) Fetch new data from input queues in async mode (threaded) Thread will wait until each queue needing data receives next block
protected void	finalize()
List<DataConnectionList>	getInputConnections()
IOPropertyList	getInputList()
String	getName()
List<DataConnectionList>	getOutputConnections()
IOPropertyList	getOutputList()
List<DataConnectionList>	getParamConnections()
IOPropertyList	getParameterList()
protected int	getSignalIndex(OgcPropertyList<?> ioList, String signalName)
abstract void	init() Initialize the process and its internal variables (fixed parameters).
boolean	isInputConnected(String inputName) Checks if the specified input has one or more connections
boolean	isOutputConnected(String outputName) Checks if the specified output has one or more connections
boolean	isParamConnected(String paramName) Checks if the specified parameter has one or more connections
boolean	isUsingQueueBuffers() Checks if actual buffered queues are used to connect with this process
boolean	needSync()
void	reset() Resets the process (especially asnchronous ones) before it can be run again.
void	run() Process thread run method
protected void	setAvailability(DataConnectionList connectionList, boolean availability) Sets the availability flags of all connections in the list to the specified state.
void	setAvailability(List<DataConnectionList> allConnections, boolean availability) Sets i/o availability flags in sync mode (not threaded) This default method just sets all needed flags to the specified state.
void	setUsingQueueBuffers(boolean usingQueueBuffers)
void	start() Start process thread
void	stop() Stop process thread gracefully
String	toString() Print process name and I/O info
void	transferData(List<DataConnectionList> allConnections)
protected void	writeData(List<DataConnectionList> allConnections) Writes new data to output queues in async mode (threaded)

Methods inherited from class java.lang.Object

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

Field Detail

ioError

protected static final String ioError

See Also:

Constant Field Values

initError

protected static final String initError

See Also:

Constant Field Values

execError

protected static final String execError

See Also:

Constant Field Values

wrapperProcess

protected AbstractProcess wrapperProcess

inputData

protected IOPropertyList inputData

outputData

protected IOPropertyList outputData

paramData

protected IOPropertyList paramData

inputConnections

protected transient List<DataConnectionList> inputConnections

outputConnections

protected transient List<DataConnectionList> outputConnections

paramConnections

protected transient List<DataConnectionList> paramConnections

processThread

protected transient Thread processThread

started

protected transient boolean started

usingQueueBuffers

protected transient boolean usingQueueBuffers

needSync

protected transient boolean needSync

Constructor Detail

ExecutableProcessImpl

public ExecutableProcessImpl()

Method Detail

assignWrapperProcess

protected void assignWrapperProcess(AbstractProcess wrapperProcess)
                             throws SMLException

Throws:

SMLException

init

public abstract void init()
                   throws SMLException

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:

SMLException

execute

public abstract void execute()
                      throws SMLException

Description copied from interface: IProcessExec

Execute is typically called several times on a process and should contain all the logic to transform input/parameter values to output values. This method should be optimized as much as possible.

Specified by:

execute in interface IProcessExec

Throws:

SMLException

dispose

public void dispose()

Description copied from interface: IProcessExec

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

Specified by:

dispose in interface IProcessExec

reset

public void reset()
           throws SMLException

Description copied from interface: IProcessExec

Resets the process (especially asnchronous ones) before it can be run again. This method should properly initialize all process state variables

Specified by:

reset in interface IProcessExec

Throws:

SMLException

getName

public String getName()

Specified by:

getName in interface IProcessExec

Returns:

process name

canRun

public boolean canRun()

Description copied from interface: IProcessExec

Check that all needed connections are ready for the process to run in sync mode (not threaded).

Specified by:

canRun in interface IProcessExec

Returns:

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

checkAvailability

protected boolean checkAvailability(List<DataConnectionList> allConnections,
                        boolean availability)

Checks if all connections in the list and marked as needed have the specified availability state.

Returns:

true if all needed connections satisfy the condition, false otherwise

checkAvailability

protected boolean checkAvailability(DataConnectionList connectionList,
                        boolean availability)

Checks that the availability flags of all connections in the list is equal to the specified state.

Parameters:

connectionList -

availability -

Returns:

true if all connections satisfy the condition, false otherwise.

setAvailability

public void setAvailability(List<DataConnectionList> allConnections,
                   boolean availability)

Sets i/o availability flags in sync mode (not threaded) This default method just sets all needed flags to the specified state. It must be overriden by processes needing a different behavior.

Specified by:

setAvailability in interface IProcessExec

Parameters:

allConnections - (inputs, outputs or parameters)

setAvailability

protected void setAvailability(DataConnectionList connectionList,
                   boolean availability)

Sets the availability flags of all connections in the list to the specified state. (even if not needed!)

Parameters:

connectionList -

availability -

fetchData

protected void fetchData(List<DataConnectionList> allConnections)
                  throws InterruptedException

Fetch new data from input queues in async mode (threaded) Thread will wait until each queue needing data receives next block

Throws:

InterruptedException

writeData

protected void writeData(List<DataConnectionList> allConnections)
                  throws InterruptedException

Writes new data to output queues in async mode (threaded)

Throws:

InterruptedException

transferData

public void transferData(List<DataConnectionList> allConnections)

Specified by:

transferData in interface IProcessExec

createNewOutputBlocks

public void createNewOutputBlocks()

Description copied from interface: IProcessExec

Creates new DataBlock for each output signal

Specified by:

createNewOutputBlocks in interface IProcessExec

createNewInputBlocks

public void createNewInputBlocks()

Description copied from interface: IProcessExec

Creates new DataBlock for each input signal

Specified by:

createNewInputBlocks in interface IProcessExec

run

public void run()

Description copied from interface: IProcessExec

Process thread run method

Specified by:

run in interface Runnable

Specified by:

run in interface IProcessExec

start

public void start()
           throws SMLException

Description copied from interface: IProcessExec

Start process thread

Specified by:

start in interface IProcessExec

Throws:

SMLException

stop

public void stop()

Description copied from interface: IProcessExec

Stop process thread gracefully

Specified by:

stop in interface IProcessExec

toString

public String toString()

Print process name and I/O info

Overrides:

toString in class Object

connectInput

public void connectInput(String inputName,
                String dataPath,
                DataConnection connection)
                  throws SMLException

Description copied from interface: IProcessExec

Connects one of this process inputs with the given connection

Specified by:

connectInput in interface IProcessExec

Parameters:

inputName - name of input to connect

dataPath - path of component to connect

connection - connection object whose destination will be set to the specified component

Throws:

SMLException

connectOutput

public void connectOutput(String outputName,
                 String dataPath,
                 DataConnection connection)
                   throws SMLException

Description copied from interface: IProcessExec

Connects one of this process outputs with the given connection

Specified by:

connectOutput in interface IProcessExec

Parameters:

outputName - name of output to connect

dataPath - path of component to connect

connection - connection object whose source will be set to the specified component

Throws:

SMLException

connectParameter

public void connectParameter(String paramName,
                    String dataPath,
                    DataConnection connection)
                      throws SMLException

Description copied from interface: IProcessExec

Connects one of this process parameters with the given connection

Specified by:

connectParameter in interface IProcessExec

Parameters:

paramName - name of parameter to connect

dataPath - path of component to connect

connection - connection object whose destination will be set to the specified component

Throws:

SMLException

isInputConnected

public boolean isInputConnected(String inputName)

Description copied from interface: IProcessExec

Checks if the specified input has one or more connections

Specified by:

isInputConnected in interface IProcessExec

Parameters:

inputName - name of input

Returns:

true if at least one connection is made with the input

isOutputConnected

public boolean isOutputConnected(String outputName)

Description copied from interface: IProcessExec

Checks if the specified output has one or more connections

Specified by:

isOutputConnected in interface IProcessExec

Parameters:

outputName - name of output

Returns:

true if at least one connection is made with the output

isParamConnected

public boolean isParamConnected(String paramName)

Description copied from interface: IProcessExec

Checks if the specified parameter has one or more connections

Specified by:

isParamConnected in interface IProcessExec

Parameters:

paramName - name of parameter

Returns:

true if at least one connection is made with the parameter

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

getInputConnections

public List<DataConnectionList> getInputConnections()

Specified by:

getInputConnections in interface IProcessExec

Returns:

list of input connections to read data from

getParamConnections

public List<DataConnectionList> getParamConnections()

Specified by:

getParamConnections in interface IProcessExec

Returns:

list of parameter connections to read data from

getOutputConnections

public List<DataConnectionList> getOutputConnections()

Specified by:

getOutputConnections in interface IProcessExec

Returns:

list of output connections to write data to

getSignalIndex

protected int getSignalIndex(OgcPropertyList<?> ioList,
                 String signalName)

isUsingQueueBuffers

public boolean isUsingQueueBuffers()

Description copied from interface: IProcessExec

Checks if actual buffered queues are used to connect with this process

Specified by:

isUsingQueueBuffers in interface IProcessExec

Returns:

tru if queues are used

setUsingQueueBuffers

public void setUsingQueueBuffers(boolean usingQueueBuffers)

Specified by:

setUsingQueueBuffers in interface IProcessExec

needSync

public boolean needSync()

Specified by:

needSync in interface IProcessExec

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable