com.ibm.sensorevent.model.generic
Interface IGenericGroup

All Known Subinterfaces:
IGroup, IHeader, IPayload, IPayloadMetaData, ISensorEventPayload, ITag, ITagRead
All Known Implementing Classes:
AlertDebugPayload, AlertErrorPayload, AlertInfoPayload, AlertWarningPayload, ApplicationPingPayload, ApplicationPongPayload, CommandPayload, EPCTag, GenericGroup, Group, Header, HeartbeatPayload, IBMSensorEventPayload, PassiveRFIDAggregatedTagReadPayload, PassiveRFIDTagRead, PassiveRFIDTagReadPayload, Payload, PayloadMetaData, PortalCommandPayload, PortalReportPayload, ReloadPayload, ReportPayload, RestartPayload, Tag, TagRead, TagReadFeedbackPayload, TagReadReportPayload

public interface IGenericGroup

IGenericGroup is the interface representing the class GenericGroup.


Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 void addAttribute(IGenericAttribute attribute)
          Adds an attribute to this group's collection of attributes.
 void addAttributeArray(java.lang.String name, java.lang.Object[] value, int type)
           
 void addBooleanArrayAttribute(java.lang.String name, boolean[] value)
          Adds an attribute to this group's collection of attributes.
 void addBooleanAttribute(java.lang.String name, boolean value)
          Adds an attribute to this group's collection of attributes.
 void addByteArrayAttribute(java.lang.String name, byte[] b)
          Adds an attribute to this group's collection of attributes.
 void addByteAttribute(java.lang.String name, byte b)
          Adds an attribute to this group's collection of attributes.
 void addDateArrayAttribute(java.lang.String name, java.util.Date[] d)
          Adds an attribute to this group's collection of attributes.
 void addDateArrayAttributeAsLong(java.lang.String name, long[] l)
          Adds an attribute to this group's collection of attributes.
 void addDateAttribute(java.lang.String name, java.util.Date d)
          Adds an attribute to this group's collection of attributes.
 void addDateAttributeAsLong(java.lang.String name, long l)
          Adds an attribute to this group's collection of attributes.
 void addDoubleArrayAttribute(java.lang.String name, double[] d)
          Adds an attribute to this group's collection of attributes.
 void addDoubleAttribute(java.lang.String name, double d)
          Adds an attribute to this group's collection of attributes.
 void addFloatArrayAttribute(java.lang.String name, float[] f)
          Adds an attribute to this group's collection of attributes.
 void addFloatAttribute(java.lang.String name, float f)
          Adds an attribute to this group's collection of attributes.
 void addGroup(IGenericGroup group)
          Adds a subgroup to this group
 void addHexAttribute(java.lang.String name, byte[] b)
          Adds an attribute to this group's collection of attributes.
 void addHexAttribute(java.lang.String name, java.lang.String s)
          Adds an attribute to this group's collection of attributes.
 void addIntArrayAttribute(java.lang.String name, int[] i)
          Adds an attribute to this group's collection of attributes.
 void addIntAttribute(java.lang.String name, int i)
          Adds an attribute to this group's collection of attributes.
 void addLongArrayAttribute(java.lang.String name, long[] l)
          Adds an attribute to this group's collection of attributes.
 void addLongAttribute(java.lang.String name, long l)
          Adds an attribute to this group's collection of attributes.
 void addShortArrayAttribute(java.lang.String name, short[] s)
          Adds an attribute to this group's collection of attributes.
 void addShortAttribute(java.lang.String name, short s)
          Adds an attribute to this group's collection of attributes.
 void addStringArrayAttribute(java.lang.String name, java.lang.String[] s)
          Adds an attribute to this group's collection of attributes.
 void addStringAttribute(java.lang.String name, java.lang.String s)
          Adds an attribute to this group's collection of attributes.
 void createGroupPath(java.util.List path)
          Constructs the nested subgroups using the names specified in path.
 IGenericAttribute getAttribute(java.lang.String name)
          Returns the attribute from this group with the specified name
 java.util.Collection getAttributes()
          Returns this group's attributes as a collection of IGenericAttribute
 java.util.List getAttributesAsList()
          Returns this group's attributes as a list of IGenericAttribute
 boolean[] getBooleanAttributeArrayValue(java.lang.String name)
          Returns the boolean array attribute value from this group with the specified name
 boolean getBooleanAttributeValue(java.lang.String name)
          Returns the boolean attribute value from this group with the specified name
 byte[] getByteAttributeArrayValue(java.lang.String name)
          Returns the byte array attribute value from this group with the specified name
 byte getByteAttributeValue(java.lang.String name)
          Returns the byte attribute value from this group with the specified name
 java.util.Date[] getDateAttributeArrayValue(java.lang.String name)
          Returns the java.util.Date array attribute value from this group with the specified name
 long[] getDateAttributeArrayValueAsLong(java.lang.String name)
          Returns the java.util.Date values converted to long millisecond array attribute values from this group with the specified name
 java.util.Date getDateAttributeValue(java.lang.String name)
          Returns the java.util.Date attribute value from this group with the specified name
 long getDateAttributeValueAsLong(java.lang.String name)
          Returns the java.util.Date as a long millisecond attribute value from this group with the specified name
 double[] getDoubleAttributeArrayValue(java.lang.String name)
          Returns the double array attribute value from this group with the specified name
 double getDoubleAttributeValue(java.lang.String name)
          Returns the double attribute value from this group with the specified name
 float[] getFloatAttributeArrayValue(java.lang.String name)
          Returns the float array attribute value from this group with the specified name
 float getFloatAttributeValue(java.lang.String name)
          Returns the float attribute value from this group with the specified name
 IGenericGroup getGroup(java.lang.String name)
          Returns the subgroup with the specified name
 java.util.Collection getGroups()
          Returns this group's attributes as a collection of IGenericGroup
 java.util.List getGroupsAsList()
          Returns this group's attributes as a list of IGenericGroup
 byte[] getHexAttributeValue(java.lang.String name)
          Returns the HexBinary byte array attribute value from this group with the specified name
 java.lang.String getHexAttributeValueAsString(java.lang.String name)
          Returns the HexBinary String attribute value from this group with the specified name
 int[] getIntAttributeArrayValue(java.lang.String name)
          Returns the int array attribute value from this group with the specified name
 int getIntAttributeValue(java.lang.String name)
          Returns the int attribute value from this group with the specified name
 long[] getLongAttributeArrayValue(java.lang.String name)
          Returns the long array attribute value from this group with the specified name
 long getLongAttributeValue(java.lang.String name)
          Returns the long attribute value from this group with the specified name
 java.lang.String getName()
          Returns the group's name
 short[] getShortAttributeArrayValue(java.lang.String name)
          Returns the short array attribute value from this group with the specified name
 short getShortAttributeValue(java.lang.String name)
          Returns the short attribute value from this group with the specified name
 java.lang.String[] getStringAttributeArrayValue(java.lang.String name)
          Returns the String array attribute value from this group with the specified name
 java.lang.String getStringAttributeValue(java.lang.String name)
          Returns the String attribute value from this group with the specified name
 void removeAttributes()
          Removes all attributes from this group
 void removeGroups()
          Removes all subgroups from this group
 void setAttributes(java.util.Collection attributes)
          Sets this group's collection of attributes
 void setGroups(java.util.Collection groups)
          Sets this group's collection of subgroups
 void setName(java.lang.String name)
          Sets the name of this group
 IGenericGroup traverseGroupPath(java.util.List path)
          Returns the last nested subgroup specified in path.
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Returns the group's name


