com.ibm.sensorevent.model
Interface ISensorEvent

All Superinterfaces:
IGenericEvent, java.io.Serializable
All Known Implementing Classes:
IBMSensorEvent

public interface ISensorEvent
extends IGenericEvent

ISensorEvent is the interface representing the class IBMSensorEvent.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 IHeader getHeader()
          Returns the event's header
 IPayload getPayload()
          Returns the event's payload.
 IPayloadMetaData getPayloadMetaData()
          Returns the event's payload metadata
 java.lang.String getVersion()
          Returns the event's version
 void setHeader(IHeader header)
          Sets the event's header
 void setPayload(IPayload payload)
          Sets the event's payload
 void setPayloadMetaData(IPayloadMetaData payloadMetaData)
          Sets the event's payload metadata
 void setVersion(java.lang.String v)
          Sets the event's version
 java.util.Map toMap()
          Converts the event to a java.util.Map
 void updateEventType(java.lang.String newEventType)
          Updates the header's eventType and the payload's eventGroup name to the given new eventType.
 
Methods inherited from interface com.ibm.sensorevent.model.generic.IGenericEvent
addGroup, getGroup, getGroups, getName, removeGroups, setGroups, setName, traverseGroupPath
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getVersion

java.lang.String getVersion()
                            throws SensorEventException
Returns the event's version

Throws:
SensorEventException

setVersion

void setVersion(java.lang.String v)
                throws SensorEventException
Sets the event's version

Throws:
SensorEventException

getHeader

IHeader getHeader()
                  throws SensorEventException
Returns the event's header

Throws:
SensorEventException

setHeader

void setHeader(IHeader header)
               throws SensorEventException
Sets the event's header

Throws:
SensorEventException

getPayloadMetaData

IPayloadMetaData getPayloadMetaData()
                                    throws SensorEventException
Returns the event's payload metadata

Throws:
SensorEventException

setPayloadMetaData

void setPayloadMetaData(IPayloadMetaData payloadMetaData)
                        throws SensorEventException
Sets the event's payload metadata

Throws:
SensorEventException

getPayload

IPayload getPayload()
                    throws SensorEventException
Returns the event's payload. The payload type is defined by the class name saved in the payload, which is a subtype of IPayload. If the payload class name cannot be loaded, the type returned is IPayload.

Throws:
SensorEventException

setPayload

void setPayload(IPayload payload)
                throws SensorEventException
Sets the event's payload

Throws:
SensorEventException

toMap

java.util.Map toMap()
                    throws SensorEventException
Converts the event to a java.util.Map

Throws:
SensorEventException

updateEventType

void updateEventType(java.lang.String newEventType)
                     throws SensorEventException
Updates the header's eventType and the payload's eventGroup name to the given new eventType. The eventGroup name is updated only if the payload is an IBMSensorEventPayload.

Parameters:
newEventType - the new eventType name
Throws:
SensorEventException


Copyright © 2005 - 2009 IBM Corp. All Rights Reserved.