com.sitewhere.rest.model.device.asset

Class DeviceEventWithAsset

java.lang.Object

com.sitewhere.rest.model.device.asset.DeviceEventWithAsset

All Implemented Interfaces:

IMetadataProvider, IDeviceEventWithAsset, IDeviceEvent, java.io.Serializable, java.lang.Comparable<IDeviceEvent>

Direct Known Subclasses:

DeviceAlertWithAsset, DeviceCommandInvocationWithAsset, DeviceCommandResponseWithAsset, DeviceLocationWithAsset, DeviceMeasurementsWithAsset, DeviceStateChangeWithAsset

public class DeviceEventWithAsset
extends java.lang.Object
implements IDeviceEventWithAsset

Wraps a device event and provides extra information the associated asset from its assignment.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IAsset	asset Associated asset
static java.lang.String	UNASSOCIATED_ASSET_NAME Text shown when an asset is not assigned
protected IDeviceEvent	wrapped Wrapped event

Constructor Summary

Constructors

Constructor and Description
DeviceEventWithAsset(IDeviceEvent wrapped, IAssetModuleManager assets)

Method Summary

Modifier and Type	Method and Description
void	addOrReplaceMetadata(java.lang.String name, java.lang.String value) Add or replace a metadata field.
void	clearMetadata() Clear existing metadata.
int	compareTo(IDeviceEvent o)
java.lang.String	getAssetId() Get id of asset if associated.
java.lang.String	getAssetModuleId() Get id of asset module.
java.lang.String	getAssetName() Get human-readable asset name.
DeviceAssignmentType	getAssignmentType() Get assignment type.
java.lang.String	getDeviceAssignmentToken() Get the device assignment the event pertains to.
java.util.Date	getEventDate() Get the date the event occurred.
DeviceEventType	getEventType() Get event type indicator.
java.lang.String	getId() Get a string that uniquely identifies the event.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Get a map of all metadata.
java.lang.String	getMetadata(java.lang.String name) Get value of metadata field.
java.util.Date	getReceivedDate() Get the date this event was received.
java.lang.String	getSiteToken() Get token for site the event pertains to.
protected IDeviceEvent	getWrapped()
java.lang.String	removeMetadata(java.lang.String name) Remove a metadata field.

Methods inherited from class java.lang.Object

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

Field Detail

UNASSOCIATED_ASSET_NAME

public static final java.lang.String UNASSOCIATED_ASSET_NAME

Text shown when an asset is not assigned

See Also:

Constant Field Values

wrapped

protected IDeviceEvent wrapped

Wrapped event

asset

protected IAsset asset

Associated asset

Constructor Detail

DeviceEventWithAsset

public DeviceEventWithAsset(IDeviceEvent wrapped,
                            IAssetModuleManager assets)
                     throws SiteWhereException

Throws:

SiteWhereException

Method Detail

getAssetName

public java.lang.String getAssetName()

Description copied from interface: IDeviceEventWithAsset

Get human-readable asset name.

Specified by:

getAssetName in interface IDeviceEventWithAsset

Returns:

addOrReplaceMetadata

public void addOrReplaceMetadata(java.lang.String name,
                                 java.lang.String value)
                          throws SiteWhereException

Description copied from interface: IMetadataProvider

Add or replace a metadata field.

Specified by:

addOrReplaceMetadata in interface IMetadataProvider

Throws:

SiteWhereException

removeMetadata

public java.lang.String removeMetadata(java.lang.String name)

Description copied from interface: IMetadataProvider

Remove a metadata field.

Specified by:

removeMetadata in interface IMetadataProvider

Returns:

getMetadata

public java.lang.String getMetadata(java.lang.String name)

Description copied from interface: IMetadataProvider

Get value of metadata field.

Specified by:

getMetadata in interface IMetadataProvider

Returns:

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Description copied from interface: IMetadataProvider

Get a map of all metadata.

Specified by:

getMetadata in interface IMetadataProvider

Returns:

clearMetadata

public void clearMetadata()

Description copied from interface: IMetadataProvider

Clear existing metadata.

Specified by:

clearMetadata in interface IMetadataProvider

compareTo

public int compareTo(IDeviceEvent o)

Specified by:

compareTo in interface java.lang.Comparable<IDeviceEvent>

getId

public java.lang.String getId()

Description copied from interface: IDeviceEvent

Get a string that uniquely identifies the event.

Specified by:

getId in interface IDeviceEvent

Returns:

getEventType

public DeviceEventType getEventType()

Description copied from interface: IDeviceEvent

Get event type indicator.

Specified by:

getEventType in interface IDeviceEvent

Returns:

getSiteToken

public java.lang.String getSiteToken()

Description copied from interface: IDeviceEvent

Get token for site the event pertains to.

Specified by:

getSiteToken in interface IDeviceEvent

Returns:

getDeviceAssignmentToken

public java.lang.String getDeviceAssignmentToken()

Description copied from interface: IDeviceEvent

Get the device assignment the event pertains to.

Specified by:

getDeviceAssignmentToken in interface IDeviceEvent

Returns:

getAssignmentType

public DeviceAssignmentType getAssignmentType()

Description copied from interface: IDeviceEvent

Get assignment type.

Specified by:

getAssignmentType in interface IDeviceEvent

Returns:

getAssetModuleId

public java.lang.String getAssetModuleId()

Description copied from interface: IDeviceEvent

Get id of asset module.

Specified by:

getAssetModuleId in interface IDeviceEvent

Returns:

getAssetId

public java.lang.String getAssetId()

Description copied from interface: IDeviceEvent

Get id of asset if associated.

Specified by:

getAssetId in interface IDeviceEvent

Returns:

getEventDate

public java.util.Date getEventDate()

Description copied from interface: IDeviceEvent

Get the date the event occurred.

Specified by:

getEventDate in interface IDeviceEvent

Returns:

getReceivedDate

public java.util.Date getReceivedDate()

Description copied from interface: IDeviceEvent

Get the date this event was received.

Specified by:

getReceivedDate in interface IDeviceEvent

Returns:

getWrapped

protected IDeviceEvent getWrapped()