com.ibm.sensorevent.model.payload
Class ReportPayload

java.lang.Object
  extended by com.ibm.sensorevent.model.generic.GenericGroup
      extended by com.ibm.sensorevent.model.Group
          extended by com.ibm.sensorevent.model.Payload
              extended by com.ibm.sensorevent.model.payload.IBMSensorEventPayload
                  extended by com.ibm.sensorevent.model.payload.ReportPayload
All Implemented Interfaces:
IGenericGroup, IGroup, IPayload, ISensorEventPayload, java.io.Serializable
Direct Known Subclasses:
AlertDebugPayload, AlertErrorPayload, AlertInfoPayload, AlertWarningPayload, ApplicationPongPayload, HeartbeatPayload, PortalReportPayload, TagReadFeedbackPayload

public abstract class ReportPayload
extends IBMSensorEventPayload

ReportPayload is the superclass of all payloads (except tag reads) sent from Data Capture to Premises Server.

See Also:
Serialized Form

Field Summary
static java.lang.String ATTR_VALUE
          The name of the value attribute within this payload
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.sensorevent.model.payload.IBMSensorEventPayload
ATTR_TAG_KEY_INOUT, ATTR_TAGLIST_KEY_INOUT, eventGroup
 
Fields inherited from class com.ibm.sensorevent.model.Payload
payloadClassName
 
Fields inherited from class com.ibm.sensorevent.model.generic.GenericGroup
attributes, groups, name
 
Constructor Summary
protected ReportPayload()
          Constructs a ReportPayload
protected ReportPayload(java.lang.String eventType)
          Construts a ReportPayload for the specified event type
 
Method Summary
 java.lang.String getValue()
          Returns this payload's value
protected static ReportPayload processMap(java.util.Map map, ReportPayload payload)
          Copies known attributes from the map to the payload
 void setValue(java.lang.String s)
          Sets this payload's value
 java.util.Map toMap()
          Converts this payload to a java.util.Map of strings
 java.util.Map toTypedMap()
          Returns the same result as toMap
 
Methods inherited from class com.ibm.sensorevent.model.payload.IBMSensorEventPayload
copyFields, fromMap, fromMap, fromMap, fromTypedMap, fromTypedMap, fromTypedMap, getAllGenericTagIDs, getEventGroup, getGenericTagID, getGenericTagIDFromAttribute, getGenericTagIDs, getGenericTagIDsFromAttribute, getInstance, getInstance, getInstance, getInstance, setEventGroup
 
Methods inherited from class com.ibm.sensorevent.model.Payload
copyFields, copyGroup, getPayloadClassName, setPayloadClassName, toString
 
Methods inherited from class com.ibm.sensorevent.model.Group
processGroup, processMap, processTypedGroup, processTypedMap
 
Methods inherited from class com.ibm.sensorevent.model.generic.GenericGroup
addAttribute, addAttributeArray, addBooleanArrayAttribute, addBooleanAttribute, addByteArrayAttribute, addByteAttribute, addDateArrayAttribute, addDateArrayAttributeAsLong, addDateAttribute, addDateAttributeAsLong, addDoubleArrayAttribute, addDoubleAttribute, addFloatArrayAttribute, addFloatAttribute, addGroup, addHexAttribute, addHexAttribute, addIntArrayAttribute, addIntAttribute, addLongArrayAttribute, addLongAttribute, addShortArrayAttribute, addShortAttribute, addStringArrayAttribute, addStringAttribute, createGroupPath, getAttribute, getAttributes, getAttributesAsList, getBooleanAttributeArrayValue, getBooleanAttributeValue, getByteAttributeArrayValue, getByteAttributeValue, getDateAttributeArrayValue, getDateAttributeArrayValueAsLong, getDateAttributeValue, getDateAttributeValueAsLong, getDoubleAttributeArrayValue, getDoubleAttributeValue, getFloatAttributeArrayValue, getFloatAttributeValue, getGroup, getGroups, getGroupsAsList, getHexAttributeValue, getHexAttributeValueAsString, getIntAttributeArrayValue, getIntAttributeValue, getLongAttributeArrayValue, getLongAttributeValue, getName, getShortAttributeArrayValue, getShortAttributeValue, getStringAttributeArrayValue, getStringAttributeValue, removeAttributes, removeGroups, setAttributes, setGroups, setName, traverseGroupPath
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.sensorevent.model.IPayload
copyFields, getPayloadClassName, setPayloadClassName
 
Methods inherited from interface com.ibm.sensorevent.model.generic.IGenericGroup
addAttribute, addAttributeArray, addBooleanArrayAttribute, addBooleanAttribute, addByteArrayAttribute, addByteAttribute, addDateArrayAttribute, addDateArrayAttributeAsLong, addDateAttribute, addDateAttributeAsLong, addDoubleArrayAttribute, addDoubleAttribute, addFloatArrayAttribute, addFloatAttribute, addGroup, addHexAttribute, addHexAttribute, addIntArrayAttribute, addIntAttribute, addLongArrayAttribute, addLongAttribute, addShortArrayAttribute, addShortAttribute, addStringArrayAttribute, addStringAttribute, createGroupPath, getAttribute, getAttributes, getAttributesAsList, getBooleanAttributeArrayValue, getBooleanAttributeValue, getByteAttributeArrayValue, getByteAttributeValue, getDateAttributeArrayValue, getDateAttributeArrayValueAsLong, getDateAttributeValue, getDateAttributeValueAsLong, getDoubleAttributeArrayValue, getDoubleAttributeValue, getFloatAttributeArrayValue, getFloatAttributeValue, getGroup, getGroups, getGroupsAsList, getHexAttributeValue, getHexAttributeValueAsString, getIntAttributeArrayValue, getIntAttributeValue, getLongAttributeArrayValue, getLongAttributeValue, getName, getShortAttributeArrayValue, getShortAttributeValue, getStringAttributeArrayValue, getStringAttributeValue, removeAttributes, removeGroups, setAttributes, setGroups, setName, traverseGroupPath
 

Field Detail

COPYRIGHT

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

ATTR_VALUE

public static final java.lang.String ATTR_VALUE
The name of the value attribute within this payload

See Also:
Constant Field Values
Constructor Detail

ReportPayload

protected ReportPayload()
                 throws SensorEventException
Constructs a ReportPayload

Throws:
SensorEventException

ReportPayload

protected ReportPayload(java.lang.String eventType)
                 throws SensorEventException
Construts a ReportPayload for the specified event type

Parameters:
eventType - the event type
Throws:
SensorEventException
Method Detail

toMap

public java.util.Map toMap()
                    throws SensorEventException
Converts this payload to a java.util.Map of strings

Specified by:
toMap in interface IGroup
Overrides:
toMap in class IBMSensorEventPayload
Throws:
SensorEventException

toTypedMap

public java.util.Map toTypedMap()
                         throws SensorEventException
Returns the same result as toMap

Specified by:
toTypedMap in interface IGroup
Overrides:
toTypedMap in class IBMSensorEventPayload
Throws:
SensorEventException

processMap

protected static ReportPayload processMap(java.util.Map map,
                                          ReportPayload payload)
                                   throws SensorEventException
Copies known attributes from the map to the payload

Parameters:
map - source java.util.Map
payload - target payload
Throws:
SensorEventException

getValue

public java.lang.String getValue()
                          throws SensorEventException
Returns this payload's value

Throws:
SensorEventException

setValue

public void setValue(java.lang.String s)
              throws SensorEventException
Sets this payload's value

Throws:
SensorEventException


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