|
|||||||||||
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.Tag
public class Tag
Tag represents a tag processed by Premises Server.
Tags may contain metadata in the form of String key/value pairs.
The interface associated with this class is ITag
.
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.ITag |
---|
TAG, TAGID, TAGUSERDATA |
Constructor Summary | |
---|---|
protected |
Tag()
Constructs a Tag group with a default name |
protected |
Tag(java.lang.String name)
Construts a Tag group with the specified name |
Method Summary | |
---|---|
void |
addTagUserData(java.lang.String name,
java.lang.String value)
Add the name/value pair to the tag metadata |
static IGenericGroup |
getInstance()
Factory method to create a Tag with a default name |
static IGenericGroup |
getInstance(Group group)
Factory method to create a Tag from the specified group |
static IGenericGroup |
getInstance(java.lang.String newname)
Factory method to create a Tag with the specified name |
java.lang.String |
getTagID()
Returns the tag ID attribute value |
java.lang.String |
getTagID(java.lang.String name)
Returns the value of the specified attribute name |
java.lang.String |
getTagUserData(java.lang.String name)
Returns the value of tag metadata with the specified name |
java.util.Map |
getTagUserDataMap()
Returns all tag metadata as a java.util.Map |
void |
setTagID(java.lang.String value)
Sets the tag ID attribute value |
void |
setTagID(java.lang.String id,
java.lang.String value)
Sets the String attribute to the specified id and value |
Methods inherited from class com.ibm.sensorevent.model.Group |
---|
fromMap, fromTypedMap, processGroup, processMap, processTypedGroup, processTypedMap, toMap, toTypedMap |
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 |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
protected Tag() throws SensorEventException
default name
SensorEventException
protected Tag(java.lang.String name) throws SensorEventException
name
- the TagRead groups name
SensorEventException
Method Detail |
---|
public static IGenericGroup getInstance() throws SensorEventException
default name
SensorEventException
public static IGenericGroup getInstance(java.lang.String newname) throws SensorEventException
newname
- the TagRead groups name
SensorEventException
public static IGenericGroup getInstance(Group group) throws SensorEventException
group
- the group to copy from
SensorEventException
public java.lang.String getTagID() throws SensorEventException
getTagID
in interface ITag
SensorEventException
public void setTagID(java.lang.String value) throws SensorEventException
setTagID
in interface ITag
SensorEventException
public java.lang.String getTagID(java.lang.String name) throws SensorEventException
getTagID
in interface ITag
name
- the name of the attribute
SensorEventException
public void setTagID(java.lang.String id, java.lang.String value) throws SensorEventException
setTagID
in interface ITag
id
- the name of the attributevalue
- the value of the atribute
SensorEventException
public void addTagUserData(java.lang.String name, java.lang.String value) throws SensorEventException
addTagUserData
in interface ITag
SensorEventException
public java.lang.String getTagUserData(java.lang.String name) throws SensorEventException
getTagUserData
in interface ITag
name
- the name of the tag metadata
SensorEventException
public java.util.Map getTagUserDataMap() throws SensorEventException
SensorEventException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |