org.sensorhub.api.common

Class EntityEvent<EventTypeEnum extends Enum<?>>

java.lang.Object

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

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

Type Parameters:

EventTypeEnum - Enum of possible event sub-type

Direct Known Subclasses:

DataEvent, FoiEvent, SensorControlEvent, SensorEvent

public abstract class EntityEvent<EventTypeEnum extends Enum<?>>
extends Event<EventTypeEnum>

Base class for all events that relates to a particular entity.
An entity in SensorHub can be a sensor, a process, etc. and this type of event is useful when it is related to a particular entity within a group such as a sensor network or a process grid.

Since:

Apr 23, 2015

Author:

Alex Robin

Field Summary

Fields

Modifier and Type	Field and Description
protected String	relatedEntityID

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

source, timeStamp, type

Constructor Summary

Constructors

Constructor and Description
EntityEvent()

Method Summary

Methods

Modifier and Type	Method and Description
String	getRelatedEntityID() Gets the unique ID of the entity related to this event. For group of entities (e.g.

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

getSource, getTimeStamp, getType

Methods inherited from class java.lang.Object

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

Field Detail

relatedEntityID

protected String relatedEntityID

See Also:

getRelatedEntityID()

Constructor Detail

EntityEvent

public EntityEvent()

Method Detail

getRelatedEntityID

public String getRelatedEntityID()

Gets the unique ID of the entity related to this event.
For group of entities (e.g. sensor networks), it will be either the ID of the group as a whole (if the event is global) or the ID of a single entity within the group (if the event applies only to that entity)

Returns:

Unique ID of related entity