Package org.vast.sensorML

Class AbstractProcessImpl

java.lang.Object

net.opengis.gml.v32.impl.AbstractGMLImpl

net.opengis.gml.v32.impl.AbstractFeatureImpl

net.opengis.sensorml.v20.impl.DescribedObjectImpl

org.vast.sensorML.AbstractProcessImpl

All Implemented Interfaces:

Serializable, AbstractFeature, AbstractGML, AbstractProcess, DescribedObject, IFeature, IProcedure, IProcessExec, IResource

Direct Known Subclasses:

AggregateProcessImpl, PhysicalComponentImpl, SimpleProcessImpl

public abstract class AbstractProcessImpl
extends DescribedObjectImpl
implements AbstractProcess, IProcessExec

This class implements both AbstractProcess from SensorML v2.0 bindings and IProcessExec to allow execution if an executable implementation is provided.
In order to provide execution capabilitiy, this class can wrap an implementation of IProcessExec corresponding to a particular algorithm.

Since:

Feb 28, 2015

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Settings	configuration
protected String	definition
protected IProcessExec	executableProcess
protected FeatureList	featuresOfInterest
protected IOPropertyList	inputData
protected ArrayList<AbstractModes>	modesList
protected IOPropertyList	outputData
protected IOPropertyList	paramData
protected Reference	typeOf

Fields inherited from class net.opengis.sensorml.v20.impl.DescribedObjectImpl

capabilitiesList, characteristicsList, classificationList, contactsList, documentationList, extensionList, historyList, identificationList, keywordsList, lang, legalConstraintsList, securityConstraintsList, validTimeList

Fields inherited from class net.opengis.gml.v32.impl.AbstractFeatureImpl

boundedBy, location

Fields inherited from class net.opengis.gml.v32.impl.AbstractGMLImpl

description, descriptionReference, id, identifier, metaDataPropertyList, nameList, UUID_CODE

Fields inherited from interface net.opengis.sensorml.v20.DescribedObject

DEFAULT_NS_URI

Fields inherited from interface org.vast.ogc.gml.IFeature

DEFAULT_QNAME

Constructor Summary

Constructors

Constructor	Description
AbstractProcessImpl()

Method Summary

Modifier and Type	Method	Description
void	addInput(String name, DataInterface input)	Adds a new inputAsDataInterface property
void	addInput(String name, ObservableProperty input)	Adds a new inputAsObservableProperty property
void	addInput(String name, DataComponent input)	Adds a new inputAsAbstractDataComponent property
void	addInput(String name, DataStream input)	Adds a new inputAsDataStream property
void	addModes(AbstractModes modes)	Adds a new modes property
void	addOutput(String name, DataInterface output)	Adds a new outputAsDataInterface property
void	addOutput(String name, ObservableProperty output)	Adds a new outputAsObservableProperty property
void	addOutput(String name, DataComponent output)	Adds a new outputAsAbstractDataComponent property
void	addOutput(String name, DataStream output)	Adds a new outputAsDataStream property
void	addParameter(String name, DataInterface parameter)	Adds a new parameterAsDataInterface property
void	addParameter(String name, ObservableProperty parameter)	Adds a new parameterAsObservableProperty property
void	addParameter(String name, DataComponent parameter)	Adds a new parameterAsAbstractDataComponent property
void	addParameter(String name, DataStream parameter)	Adds a new parameterAsDataStream property
boolean	canRun()	Check that all needed connections are ready for the process to run
protected void	checkExecutable()
void	connect(DataComponent component, IDataConnection connection)	Connects one of this process ports with the given 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...)
void	execute()	Execute contains the logic to transform input/parameter values into output values.
Settings	getConfiguration()	Gets the configuration property
String	getDefinition()	Gets the definition property
String	getDescription()	Gets the description property
FeatureList	getFeaturesOfInterest()	Gets the featuresOfInterest property
AbstractSWEIdentifiable	getInput(String name)	Gets the input property with the given name
DataComponent	getInputComponent(String name)	Gets the data structure of the input with the given name
Map<String,DataConnectionList>	getInputConnections()
IOPropertyList	getInputList()	Gets the list of input properties
String	getInstanceName()
List<AbstractModes>	getModesList()	Gets the list of modes properties
String	getName()
int	getNumInputs()	Returns number of input properties
int	getNumModes()	Returns number of modes properties
int	getNumOutputs()	Returns number of output properties
int	getNumParameters()	Returns number of parameter properties
AbstractSWEIdentifiable	getOutput(String name)	Gets the output property with the given name
DataComponent	getOutputComponent(String name)	Gets the data structure of the output with the given name
Map<String,DataConnectionList>	getOutputConnections()
IOPropertyList	getOutputList()	Gets the list of output properties
Map<String,DataConnectionList>	getParamConnections()
AbstractSWEIdentifiable	getParameter(String name)	Gets the parameter property with the given name
DataComponent	getParameterComponent(String name)	Gets the data structure of the parameter with the given name
IOPropertyList	getParameterList()	Gets the list of parameter properties
ProcessInfo	getProcessInfo()
Reference	getTypeOf()	Gets the typeOf property
void	init()	Initialize the process and its internal variables (fixed parameters).
boolean	isExecutable()
boolean	isSetConfiguration()	Checks if configuration is set
boolean	isSetDefinition()	Checks if definition is set
boolean	isSetFeaturesOfInterest()	Checks if featuresOfInterest is set
boolean	isSetTypeOf()	Checks if typeOf is set
protected void	mergePort(DataComponent smlPort, DataComponent execPort)
protected IOPropertyList	mergePortDescriptors(IOPropertyList smlPorts, IOPropertyList execPorts)
boolean	needSync()
void	notifyParamChange()	Notifies the process that one or more parameter values have changed before or during execution
void	run()	Runs the process which includes fetching input data, calling execute and producing output data
void	setConfiguration(Settings configuration)	Sets the configuration property
void	setDefinition(String definition)	Sets the definition property
void	setExecutableImpl(IProcessExec processExec)
void	setFeaturesOfInterest(FeatureList featuresOfInterest)	Sets the featuresOfInterest property
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	setTypeOf(Reference typeOf)	Sets the typeOf property
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 net.opengis.sensorml.v20.impl.DescribedObjectImpl

