com.ibm.sensorevent.model.payload
Class TagRead

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.TagRead
All Implemented Interfaces:
IGenericGroup, IGroup, ITagRead, java.io.Serializable
Direct Known Subclasses:
PassiveRFIDTagRead

public class TagRead
extends Group
implements ITagRead

TagRead represents a tag read processed by Premises Server. TagRead contains Tag.

The interface associated with this class is ITagRead.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.sensorevent.model.generic.GenericGroup
attributes, groups, name
 
Fields inherited from interface com.ibm.sensorevent.model.payload.ITagRead
READER, TAG, TAGREAD
 
Constructor Summary
protected TagRead()
          Constructs a TagRead group with a default name
protected TagRead(java.lang.String newname)
          Construts a TagRead group with the specified name
 
Method Summary
 void addTag(Tag tag)
          Adds the specified Tag to this payload
static IGenericGroup getInstance()
          Factory method to create a TagRead with a default name
static IGenericGroup getInstance(Group group)
          Factory method to create a TagRead from the specified group
static IGenericGroup getInstance(java.lang.String newname)
          Factory method to create a TagRead with the specified name
 java.lang.String getReaderID()
          Returns the reader ID from this payload
 IGenericGroup getTag()
          Returns the TAG group from this payload
 IGenericGroup getTag(java.lang.String tagname)
          Returnsthe specified ITag from this payload
 void setReaderID(java.lang.String reader)
          Sets the reader ID for this payload
 
Methods inherited from class com.ibm.sensorevent.model.Group
fromMap, fromTypedMap, processGroup, processMap, processTypedGroup, processTypedMap, toMap, toTypedMap
 
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, toString, 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.IGroup
toMap, toTypedMap
 
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

TagRead

protected TagRead()
           throws SensorEventException
Constructs a TagRead group with a default name

Throws:
SensorEventException

TagRead

protected TagRead(java.lang.String newname)
           throws SensorEventException
Construts a TagRead group with the specified name

Parameters:
newname - the TagRead groups name
Throws:
SensorEventException
Method Detail

getInstance

public static IGenericGroup getInstance()
                                 throws SensorEventException
Factory method to create a TagRead with a default name

Throws:
SensorEventException

getInstance

public static IGenericGroup getInstance(java.lang.String newname)
                                 throws SensorEventException
Factory method to create a TagRead with the specified name

Parameters:
newname - the TagRead groups name
Throws:
SensorEventException

getInstance

public static IGenericGroup getInstance(Group group)
                                 throws SensorEventException
Factory method to create a TagRead from the specified group

Parameters:
group - the group to copy from
Throws:
SensorEventException

getReaderID

public java.lang.String getReaderID()
                             throws SensorEventException
Returns the reader ID from this payload

Specified by:
getReaderID in interface ITagRead
Throws:
SensorEventException

setReaderID

public void setReaderID(java.lang.String reader)
                 throws SensorEventException
Sets the reader ID for this payload

Specified by:
setReaderID in interface ITagRead
Throws:
SensorEventException

addTag

public void addTag(Tag tag)
            throws SensorEventException
Adds the specified Tag to this payload

Specified by:
addTag in interface ITagRead
Throws:
SensorEventException

getTag

public IGenericGroup getTag()
                     throws SensorEventException
Returns the TAG group from this payload

Specified by:
getTag in interface ITagRead
Throws:
SensorEventException

getTag

public IGenericGroup getTag(java.lang.String tagname)
                     throws SensorEventException
Returnsthe specified ITag from this payload

Specified by:
getTag in interface ITagRead
Parameters:
tagname - the tag group name to return
Throws:
SensorEventException


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