org.sensorhub.api.data

Interface IMultiSourceDataProducer

public interface IMultiSourceDataProducer

Interface for multi-source data producers.
This type of producer can be used to model an entire group of data sources (e.g. sensor network) and provides additional methods to filter data records and metadata by entity ID (aka source ID).
In particular, outputs can be of type IMultiSourceDataInterface allowing data from multiple sources to be multiplexed in a single data stream.

Since:

May 31, 2015

Method Summary

Modifier and Type	Method and Description
AbstractProcess	getCurrentDescription(java.lang.String entityID) Retrieves the most current SensorML description of the given entity.
net.opengis.gml.v32.AbstractFeature	getCurrentFeatureOfInterest(java.lang.String entityID) Retrieves the feature of interest for which the given entity is currently generating data.
java.util.Collection<java.lang.String>	getEntitiesWithFoi(java.lang.String foiID) Gets IDs of entities that are observing the specified feature of interest.
java.util.Collection<java.lang.String>	getEntityIDs()
java.util.Collection<? extends net.opengis.gml.v32.AbstractFeature>	getFeaturesOfInterest()
java.util.Collection<java.lang.String>	getFeaturesOfInterestIDs()
double	getLastDescriptionUpdate(java.lang.String entityID) Used to check when SensorML description of the given entity was last updated.

Method Detail

getEntityIDs

java.util.Collection<java.lang.String> getEntityIDs()

Returns:

List of entity IDs for which this module produces data

getCurrentDescription

AbstractProcess getCurrentDescription(java.lang.String entityID)

Retrieves the most current SensorML description of the given entity.

Parameters:

entityID - unique ID of the desired entity (e.g. sensor in a network)

Returns:

AbstractProcess SensorML description of the data producing entity or null if no description is available

getLastDescriptionUpdate

double getLastDescriptionUpdate(java.lang.String entityID)

Used to check when SensorML description of the given entity was last updated. This is useful to avoid requesting the object when it hasn't changed.

Parameters:

entityID - unique ID of the desired entity (e.g. sensor in a network)

Returns:

Date/time of last description update as julian time (1970) or Long.MIN_VALUE if description was never updated.

getCurrentFeatureOfInterest

net.opengis.gml.v32.AbstractFeature getCurrentFeatureOfInterest(java.lang.String entityID)

Retrieves the feature of interest for which the given entity is currently generating data.

Parameters:

entityID - unique ID of the desired entity (e.g. sensor in a network)

Returns:

Feature object

getFeaturesOfInterest

java.util.Collection<? extends net.opengis.gml.v32.AbstractFeature> getFeaturesOfInterest()

Returns:

List of all features of interest for which this producer is generating data.

getFeaturesOfInterestIDs

java.util.Collection<java.lang.String> getFeaturesOfInterestIDs()

Returns:

Collection of IDs of all features of interest for which this producer is generating data.

getEntitiesWithFoi

java.util.Collection<java.lang.String> getEntitiesWithFoi(java.lang.String foiID)

Gets IDs of entities that are observing the specified feature of interest.

Parameters:

foiIDs - ID of feature of interest

Returns:

collection of entity IDs (can be empty)