addCapabilities, addCharacteristics, addClassification, addContacts, addDocumentation, addExtension, addHistory, addIdentification, addKeywords, addLegalConstraints, addSecurityConstraints, addValidTimeAsTimeInstant, addValidTimeAsTimePeriod, getCapabilities, getCapabilitiesList, getCharacteristics, getCharacteristicsList, getClassificationList, getContactsList, getDocumentationList, getExtensionList, getHistoryList, getIdentificationList, getKeywordsList, getLang, getLegalConstraintsList, getNumCapabilities, getNumCharacteristics, getNumClassifications, getNumContacts, getNumDocumentations, getNumExtensions, getNumHistorys, getNumIdentifications, getNumKeywords, getNumLegalConstraints, getNumSecurityConstraints, getNumValidTimes, getSecurityConstraintsList, getValidTime, getValidTimeList, isSetLang, setLang

Methods inherited from class net.opengis.gml.v32.impl.AbstractFeatureImpl

equals, getBoundedBy, getGeometry, getGeometryProperty, hashCode, isSetBoundedBy, isSetGeometry, setBoundedByAsEnvelope, setGeometry

Methods inherited from class net.opengis.gml.v32.impl.AbstractGMLImpl

addName, getDescriptionReference, getId, getIdentifier, getMetaDataPropertyList, getNameList, getNumNames, getUniqueIdentifier, isSetDescription, isSetDescriptionReference, isSetIdentifier, setDescription, setDescriptionReference, setId, setIdentifier, setName, setUniqueIdentifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.opengis.gml.v32.AbstractFeature

getBoundedBy, getGeometryProperty, isSetBoundedBy, isSetGeometry, setBoundedByAsEnvelope, setGeometry

Methods inherited from interface net.opengis.gml.v32.AbstractGML

addName, getDescriptionReference, getId, getIdentifier, getMetaDataPropertyList, getNameList, getNumNames, getUniqueIdentifier, isSetDescription, isSetDescriptionReference, isSetIdentifier, setDescription, setDescriptionReference, setId, setIdentifier, setName, setUniqueIdentifier

Methods inherited from interface net.opengis.sensorml.v20.AbstractProcess

getLocation, getType, isSetLocation, setLocation

Methods inherited from interface net.opengis.sensorml.v20.DescribedObject

addCapabilities, addCharacteristics, addClassification, addContacts, addDocumentation, addExtension, addHistory, addIdentification, addKeywords, addLegalConstraints, addSecurityConstraints, addValidTimeAsTimeInstant, addValidTimeAsTimePeriod, getCapabilities, getCapabilitiesList, getCharacteristics, getCharacteristicsList, getClassificationList, getContactsList, getDocumentationList, getExtensionList, getHistoryList, getIdentificationList, getKeywordsList, getLang, getLegalConstraintsList, getNumCapabilities, getNumCharacteristics, getNumClassifications, getNumContacts, getNumDocumentations, getNumExtensions, getNumHistorys, getNumIdentifications, getNumKeywords, getNumLegalConstraints, getNumSecurityConstraints, getNumValidTimes, getSecurityConstraintsList, getValidTimeList, isSetLang, setLang

Methods inherited from interface org.vast.ogc.gml.IFeature

getGeometry, getId, getProperties, getQName, getUniqueIdentifier, getValidTime, hasCustomGeomProperty, hasCustomTimeProperty

