com.ibm.sensorevent.model.payload
Class TagReadReportPayload

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.TagReadReportPayload
All Implemented Interfaces:
IGenericGroup, IGroup, IPayload, ISensorEventPayload, java.io.Serializable
Direct Known Subclasses:
PassiveRFIDAggregatedTagReadPayload, PassiveRFIDTagReadPayload

public abstract class TagReadReportPayload
extends IBMSensorEventPayload

TagReadReportPayload is the superclass of all tag reads sent from Data Capture to Premises Server.

See Also:
Serialized Form

Field Summary
static java.lang.String ALLTAGS
          The name of the all tags key in the AMIT map
static java.lang.String ATTR_ANTENNA
           
static java.lang.String ATTR_COUNT
           
static java.lang.String ATTR_READER
           
static java.lang.String ATTR_TAG_METADATA
          The name of the tag metadata attribute within this payload
static java.lang.String ATTR_TAGS
          The name of the tags attribute within this payload
static java.lang.String ATTR_TIME_STAMP_FIRST
           
static java.lang.String ATTR_VALUE
          The name of the value attribute within this payload
static java.lang.String CASES
          The name of the cases key in the AMIT map
static java.lang.String COPYRIGHT
           
static java.lang.String IDLIST
          The name of the IDLIST key in the AMIT map
static java.lang.String IDURILIST
          The name of the IDURILIST key in the AMIT map
static java.lang.String ITEMS
          The name of the items key in the AMIT map
static java.util.Map keyMap
           
static java.lang.String PALLETS
          The name of the pallets key in the AMIT map
static java.lang.String RAWURILIST
          The name of the RAWURILIST key in the AMIT map
static java.lang.String TAGURILIST
          The name of the TAGURILIST key in the AMIT map
 
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 TagReadReportPayload()
          Constructs a TagReadReportPayload
protected TagReadReportPayload(java.lang.String eventType)
          Constructs a TagReadReportPayload for the specified event type
 
Method Summary
 java.lang.String getValue()
          Returns this payload's value
protected static TagReadReportPayload processMap(java.util.Map map, TagReadReportPayload payload)
          Copies known attributes from the map to the payload
static IGenericGroup processMap(java.lang.String name, java.util.Map container, IGenericGroup tagReadGroup)
           
static PassiveRFIDTagRead processTagMap(java.util.Map map, java.lang.String tagID)
          Creates a PassiveRFIDTagRead from the data in the map for the specified tag ID
 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

ATTR_TAGS

public static final java.lang.String ATTR_TAGS
The name of the tags attribute within this payload

See Also:
Constant Field Values

ATTR_TAG_METADATA

public static final java.lang.String ATTR_TAG_METADATA
The name of the tag metadata attribute within this payload

See Also:
Constant Field Values

ATTR_TIME_STAMP_FIRST

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

ATTR_COUNT

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

ATTR_ANTENNA

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

ATTR_READER

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

PALLETS

public static final java.lang.String PALLETS
The name of the pallets key in the AMIT map

See Also:
Constant Field Values

CASES

public static final java.lang.String CASES
The name of the cases key in the AMIT map

See Also:
Constant Field Values

ITEMS

public static final java.lang.String ITEMS
The name of the items key in the AMIT map

See Also:
Constant Field Values

ALLTAGS

public static final java.lang.String ALLTAGS
The name of the all tags key in the AMIT map

See Also:
Constant Field Values

IDLIST

public static final java.lang.String IDLIST
The name of the IDLIST key in the AMIT map

See Also:
Constant Field Values

TAGURILIST

public static final java.lang.String TAGURILIST
The name of the TAGURILIST key in the AMIT map

See Also:
Constant Field Values

IDURILIST

public static final java.lang.String IDURILIST
The name of the IDURILIST key in the AMIT map

See Also:
Constant Field Values

RAWURILIST

public static final java.lang.String RAWURILIST
The name of the RAWURILIST key in the AMIT map

See Also:
Constant Field Values

keyMap

public static java.util.Map keyMap
Constructor Detail

TagReadReportPayload

protected TagReadReportPayload()
                        throws SensorEventException
Constructs a TagReadReportPayload

Throws:
SensorEventException

TagReadReportPayload

protected TagReadReportPayload(java.lang.String eventType)
                        throws SensorEventException
Constructs a TagReadReportPayload 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 TagReadReportPayload processMap(java.util.Map map,
                                                 TagReadReportPayload 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

processTagMap

public static PassiveRFIDTagRead processTagMap(java.util.Map map,
                                               java.lang.String tagID)
                                        throws SensorEventException
Creates a PassiveRFIDTagRead from the data in the map for the specified tag ID

Parameters:
map - the java.util.Map
tagID - the tag ID
Throws:
SensorEventException

processMap

public static IGenericGroup processMap(java.lang.String name,
                                       java.util.Map container,
                                       IGenericGroup tagReadGroup)
                                throws SensorEventException
Throws:
SensorEventException


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