setName

void setName(java.lang.String name)
             throws SensorEventException
Sets the name of this group

Throws:
SensorEventException

addAttributeArray

void addAttributeArray(java.lang.String name,
                       java.lang.Object[] value,
                       int type)
                       throws SensorEventException
Throws:
SensorEventException

addAttribute

void addAttribute(IGenericAttribute attribute)
                  throws SensorEventException
Adds an attribute to this group's collection of attributes. Attributes are indexed by the attribute's name. Duplicate attribute names are overwritten.

Throws:
SensorEventException

addBooleanAttribute

void addBooleanAttribute(java.lang.String name,
                         boolean value)
                         throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and boolean value.

Throws:
SensorEventException

addByteAttribute

void addByteAttribute(java.lang.String name,
                      byte b)
                      throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and byte value.

Throws:
SensorEventException

addDateAttribute

void addDateAttribute(java.lang.String name,
                      java.util.Date d)
                      throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and java.util.Date value.

Throws:
SensorEventException

addDateAttributeAsLong

void addDateAttributeAsLong(java.lang.String name,
                            long l)
                            throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and long millisecond value as a java.util.Date.

Throws:
SensorEventException

addDoubleAttribute

void addDoubleAttribute(java.lang.String name,
                        double d)
                        throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and double value.

Throws:
SensorEventException

addFloatAttribute

void addFloatAttribute(java.lang.String name,
                       float f)
                       throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and float value.

Throws:
SensorEventException

addHexAttribute