Field Details

definition

protected String definition

typeOf

protected Reference typeOf

configuration

protected Settings configuration

featuresOfInterest

protected FeatureList featuresOfInterest

inputData

protected IOPropertyList inputData

outputData

protected IOPropertyList outputData

paramData

protected IOPropertyList paramData

modesList

protected ArrayList<AbstractModes> modesList

executableProcess

protected transient IProcessExec executableProcess

Constructor Details

AbstractProcessImpl

public AbstractProcessImpl()

Method Details

getDefinition

public String getDefinition()

Gets the definition property

Specified by:

getDefinition in interface AbstractProcess

isSetDefinition

public boolean isSetDefinition()

Checks if definition is set

Specified by:

isSetDefinition in interface AbstractProcess

setDefinition

public void setDefinition(String definition)

Sets the definition property

Specified by:

setDefinition in interface AbstractProcess

getName

public String getName()

Specified by:

getName in interface AbstractGML

Specified by:

getName in interface IResource

Overrides:

getName in class AbstractGMLImpl

Returns:

the default name

getDescription

public String getDescription()

Description copied from class: AbstractGMLImpl

Gets the description property

Specified by:

getDescription in interface AbstractGML

Specified by:

getDescription in interface IResource

Overrides:

getDescription in class AbstractGMLImpl

Returns:

A short description of the resource

setExecutableImpl

public void setExecutableImpl(IProcessExec processExec)
                       throws ProcessException

Throws:

ProcessException

mergePortDescriptors

protected IOPropertyList mergePortDescriptors(IOPropertyList smlPorts,
 IOPropertyList execPorts)
                                       throws ProcessException

Throws:

ProcessException

mergePort

protected void mergePort(DataComponent smlPort,
 DataComponent execPort)
                  throws ProcessException

Throws:

ProcessException

isExecutable

public boolean isExecutable()

getProcessInfo

public ProcessInfo getProcessInfo()

Specified by:

getProcessInfo in interface IProcessExec

Returns:

all process information (name, UID, etc.)

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

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.

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

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

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

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

getInputConnections

public Map<String,DataConnectionList> getInputConnections()

Specified by:

getInputConnections in interface IProcessExec

Returns:

Read-only list of connections input ports

getParamConnections

public Map<String,DataConnectionList> getParamConnections()

Specified by:

getParamConnections in interface IProcessExec

Returns:

Read-only list of connections parameter ports

getOutputConnections

public Map<String,DataConnectionList> getOutputConnections()

Specified by:

getOutputConnections in interface IProcessExec

Returns:

Read-only list of connections output 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)

setInstanceName

public void setInstanceName(String name)

Description copied from interface: IProcessExec

Sets the name of this process instance

Specified by:

setInstanceName in interface IProcessExec

getInstanceName

public String getInstanceName()

Specified by:

getInstanceName in interface IProcessExec

Returns:

name of this process instance

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

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

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

checkExecutable

protected void checkExecutable()

toString

public String toString()

Overrides:

toString in class Object

getTypeOf

public Reference getTypeOf()

Gets the typeOf property

Specified by:

getTypeOf in interface AbstractProcess

isSetTypeOf

public boolean isSetTypeOf()

Checks if typeOf is set

Specified by:

isSetTypeOf in interface AbstractProcess

setTypeOf

public void setTypeOf(Reference typeOf)

Sets the typeOf property

Specified by:

setTypeOf in interface AbstractProcess

getConfiguration

public Settings getConfiguration()

Gets the configuration property

Specified by:

getConfiguration in interface AbstractProcess

isSetConfiguration

public boolean isSetConfiguration()

Checks if configuration is set

Specified by:

isSetConfiguration in interface AbstractProcess

setConfiguration

public void setConfiguration(Settings configuration)

Sets the configuration property

Specified by:

setConfiguration in interface AbstractProcess

getFeaturesOfInterest

public FeatureList getFeaturesOfInterest()

Gets the featuresOfInterest property

Specified by:

getFeaturesOfInterest in interface AbstractProcess

isSetFeaturesOfInterest

public boolean isSetFeaturesOfInterest()

Checks if featuresOfInterest is set

Specified by:

isSetFeaturesOfInterest in interface AbstractProcess

setFeaturesOfInterest

public void setFeaturesOfInterest(FeatureList featuresOfInterest)

Sets the featuresOfInterest property

Specified by:

setFeaturesOfInterest in interface AbstractProcess

getInputList

public IOPropertyList getInputList()

Description copied from interface: AbstractProcess

Gets the list of input properties

Specified by:

getInputList in interface AbstractProcess

Specified by:

getInputList in interface IProcessExec

Returns:

List of inputs

getNumInputs

public int getNumInputs()

Description copied from interface: AbstractProcess

Returns number of input properties

Specified by:

