org.sensorhub.api.processing

Interface IOnDemandProcessModule<ConfigType extends ProcessConfig>

Type Parameters:

ConfigType - Type of configuration class

All Superinterfaces:

IEventProducer, IModule<ConfigType>, IProcessModule<ConfigType>

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

Base interface for on-demand processing modules.
This type of module is configured to fetch data from fixed streaming or archive sources, but can be further parameterized for each execution.
The caller is responsible for getting new process instances when appropriate: A single process instance can be reused several times sequentially, but separate instances are needed to launch in parallel.

Since:

Feb 20, 2015

Field Summary

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

CANNOT_INIT_MSG, CANNOT_LOAD_MSG, CANNOT_START_MSG, CANNOT_STOP_MSG, CANNOT_UPDATE_MSG

Method Summary

Modifier and Type	Method and Description
IOnDemandProcessInstance	getNewProcessInstance() Retrieves a new instance of this processor configured with default data sources
java.util.Map<java.lang.String,? extends DataComponent>	getParameterDescriptors() Gets the list of parameters for this process. Default parameter values can be set here but actual values are given to each process instance using one of the execute methods.

Methods inherited from interface org.sensorhub.api.processing.IProcessModule

getInputDescriptors, getOutputDescriptors, isCompatibleDataSource

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

getParameterDescriptors

java.util.Map<java.lang.String,? extends DataComponent> getParameterDescriptors()

Gets the list of parameters for this process.
Default parameter values can be set here but actual values are given to each process instance using one of the execute methods.

Returns:

map of parameter descriptors

getNewProcessInstance

IOnDemandProcessInstance getNewProcessInstance()

Retrieves a new instance of this processor configured with default data sources

Returns:

new process instance