void addHexAttribute(java.lang.String name,
                     byte[] b)
                     throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and byte array value. The byte array is converted to a HexBinary string.

Throws:
SensorEventException

addHexAttribute

void addHexAttribute(java.lang.String name,
                     java.lang.String s)
                     throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and HexBinary string value.

Throws:
SensorEventException
See Also:
HexBinary

addIntAttribute

void addIntAttribute(java.lang.String name,
                     int i)
                     throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and int value.

Throws:
SensorEventException

addLongAttribute

void addLongAttribute(java.lang.String name,
                      long l)
                      throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and long value.

Throws:
SensorEventException

addShortAttribute

void addShortAttribute(java.lang.String name,
                       short s)
                       throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and short value.

Throws:
SensorEventException

addStringAttribute

void addStringAttribute(java.lang.String name,
                        java.lang.String s)
                        throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and String value.

Throws:
SensorEventException

addBooleanArrayAttribute

void addBooleanArrayAttribute(java.lang.String name,
                              boolean[] value)
                              throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and boolean array values.

Throws:
SensorEventException

addByteArrayAttribute

void addByteArrayAttribute(java.lang.String name,
                           byte[] b)
                           throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and byte array values.

Throws:
SensorEventException

addDateArrayAttribute

void addDateArrayAttribute(java.lang.String name,
                           java.util.Date[] d)
                           throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and java.util.Date array values.

Throws:
SensorEventException

addDateArrayAttributeAsLong

void addDateArrayAttributeAsLong(java.lang.String name,
                                 long[] l)
                                 throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and long array values converted to java.util.Date values.

Throws:
SensorEventException

addDoubleArrayAttribute

void addDoubleArrayAttribute(java.lang.String name,
                             double[] d)
                             throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and double array values.

Throws:
SensorEventException

addFloatArrayAttribute

void addFloatArrayAttribute(java.lang.String name,
                            float[] f)
                            throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and float array values.

Throws:
SensorEventException

addIntArrayAttribute

void addIntArrayAttribute(java.lang.String name,
                          int[] i)
                          throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and int array values.

Throws:
SensorEventException

addLongArrayAttribute

void addLongArrayAttribute(java.lang.String name,
                           long[] l)
                           throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and long array values.

Throws:
SensorEventException

addShortArrayAttribute

void addShortArrayAttribute(java.lang.String name,
                            short[] s)
                            throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and short array values.

Throws:
SensorEventException

addStringArrayAttribute

void addStringArrayAttribute(java.lang.String name,
                             java.lang.String[] s)
                             throws SensorEventException
Adds an attribute to this group's collection of attributes. The attribute is created using the specified name and String array values.

Throws:
SensorEventException

getAttribute

IGenericAttribute getAttribute(java.lang.String name)
                               throws SensorEventException
Returns the attribute from this group with the specified name

Throws:
SensorEventException

getBooleanAttributeValue

boolean getBooleanAttributeValue(java.lang.String name)
                                 throws SensorEventException
Returns the boolean attribute value from this group with the specified name

Throws:
SensorEventException

getByteAttributeValue

byte getByteAttributeValue(java.lang.String name)
                           throws SensorEventException
Returns the byte attribute value from this group with the specified name

Throws:
SensorEventException

getDateAttributeValue

java.util.Date getDateAttributeValue(java.lang.String name)
                                     throws SensorEventException
Returns the java.util.Date attribute value from this group with the specified name

Throws:
SensorEventException

getDateAttributeValueAsLong

long getDateAttributeValueAsLong(java.lang.String name)
                                 throws SensorEventException
Returns the java.util.Date as a long millisecond attribute value from this group with the specified name

Throws:
SensorEventException

getDoubleAttributeValue

double getDoubleAttributeValue(java.lang.String name)
                               throws SensorEventException
Returns the double attribute value from this group with the specified name

Throws:
SensorEventException

getFloatAttributeValue

float getFloatAttributeValue(java.lang.String name)
                             throws SensorEventException
Returns the float attribute value from this group with the specified name

Throws:
SensorEventException

getHexAttributeValue

byte[] getHexAttributeValue(java.lang.String name)
                            throws SensorEventException
Returns the HexBinary byte array attribute value from this group with the specified name

Throws:
SensorEventException
See Also:
HexBinary

getHexAttributeValueAsString

java.lang.String getHexAttributeValueAsString(java.lang.String name)
                                              throws SensorEventException
Returns the HexBinary String attribute value from this group with the specified name

Throws:
SensorEventException
See Also:
HexBinary

getIntAttributeValue