getNumInputs in interface AbstractProcess

getInput

public AbstractSWEIdentifiable getInput(String name)

Description copied from interface: AbstractProcess

Gets the input property with the given name

Specified by:

getInput in interface AbstractProcess

getInputComponent

public DataComponent getInputComponent(String name)

Description copied from interface: AbstractProcess

Gets the data structure of the input with the given name

Specified by:

getInputComponent in interface AbstractProcess

addInput

public void addInput(String name,
 DataComponent input)

Description copied from interface: AbstractProcess

Adds a new inputAsAbstractDataComponent property

Specified by:

addInput in interface AbstractProcess

addInput

public void addInput(String name,
 ObservableProperty input)

Description copied from interface: AbstractProcess

Adds a new inputAsObservableProperty property

Specified by:

addInput in interface AbstractProcess

addInput

public void addInput(String name,
 DataStream input)

Description copied from interface: AbstractProcess

Adds a new inputAsDataStream property

Specified by:

addInput in interface AbstractProcess

addInput

public void addInput(String name,
 DataInterface input)

Description copied from interface: AbstractProcess

Adds a new inputAsDataInterface property

Specified by:

addInput in interface AbstractProcess

getOutputList

public IOPropertyList getOutputList()

Description copied from interface: AbstractProcess

Gets the list of output properties

Specified by:

getOutputList in interface AbstractProcess

Specified by:

getOutputList in interface IProcessExec

Returns:

List of outputs

getNumOutputs

public int getNumOutputs()

Description copied from interface: AbstractProcess

Returns number of output properties

Specified by:

getNumOutputs in interface AbstractProcess

getOutput

public AbstractSWEIdentifiable getOutput(String name)

Description copied from interface: AbstractProcess

Gets the output property with the given name

Specified by:

getOutput in interface AbstractProcess

getOutputComponent

public DataComponent getOutputComponent(String name)

Description copied from interface: AbstractProcess

Gets the data structure of the output with the given name

Specified by:

getOutputComponent in interface AbstractProcess

addOutput

public void addOutput(String name,
 DataComponent output)

Description copied from interface: AbstractProcess

Adds a new outputAsAbstractDataComponent property

Specified by:

addOutput in interface AbstractProcess

addOutput

public void addOutput(String name,
 ObservableProperty output)

Description copied from interface: AbstractProcess

Adds a new outputAsObservableProperty property

Specified by:

addOutput in interface AbstractProcess

addOutput

public void addOutput(String name,
 DataStream output)

Description copied from interface: AbstractProcess

Adds a new outputAsDataStream property

Specified by:

addOutput in interface AbstractProcess

addOutput

public void addOutput(String name,
 DataInterface output)

Description copied from interface: AbstractProcess

Adds a new outputAsDataInterface property

Specified by:

addOutput in interface AbstractProcess

getNumParameters

public int getNumParameters()

Description copied from interface: AbstractProcess

Returns number of parameter properties

Specified by:

getNumParameters in interface AbstractProcess

getParameter

public AbstractSWEIdentifiable getParameter(String name)

Description copied from interface: AbstractProcess

Gets the parameter property with the given name

Specified by:

getParameter in interface AbstractProcess

getParameterComponent

public DataComponent getParameterComponent(String name)

Description copied from interface: AbstractProcess

Gets the data structure of the parameter with the given name

Specified by:

getParameterComponent in interface AbstractProcess

addParameter

public void addParameter(String name,
 DataComponent parameter)

Description copied from interface: AbstractProcess

Adds a new parameterAsAbstractDataComponent property

Specified by:

addParameter in interface AbstractProcess

addParameter

public void addParameter(String name,
 ObservableProperty parameter)

Description copied from interface: AbstractProcess

Adds a new parameterAsObservableProperty property

Specified by:

addParameter in interface AbstractProcess

addParameter

public void addParameter(String name,
 DataStream parameter)

Description copied from interface: AbstractProcess

Adds a new parameterAsDataStream property

Specified by:

addParameter in interface AbstractProcess

addParameter

public void addParameter(String name,
 DataInterface parameter)

Description copied from interface: AbstractProcess

Adds a new parameterAsDataInterface property

Specified by:

addParameter in interface AbstractProcess

getParameterList

public IOPropertyList getParameterList()

Description copied from interface: AbstractProcess

Gets the list of parameter properties

Specified by:

getParameterList in interface AbstractProcess

Specified by:

getParameterList in interface IProcessExec

Returns:

List of parameters

getModesList

public List<AbstractModes> getModesList()

Gets the list of modes properties

Specified by:

getModesList in interface AbstractProcess

getNumModes

public int getNumModes()

Returns number of modes properties

Specified by:

getNumModes in interface AbstractProcess

addModes

public void addModes(AbstractModes modes)

Adds a new modes property

Specified by:

addModes in interface AbstractProcess