|
|||||||||||
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
public class IBMSensorEventPayload
IBMSensorEventPayload is the superclass of all payloads within the IBM sensor event model.
Each IBMSensorEventPayload has
The interface associated with this class is ISensorEventPayload
.
Field Summary | |
---|---|
static java.lang.String |
ATTR_TAG_KEY_INOUT
|
static java.lang.String |
ATTR_TAGLIST_KEY_INOUT
|
static java.lang.String |
ATTR_VALUE
|
static java.lang.String |
COPYRIGHT
|
protected IGroup |
eventGroup
The group within the IBMSensorEventPayload containing all attributes and subgroups |
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 |
IBMSensorEventPayload()
Constructs an IBMSensorEventPayload |
protected |
IBMSensorEventPayload(IGroup eventGroup)
Constructs an IBMSensorEventPayload with the given event group |
protected |
IBMSensorEventPayload(java.lang.String eventType)
Constructs an IBMSensorEventPayload with an event group whose name is the specified event type |
Method Summary | |
---|---|
void |
copyFields(ISensorEventPayload sourcePayload)
Copies the fields unique to this class (such as event group) and to its super class from the source payload into this payload. |
static IGenericGroup |
fromMap(java.util.Map map)
Converts the specified java.util.Map into a IGenericGroup. |
static IGenericGroup |
fromMap(java.util.Map map,
java.lang.String eventType)
Converts the specified java.util.Map into an IBMSensorEventPayload whose name is eventType. |
static IGenericGroup |
fromMap(java.lang.String eventType,
java.util.Map map)
Converts the specified java.util.Map into an IBMSensorEventPayload whose name is eventType. |
static IGenericGroup |
fromTypedMap(java.util.Map map)
Converts the specified java.util.Map into a IGenericGroup. |
static IGenericGroup |
fromTypedMap(java.util.Map map,
java.lang.String eventType)
Converts the specified java.util.Map into an IBMSensorEventPayload whose name is eventType. |
static IGenericGroup |
fromTypedMap(java.lang.String eventType,
java.util.Map map)
Converts the specified java.util.Map into an IBMSensorEventPayload whose name is eventType. |
java.util.List |
getAllGenericTagIDs()
Return a list of all tag IDs from the event group. |
IGroup |
getEventGroup()
Returns this payload's event group |
java.lang.String |
getGenericTagID()
Return a the tag ID from the event group in string attribute "com.ibm.premises.reusable.tag". |
java.lang.String |
getGenericTagIDFromAttribute(java.lang.String attrName)
Return a the tag ID from the event group in string attribute attrName. |
java.util.List |
getGenericTagIDs()
Return a list of all tag IDs from the event group in string array attribute "com.ibm.premises.reusable.taglist". |
java.util.List |
getGenericTagIDsFromAttribute(java.lang.String attrName)
Return a list of all tag IDs from the event group in string array attribute attrName. |
static IGenericGroup |
getInstance()
Factory method to create an IBMSensorEventPayload without an event group. |
static IGenericGroup |
getInstance(IGroup eventGroup)
Factory method to create an IBMSensorEventPayload with the given event group |
static IGenericGroup |
getInstance(IPayload sourcePayload)
Factory method to create a IBMSensorEventPayload from the specified payload |
static IGenericGroup |
getInstance(java.lang.String eventType)
Factory method to create an IBMSensorEventPayload with an event group whose name is the specified event type |
void |
setEventGroup(IGroup group)
Sets this payload's event group |
java.util.Map |
toMap()
Converts this payload to a java.util.Map of strings |
java.util.Map |
toTypedMap()
Converts this payload to a java.util.Map; the values' data types are preserved |
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
public static final java.lang.String ATTR_TAG_KEY_INOUT
public static final java.lang.String ATTR_TAGLIST_KEY_INOUT
protected volatile IGroup eventGroup
Constructor Detail |
---|
protected IBMSensorEventPayload() throws SensorEventException
SensorEventException
protected IBMSensorEventPayload(java.lang.String eventType) throws SensorEventException
eventType
- the name of the event group
SensorEventException
protected IBMSensorEventPayload(IGroup eventGroup) throws SensorEventException
eventGroup
- the event group
SensorEventException
Method Detail |
---|
public static IGenericGroup getInstance() throws SensorEventException
SensorEventException
public static IGenericGroup getInstance(java.lang.String eventType) throws SensorEventException
eventType
- the name of the event group
SensorEventException
public static IGenericGroup getInstance(IGroup eventGroup) throws SensorEventException
eventGroup
- the event group
SensorEventException
public static IGenericGroup getInstance(IPayload sourcePayload) throws SensorEventException
sourcePayload
- the payload to copy from
SensorEventException
public IGroup getEventGroup() throws SensorEventException
getEventGroup
in interface ISensorEventPayload
SensorEventException
public void setEventGroup(IGroup group) throws SensorEventException
setEventGroup
in interface ISensorEventPayload
SensorEventException
public void copyFields(ISensorEventPayload sourcePayload) throws SensorEventException
sourcePayload
- the source payload
SensorEventException
public java.util.List getAllGenericTagIDs() throws SensorEventException
SensorEventException
public java.util.List getGenericTagIDs() throws SensorEventException
SensorEventException
public java.util.List getGenericTagIDsFromAttribute(java.lang.String attrName) throws SensorEventException
SensorEventException
public java.lang.String getGenericTagID() throws SensorEventException
SensorEventException
public java.lang.String getGenericTagIDFromAttribute(java.lang.String attrName) throws SensorEventException
SensorEventException
public java.util.Map toMap() throws SensorEventException
toMap
in interface IGroup
toMap
in class Group
SensorEventException
public java.util.Map toTypedMap() throws SensorEventException
toTypedMap
in interface IGroup
toTypedMap
in class Group
SensorEventException
public static IGenericGroup fromMap(java.util.Map map) throws SensorEventException
map
- the map
SensorEventException
public static IGenericGroup fromTypedMap(java.util.Map map) throws SensorEventException
map
- the map
SensorEventException
public static IGenericGroup fromMap(java.lang.String eventType, java.util.Map map) throws SensorEventException
eventType
- the group namemap
- the map
SensorEventException
public static IGenericGroup fromTypedMap(java.lang.String eventType, java.util.Map map) throws SensorEventException
eventType
- the group namemap
- the map
SensorEventException
public static IGenericGroup fromMap(java.util.Map map, java.lang.String eventType) throws SensorEventException
eventType
- the group namemap
- the map
SensorEventException
public static IGenericGroup fromTypedMap(java.util.Map map, java.lang.String eventType) throws SensorEventException
eventType
- the group namemap
- the map
SensorEventException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |