com.ibm.sensorevent.model.payload
Class PassiveRFIDTagReadPayload

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
                      extended by com.ibm.sensorevent.model.payload.PassiveRFIDTagReadPayload
All Implemented Interfaces:
IGenericGroup, IGroup, IPayload, ISensorEventPayload, java.io.Serializable

public class PassiveRFIDTagReadPayload
extends TagReadReportPayload

PassiveRFIDTagReadPayload represents passive RFID tag read events sent from Data Capture to Premises Server.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.sensorevent.model.payload.TagReadReportPayload
ALLTAGS, ATTR_ANTENNA, ATTR_COUNT, ATTR_READER, ATTR_TAG_METADATA, ATTR_TAGS, ATTR_TIME_STAMP_FIRST, ATTR_VALUE, CASES, IDLIST, IDURILIST, ITEMS, keyMap, PALLETS, RAWURILIST, TAGURILIST
 
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 PassiveRFIDTagReadPayload()
          Constructs a PassiveRFIDTagReadPayload
protected PassiveRFIDTagReadPayload(java.lang.String eventType)
          Construts a PassiveRFIDTagReadPayload for the specified event type
 
Method Summary
 void addTagRead(PassiveRFIDTagRead tagread)
          Adds the specified PassiveRFIDTagRead to this payload's event group
static IGenericGroup fromMap(java.util.Map map, java.lang.String eventType)
          Creates a PassiveRFIDTagReadPayload from the specified java.util.Map and for the event type
 EPCTag getEPCTag()
          Returns the EPC from the payload
 EPCTag getEPCTag(java.lang.String tagreadname)
          Returns the EPC from the payload for the specific tag read
static IGenericGroup getInstance()
          Factory method to create a PassiveRFIDTagReadPayload
static IGenericGroup getInstance(IPayload sourcePayload)
          Factory method to create a PassiveRFIDTagReadPayload from the specified payload
static IGenericGroup getInstance(java.lang.String eventType)
          Factory method to create a PassiveRFIDTagReadPayload for the specified event type
 java.lang.String getTagID()
          Returns the tag ID from the payload
 java.lang.String getTagID(java.lang.String tagreadname)
          Returns the tag ID from the payload for the specific tag read
 IGenericGroup getTagRead()
          Returns the PassiveRFIDTagRead from within this payload's event group
 IGenericGroup getTagRead(java.lang.String tagreadname)
          Returns the specific ITagRead from this payload's event group
 java.util.Map toAmitMap()
          Converts this PassiveRFIDTagReadPayload to a java.util.Map used by AMIT
 java.util.Map toMap()
          Converts this PassiveRFIDTagReadPayload to a java.util.Map
 java.util.Map toTypedMap()
          Returns the same result as toMap
 java.util.Map toWarehouseSampleAmitMap()
          Converts this PassiveRFIDTagReadPayload to a java.util.Map used by the Warehouse Sample using AMIT rules
 
Methods inherited from class com.ibm.sensorevent.model.payload.TagReadReportPayload
getValue, processMap, processMap, processTagMap, setValue
 
Methods inherited from class com.ibm.sensorevent.model.payload.IBMSensorEventPayload
copyFields, fromMap, fromMap, fromTypedMap, fromTypedMap, fromTypedMap, getAllGenericTagIDs, getEventGroup, getGenericTagID, getGenericTagIDFromAttribute, getGenericTagIDs, getGenericTagIDsFromAttribute, 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
Constructor Detail

PassiveRFIDTagReadPayload

protected PassiveRFIDTagReadPayload()
                             throws SensorEventException
Constructs a PassiveRFIDTagReadPayload

Throws:
SensorEventException

PassiveRFIDTagReadPayload

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

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

getInstance

public static IGenericGroup getInstance()
                                 throws SensorEventException
Factory method to create a PassiveRFIDTagReadPayload

Throws:
SensorEventException

getInstance

public static IGenericGroup getInstance(java.lang.String eventType)
                                 throws SensorEventException
Factory method to create a PassiveRFIDTagReadPayload for the specified event type

Parameters:
eventType - the event type
Throws:
SensorEventException

getInstance

public static IGenericGroup getInstance(IPayload sourcePayload)
                                 throws SensorEventException
Factory method to create a PassiveRFIDTagReadPayload from the specified payload

Parameters:
sourcePayload - the payload to copy from
Throws:
SensorEventException

toMap

public java.util.Map toMap()
                    throws SensorEventException
Converts this PassiveRFIDTagReadPayload to a java.util.Map

Specified by:
toMap in interface IGroup
Overrides:
toMap in class TagReadReportPayload
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 TagReadReportPayload
Throws:
SensorEventException

fromMap

public static IGenericGroup fromMap(java.util.Map map,
                                    java.lang.String eventType)
                             throws SensorEventException
Creates a PassiveRFIDTagReadPayload from the specified java.util.Map and for the event type

Parameters:
map - source java.util.Map
eventType - the event type
Throws:
SensorEventException

toAmitMap

public java.util.Map toAmitMap()
                        throws SensorEventException
Converts this PassiveRFIDTagReadPayload to a java.util.Map used by AMIT

Throws:
SensorEventException

toWarehouseSampleAmitMap

public java.util.Map toWarehouseSampleAmitMap()
                                       throws SensorEventException
Converts this PassiveRFIDTagReadPayload to a java.util.Map used by the Warehouse Sample using AMIT rules

Throws:
SensorEventException

addTagRead

public void addTagRead(PassiveRFIDTagRead tagread)
                throws SensorEventException
Adds the specified PassiveRFIDTagRead to this payload's event group

Parameters:
tagread - the PassiveRFIDTagRead to add
Throws:
SensorEventException

getTagRead

public IGenericGroup getTagRead()
                         throws SensorEventException
Returns the PassiveRFIDTagRead from within this payload's event group

Throws:
SensorEventException

getTagRead

public IGenericGroup getTagRead(java.lang.String tagreadname)
                         throws SensorEventException
Returns the specific ITagRead from this payload's event group

Parameters:
tagreadname - the tag read name to return
Throws:
SensorEventException

getTagID

public java.lang.String getTagID()
                          throws SensorEventException
Returns the tag ID from the payload

Returns:
Throws:
SensorEventException

getTagID

public java.lang.String getTagID(java.lang.String tagreadname)
                          throws SensorEventException
Returns the tag ID from the payload for the specific tag read

Returns:
Throws:
SensorEventException

getEPCTag

public EPCTag getEPCTag()
                 throws SensorEventException
Returns the EPC from the payload

Returns:
Throws:
SensorEventException

getEPCTag

public EPCTag getEPCTag(java.lang.String tagreadname)
                 throws SensorEventException
Returns the EPC from the payload for the specific tag read

Returns:
Throws:
SensorEventException


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