org.sensorhub.api.data

Class DataEvent

java.lang.Object

org.sensorhub.api.common.Event<EventTypeEnum>

org.sensorhub.api.common.EntityEvent<DataEvent.Type>

org.sensorhub.api.data.DataEvent

Direct Known Subclasses:

SensorDataEvent

public class DataEvent
extends EntityEvent<DataEvent.Type>

Type of event generated when new data is available from a data producer. It is immutable and carries data by reference.

Since:

Feb 20, 2015

Author:

Alex Robin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataEvent.Type Possible event types for a DataEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected DataBlock[]	records New data that triggered this event. Multiple records can be associated to a single event because with high rate producers, it is often not practical to generate an event for every single record of measurements.

Fields inherited from class org.sensorhub.api.common.EntityEvent

relatedEntityID

Fields inherited from class org.sensorhub.api.common.Event

source, timeStamp, type

Constructor Summary

Constructors

Constructor and Description
DataEvent(long timeStamp, IStreamingDataInterface dataInterface, DataBlock... records) Constructs a data event with no related entity
DataEvent(long timeStamp, String entityID, IStreamingDataInterface dataInterface, DataBlock... records) Constructs a data event associated to an identifiable entity

Method Summary

Methods

Modifier and Type	Method and Description
DataComponent	getRecordDescription()
DataBlock[]	getRecords()
IStreamingDataInterface	getSource() Gets the source of the event as an object reference.
DataEvent.Type	getType()

Methods inherited from class org.sensorhub.api.common.EntityEvent

getRelatedEntityID

Methods inherited from class org.sensorhub.api.common.Event

getTimeStamp

Methods inherited from class java.lang.Object

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

Field Detail

records

protected DataBlock[] records

New data that triggered this event.
Multiple records can be associated to a single event because with high rate producers, it is often not practical to generate an event for every single record of measurements.

Constructor Detail

DataEvent

public DataEvent(long timeStamp,
         IStreamingDataInterface dataInterface,
         DataBlock... records)

Constructs a data event with no related entity

Parameters:

timeStamp - time of event generation (unix time in milliseconds, base 1970)

dataInterface - stream interface that generated the associated data

records - arrays of records that triggered this notification

DataEvent

public DataEvent(long timeStamp,
         String entityID,
         IStreamingDataInterface dataInterface,
         DataBlock... records)

Constructs a data event associated to an identifiable entity

Parameters:

timeStamp - time of event generation (unix time in milliseconds, base 1970)

entityID - Unique ID of entity that produced the data records

dataInterface - stream interface that generated the associated data

records - arrays of records that triggered this notification

Method Detail

getType

public DataEvent.Type getType()

Overrides:

getType in class Event<DataEvent.Type>

Returns:

Event sub-type (depending on actual event class)

getSource

public IStreamingDataInterface getSource()

Description copied from class: Event

Gets the source of the event as an object reference.

Overrides:

getSource in class Event<DataEvent.Type>

Returns:

Source object that generated this event

getRecordDescription

public DataComponent getRecordDescription()

Returns:

description of the data records attached to this event

getRecords

public DataBlock[] getRecords()

Returns:

list of data records produced