com.sitewhere.spi.common

Interface IMetadataProvider

All Known Subinterfaces:

IBatchElement, IBatchOperation, IDevice, IDeviceAlert, IDeviceAssignment, IDeviceCommand, IDeviceCommandInvocation, IDeviceCommandResponse, IDeviceEvent, IDeviceEventWithAsset, IDeviceGroup, IDeviceLocation, IDeviceMeasurement, IDeviceMeasurements, IDeviceSpecification, IDeviceStateChange, IDeviceStream, IDeviceStreamData, IMetadataProviderEntity, ISchedule, IScheduledJob, ISite, ISiteMapData, ITenant, ITenantCreateRequest, ITenantGroup, ITenantGroupCreateRequest, IUser, IUserCreateRequest, IZone

All Known Implementing Classes:

BatchElement, BatchOperation, Device, DeviceAlert, DeviceAlertWithAsset, DeviceAssignment, DeviceCommand, DeviceCommandInvocation, DeviceCommandInvocationSummary, DeviceCommandInvocationWithAsset, DeviceCommandResponse, DeviceCommandResponseWithAsset, DeviceEvent, DeviceEventWithAsset, DeviceGroup, DeviceLocation, DeviceLocationWithAsset, DeviceMeasurement, DeviceMeasurements, DeviceMeasurementsWithAsset, DeviceSpecification, DeviceStateChange, DeviceStateChangeWithAsset, DeviceStream, DeviceStreamData, MetadataProvider, MetadataProviderEntity, Schedule, ScheduledJob, Site, SiteMapData, Tenant, TenantCreateRequest, TenantGroup, TenantGroupCreateRequest, User, UserCreateRequest, Zone

public interface IMetadataProvider

Interface for an entity that has associated metadata.

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.
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.lang.String	removeMetadata(java.lang.String name) Remove a metadata field.

Method Detail

addOrReplaceMetadata

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

Add or replace a metadata field.

Parameters:

name -

value -

Throws:

SiteWhereException

removeMetadata

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

Remove a metadata field.

Parameters:

name -

Returns:

getMetadata

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

Get value of metadata field.

Parameters:

name -

Returns:

getMetadata

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

Get a map of all metadata.

Returns:

clearMetadata

void clearMetadata()

Clear existing metadata.