|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.sensorevent.model.generic.GenericGroup
com.ibm.sensorevent.model.Group
com.ibm.sensorevent.model.Payload
com.ibm.sensorevent.model.payload.IBMSensorEventPayload
com.ibm.sensorevent.model.payload.CommandPayload
public abstract class CommandPayload
CommandPayload is the superclass of all payloads sent to Data Capture from Premises Server.
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 |
CommandPayload()
Constructs a CommandPayload |
protected |
CommandPayload(java.lang.String eventType)
Construts a CommandPayload for the specified event type |
Method Summary | |
---|---|
java.lang.String |
getValue()
Returns this payload's value |
protected static CommandPayload |
processMap(java.util.Map map,
CommandPayload 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 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 |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String ATTR_VALUE
Constructor Detail |
---|
protected CommandPayload() throws SensorEventException
SensorEventException
protected CommandPayload(java.lang.String eventType) throws SensorEventException
eventType
- the event type
SensorEventException
Method Detail |
---|
public java.util.Map toMap() throws SensorEventException
toMap
in interface IGroup
toMap
in class IBMSensorEventPayload
SensorEventException
public java.util.Map toTypedMap() throws SensorEventException
toTypedMap
in interface IGroup
toTypedMap
in class IBMSensorEventPayload
SensorEventException
protected static CommandPayload processMap(java.util.Map map, CommandPayload payload) throws SensorEventException
map
- source java.util.Mappayload
- target payload
SensorEventException
public java.lang.String getValue() throws SensorEventException
SensorEventException
public void setValue(java.lang.String s) throws SensorEventException
SensorEventException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |