org.sensorhub.api.processing

Interface IProcessModule<ConfigType extends ProcessConfig>

Type Parameters:

ConfigType - Type of configuration class

All Superinterfaces:

IEventProducer, IModule<ConfigType>

All Known Subinterfaces:

IOnDemandProcessModule<ConfigType>, IStreamProcessModule<ConfigType>

All Known Implementing Classes:

AbstractStreamProcess, SMLStreamProcess

public interface IProcessModule<ConfigType extends ProcessConfig>
extends IModule<ConfigType>

Base interface for all SensorHub data processing modules

Since:

Feb 21, 2015

Author:

Alex Robin

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,DataComponent>	getInputDescriptors() Gets the list of inputs needed by this process. Note that input data may contain more than the needed input.
Map<String,DataComponent>	getOutputDescriptors()
boolean	isCompatibleDataSource(DataSourceConfig dataSource) Checks that a given data source is acceptable for this process

Methods inherited from interface org.sensorhub.api.module.IModule

cleanup, getConfiguration, getCurrentError, getCurrentState, getLocalID, getName, getStatusMessage, init, init, isInitialized, isStarted, loadState, registerListener, requestInit, requestStart, requestStop, saveState, setConfiguration, start, stop, unregisterListener, updateConfig, waitForState

Method Detail

getInputDescriptors

Map<String,DataComponent> getInputDescriptors()

Gets the list of inputs needed by this process.
Note that input data may contain more than the needed input. To confirm that a given input is acceptable, call isCompatibleDataSource(DataSourceConfig)

Returns:

map of descriptors of needed inputs

getOutputDescriptors

Map<String,DataComponent> getOutputDescriptors()

Returns:

map of output descriptors

isCompatibleDataSource

boolean isCompatibleDataSource(DataSourceConfig dataSource)

Checks that a given data source is acceptable for this process

Parameters:

dataSource -

Returns:

true if data source is acceptable for this process