int getIntAttributeValue(java.lang.String name)
                         throws SensorEventException
Returns the int attribute value from this group with the specified name

Throws:
SensorEventException

getLongAttributeValue

long getLongAttributeValue(java.lang.String name)
                           throws SensorEventException
Returns the long attribute value from this group with the specified name

Throws:
SensorEventException

getShortAttributeValue

short getShortAttributeValue(java.lang.String name)
                             throws SensorEventException
Returns the short attribute value from this group with the specified name

Throws:
SensorEventException

getStringAttributeValue

java.lang.String getStringAttributeValue(java.lang.String name)
                                         throws SensorEventException
Returns the String attribute value from this group with the specified name

Throws:
SensorEventException

getBooleanAttributeArrayValue

boolean[] getBooleanAttributeArrayValue(java.lang.String name)
                                        throws SensorEventException
Returns the boolean array attribute value from this group with the specified name

Throws:
SensorEventException

getByteAttributeArrayValue

byte[] getByteAttributeArrayValue(java.lang.String name)
                                  throws SensorEventException
Returns the byte array attribute value from this group with the specified name

Throws:
SensorEventException

getDateAttributeArrayValue

java.util.Date[] getDateAttributeArrayValue(java.lang.String name)
                                            throws SensorEventException
Returns the java.util.Date array attribute value from this group with the specified name

Throws:
SensorEventException

getDateAttributeArrayValueAsLong

long[] getDateAttributeArrayValueAsLong(java.lang.String name)
                                        throws SensorEventException
Returns the java.util.Date values converted to long millisecond array attribute values from this group with the specified name

Throws:
SensorEventException

getDoubleAttributeArrayValue

double[] getDoubleAttributeArrayValue(java.lang.String name)
                                      throws SensorEventException
Returns the double array attribute value from this group with the specified name

Throws:
SensorEventException

getFloatAttributeArrayValue

float[] getFloatAttributeArrayValue(java.lang.String name)
                                    throws SensorEventException
Returns the float array attribute value from this group with the specified name

Throws:
SensorEventException

getIntAttributeArrayValue

int[] getIntAttributeArrayValue(java.lang.String name)
                                throws SensorEventException
Returns the int array attribute value from this group with the specified name

Throws:
SensorEventException

getLongAttributeArrayValue

long[] getLongAttributeArrayValue(java.lang.String name)
                                  throws SensorEventException
Returns the long array attribute value from this group with the specified name

Throws:
SensorEventException

getShortAttributeArrayValue

short[] getShortAttributeArrayValue(java.lang.String name)
                                    throws SensorEventException
Returns the short array attribute value from this group with the specified name

Throws:
SensorEventException

getStringAttributeArrayValue

java.lang.String[] getStringAttributeArrayValue(java.lang.String name)
                                                throws SensorEventException
Returns the String array attribute value from this group with the specified name

Throws:
SensorEventException

getAttributes

java.util.Collection getAttributes()
Returns this group's attributes as a collection of IGenericAttribute


getAttributesAsList

java.util.List getAttributesAsList()
Returns this group's attributes as a list of IGenericAttribute


setAttributes

void setAttributes(java.util.Collection attributes)
                   throws SensorEventException
Sets this group's collection of attributes

Throws:
SensorEventException

removeAttributes

void removeAttributes()
Removes all attributes from this group


addGroup

void addGroup(IGenericGroup group)
              throws SensorEventException
Adds a subgroup to this group

Throws:
SensorEventException

getGroup

IGenericGroup getGroup(java.lang.String name)
                       throws SensorEventException
Returns the subgroup with the specified name

Throws:
SensorEventException

getGroups

java.util.Collection getGroups()
Returns this group's attributes as a collection of IGenericGroup


getGroupsAsList

java.util.List getGroupsAsList()
Returns this group's attributes as a list of IGenericGroup


setGroups

void setGroups(java.util.Collection groups)
               throws SensorEventException
Sets this group's collection of subgroups

Throws:
SensorEventException

removeGroups

void removeGroups()
Removes all subgroups from this group


createGroupPath

void createGroupPath(java.util.List path)
                     throws SensorEventException
Constructs the nested subgroups using the names specified in path. If path contains strings "A", "B", "C", this group will have subgroup A which contains subgroup B which contains subgroup C.

Throws:
SensorEventException

traverseGroupPath

IGenericGroup traverseGroupPath(java.util.List path)
                                throws SensorEventException
Returns the last nested subgroup specified in path. If this group contains subgroup A which contains subgroup B which contains subgroup C, a path containing strings "A", "B", "C" returns group C.

Throws:
SensorEventException


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