com.ibm.sensorevent.model.payload
Class PassiveRFIDAggregatedTagReadPayload

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

public class PassiveRFIDAggregatedTagReadPayload
extends TagReadReportPayload

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

See Also:
Serialized Form

Field Summary
static java.lang.String AGGCOUNT
          The name of the aggregation count attribute within this payload
static java.lang.String COPYRIGHT
           
protected  int count
          The tag read counter within the aggregation
static java.lang.String SEPERATOR
          The separator character used before the aggregation counter in the payload event group
 
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 PassiveRFIDAggregatedTagReadPayload()
          Constructs a PassiveRFIDAggregatedTagReadPayload
protected PassiveRFIDAggregatedTagReadPayload(java.lang.String eventType)
          Construts a PassiveRFIDAggregatedTagReadPayload for the specified event type
 
Method Summary
 int addCount()
          Increments the count variable
 void addTagRead(PassiveRFIDTagRead tagread)
          Adds the specified PassiveRFIDTagRead to this payload's event group
 void copyFields(PassiveRFIDAggregatedTagReadPayload sourcePayload)
          Copies the fields unique to this class (such as payload class name) from the source payload into this payload
static IGenericGroup fromMap(java.util.Map map, java.lang.String eventType)
          Creates a PassiveRFIDAggregatedTagReadPayload from the specified java.util.Map and for the event type
 java.util.Collection getChildEPCs()
          Returns this payload's child EPC definitions
 int getCount()
          Returns the payload's count
 EPCTag getEPCTag(java.lang.String tagreadname)
          Return the EPC tag from the payload for the specific tag read
 java.util.List getEPCTags()
          Returns a list of all EPCTags from the payload
static IGenericGroup getInstance()
          Factory method to create a PassiveRFIDAggregatedTagReadPayload
static IGenericGroup getInstance(IPayload sourcePayload)
          Factory method to create a PassiveRFIDAggregatedTagReadPayload from the specified payload
static IGenericGroup getInstance(java.lang.String eventType)
          Factory method to create a PassiveRFIDAggregatedTagReadPayload for the specified event type
 java.util.Collection getParentEPCs()
          Returns this payload's parent EPC definitions
 java.lang.String getTagID(java.lang.String tagreadname)
          Returns the tag ID from the payload for the specific tag read
 java.util.List getTagIDs()
          Returns a list of all tag IDs from the payload
 IGenericGroup getTagRead(java.lang.String tagreadname)
          Returns the specific ITagRead from this payload's event group
 java.util.Collection getTagReads()
          Returns all PassiveRFIDTagRead from within this payload's event group
 void setCount(int count)
          Sets the payload's count
 void setParentEPCDef(java.util.ArrayList parentlist)
          Sets this payload's parent EPC definitions from the specified list of tag URIs
 void setParentEPCDef(java.lang.String parentType, java.lang.String parentFilter)
          Set this payload's parent EPC definitions from the specified type and filter
 java.util.Map toAmitMap()
          Converts this PassiveRFIDTagReadPayload to a java.util.Map used by AMIT
 java.util.Map toMap()
          Converts this PassiveRFIDAggregatedTagReadPayload 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 AMIT
 
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

SEPERATOR

public static final java.lang.String SEPERATOR
The separator character used before the aggregation counter in the payload event group

See Also:
Constant Field Values

AGGCOUNT

public static final java.lang.String AGGCOUNT
The name of the aggregation count attribute within this payload

See Also:
Constant Field Values

count

protected int count
The tag read counter within the aggregation

Constructor Detail

PassiveRFIDAggregatedTagReadPayload

protected PassiveRFIDAggregatedTagReadPayload()
                                       throws SensorEventException
Constructs a PassiveRFIDAggregatedTagReadPayload

Throws:
SensorEventException

PassiveRFIDAggregatedTagReadPayload

protected PassiveRFIDAggregatedTagReadPayload(java.lang.String eventType)
                                       throws SensorEventException
Construts a PassiveRFIDAggregatedTagReadPayload 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 PassiveRFIDAggregatedTagReadPayload

Throws:
SensorEventException

getInstance

public static IGenericGroup getInstance(java.lang.String eventType)
                                 throws SensorEventException
Factory method to create a PassiveRFIDAggregatedTagReadPayload 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 PassiveRFIDAggregatedTagReadPayload from the specified payload

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

copyFields

public void copyFields(PassiveRFIDAggregatedTagReadPayload sourcePayload)
                throws SensorEventException
Copies the fields unique to this class (such as payload class name) from the source payload into this payload

Parameters:
sourcePayload - the source payload
Throws:
SensorEventException

setCount

public void setCount(int count)
Sets the payload's count

Parameters:
count - the new count value

getCount

public int getCount()
Returns the payload's count


addCount

public int addCount()
Increments the count variable

Returns:
the updated count variable

toMap

public java.util.Map toMap()
                    throws SensorEventException
Converts this PassiveRFIDAggregatedTagReadPayload 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 PassiveRFIDAggregatedTagReadPayload from the specified java.util.Map and for the event type

Parameters:
map - source java.util.Map
eventType - the event type
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

getTagReads

public java.util.Collection getTagReads()
                                 throws SensorEventException
Returns all 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

setParentEPCDef

public void setParentEPCDef(java.lang.String parentType,
                            java.lang.String parentFilter)
Set this payload's parent EPC definitions from the specified type and filter

Parameters:
parentType - the type
parentFilter - the filter

setParentEPCDef

public void setParentEPCDef(java.util.ArrayList parentlist)
Sets this payload's parent EPC definitions from the specified list of tag URIs

Parameters:
parentlist - the list

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 AMIT

Throws:
SensorEventException

getParentEPCs

public java.util.Collection getParentEPCs()
                                   throws SensorEventException
Returns this payload's parent EPC definitions

Throws:
SensorEventException

getChildEPCs

public java.util.Collection getChildEPCs()
Returns this payload's child EPC definitions


getTagIDs

public java.util.List getTagIDs()
                         throws SensorEventException
Returns a list of all tag IDs 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

getEPCTags

public java.util.List getEPCTags()
                          throws SensorEventException
Returns a list of all EPCTags from the payload

Returns:
Throws:
SensorEventException

getEPCTag

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

Returns:
Throws:
SensorEventException


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