com.ibm.sensorevent.model.birt
Class IBMSensorEventBirtParser

java.lang.Object
  extended by com.ibm.sensorevent.model.birt.IBMSensorEventBirtParser
All Implemented Interfaces:
java.io.Serializable

public class IBMSensorEventBirtParser
extends java.lang.Object
implements java.io.Serializable

IBMSensorEventBirtParser retrieves data from an ISensorEvent during processing of a BIRT report.

See Also:
Serialized Form

Field Summary
protected  XMLConverter converter
          The XMLConverter instance to use to convert XML strings to/from ISensorEvents
static java.lang.String COPYRIGHT
           
protected  ISensorEvent event
          The ISensorEvent to process
protected  java.lang.String xml
          The event XML string to process
 
Constructor Summary
protected IBMSensorEventBirtParser()
          Construct an IBMSensorEventBirtParser
protected IBMSensorEventBirtParser(java.lang.String xml)
          Construct an IBMSensorEventBirtParser to process the specified XML string
 
Method Summary
 ISensorEvent getEvent()
          Returns the ISensorEvent
static IBMSensorEventBirtParser getInstance(java.lang.String xml)
          Factory method to create an IBMSensorEventBirtParser instance for the specified XML string
 java.lang.String getPayloadMetaData()
          Returns a String representing the payload metadata
 java.lang.String getTagAntenna(java.lang.String tagId)
          Returns the 'antenna' value from the current event for the specified tag ID
 java.lang.String getTagAntennaByIndex(java.lang.String index)
          Returns the 'antenna' value from the current event for the specified tag index
 java.lang.String getTagCount(java.lang.String tagId)
          Returns the 'count' value from the current event for the specified tag ID
 java.lang.String getTagCountByIndex(java.lang.String index)
          Returns the 'count' value from the current event for the specified tag index
 java.lang.String getTagDiscovered(java.lang.String tagId)
          Returns the 'discovered' value from the current event for the specified tag ID
 java.lang.String getTagDiscoveredByIndex(java.lang.String index)
          Returns the 'discovered' value from the current event for the specified tag index
 java.lang.String[] getTagIDs()
          Returns a String array of the tag IDs in the current event
 java.lang.String getTagIdUri(java.lang.String tagId)
          Returns the 'ID URI' value from the current event for the specified tag ID
 java.lang.String getTagIdUriByIndex(java.lang.String index)
          Returns the 'ID URI' value from the current event for the specified tag index
 java.lang.String getTagRawUri(java.lang.String tagId)
          Returns the 'raw URI' value from the current event for the specified tag ID
 java.lang.String getTagRawUriByIndex(java.lang.String index)
          Returns the 'raw URI' value from the current event for the specified tag index
 java.lang.String[] getTagRead(java.lang.String tagId)
          Returns a String array containing the tag read data for the specified tag ID
 java.lang.String getTagReader(java.lang.String tagId)
          Returns the 'reader' value from the current event for the specified tag ID
 java.lang.String getTagReaderByIndex(java.lang.String index)
          Returns the 'reader' value from the current event for the specified tag index
 java.lang.String[][] getTagReads()
          Returns a 2-D String array of all tag read data from the current event; the first dimension is the tag ID; the second dimension is the tag read data for the tag ID
 java.lang.String getTagTagUri(java.lang.String tagId)
          Returns the 'tag URI' value from the current event for the specified tag ID
 java.lang.String getTagTagUriByIndex(java.lang.String index)
          Returns the 'tag URI' value from the current event for the specified tag index
 java.lang.String getTagUserData(java.lang.String tagId)
          Returns the 'tag user data' value from the current event for the specified tag ID
 java.lang.String getTagUserDataByIndex(java.lang.String index)
          Returns the 'tag user data' value from the current event for the specified tag index
 java.lang.String getXML()
          Returns the XML string
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COPYRIGHT

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

xml

protected java.lang.String xml
The event XML string to process


event

protected ISensorEvent event
The ISensorEvent to process


converter

protected XMLConverter converter
The XMLConverter instance to use to convert XML strings to/from ISensorEvents

Constructor Detail

IBMSensorEventBirtParser

protected IBMSensorEventBirtParser()
Construct an IBMSensorEventBirtParser


IBMSensorEventBirtParser

protected IBMSensorEventBirtParser(java.lang.String xml)
                            throws SensorEventException
Construct an IBMSensorEventBirtParser to process the specified XML string

Parameters:
xml - - the XML string to process
Throws:
SensorEventException
Method Detail

getInstance

public static IBMSensorEventBirtParser getInstance(java.lang.String xml)
                                            throws SensorEventException
Factory method to create an IBMSensorEventBirtParser instance for the specified XML string

Parameters:
xml - - the XML string to process
Throws:
SensorEventException

getXML

public java.lang.String getXML()
Returns the XML string


getEvent

public ISensorEvent getEvent()
                      throws SensorEventException
Returns the ISensorEvent

Throws:
SensorEventException

getTagIDs

public java.lang.String[] getTagIDs()
                             throws SensorEventException
Returns a String array of the tag IDs in the current event

Throws:
SensorEventException

getPayloadMetaData

public java.lang.String getPayloadMetaData()
                                    throws SensorEventException
Returns a String representing the payload metadata

Throws:
SensorEventException

getTagReads

public java.lang.String[][] getTagReads()
                                 throws SensorEventException
Returns a 2-D String array of all tag read data from the current event; the first dimension is the tag ID; the second dimension is the tag read data for the tag ID

Throws:
SensorEventException

getTagRead

public java.lang.String[] getTagRead(java.lang.String tagId)
                              throws SensorEventException
Returns a String array containing the tag read data for the specified tag ID

Parameters:
tagId - - the tag ID to process
Throws:
SensorEventException

getTagDiscovered

public java.lang.String getTagDiscovered(java.lang.String tagId)
                                  throws SensorEventException
Returns the 'discovered' value from the current event for the specified tag ID

Parameters:
tagId - - the tag ID to process
Throws:
SensorEventException

getTagDiscoveredByIndex

public java.lang.String getTagDiscoveredByIndex(java.lang.String index)
                                         throws SensorEventException
Returns the 'discovered' value from the current event for the specified tag index

Parameters:
index - - the tag index to process
Throws:
SensorEventException

getTagReader

public java.lang.String getTagReader(java.lang.String tagId)
                              throws SensorEventException
Returns the 'reader' value from the current event for the specified tag ID

Parameters:
tagId - - the tag ID to process
Throws:
SensorEventException

getTagReaderByIndex

public java.lang.String getTagReaderByIndex(java.lang.String index)
                                     throws SensorEventException
Returns the 'reader' value from the current event for the specified tag index

Parameters:
index - - the tag index to process
Throws:
SensorEventException

getTagUserData

public java.lang.String getTagUserData(java.lang.String tagId)
                                throws SensorEventException
Returns the 'tag user data' value from the current event for the specified tag ID

Parameters:
tagId - - the tag ID to process
Throws:
SensorEventException

getTagUserDataByIndex

public java.lang.String getTagUserDataByIndex(java.lang.String index)
                                       throws SensorEventException
Returns the 'tag user data' value from the current event for the specified tag index

Parameters:
index - - the tag index to process
Throws:
SensorEventException

getTagCount

public java.lang.String getTagCount(java.lang.String tagId)
                             throws SensorEventException
Returns the 'count' value from the current event for the specified tag ID

Parameters:
tagId - - the tag ID to process
Throws:
SensorEventException

getTagCountByIndex

public java.lang.String getTagCountByIndex(java.lang.String index)
                                    throws SensorEventException
Returns the 'count' value from the current event for the specified tag index

Parameters:
index - - the tag index to process
Throws:
SensorEventException

getTagIdUri

public java.lang.String getTagIdUri(java.lang.String tagId)
                             throws SensorEventException
Returns the 'ID URI' value from the current event for the specified tag ID

Parameters:
tagId - - the tag ID to process
Throws:
SensorEventException

getTagIdUriByIndex

public java.lang.String getTagIdUriByIndex(java.lang.String index)
                                    throws SensorEventException
Returns the 'ID URI' value from the current event for the specified tag index

Parameters:
index - - the tag index to process
Throws:
SensorEventException

getTagTagUri

public java.lang.String getTagTagUri(java.lang.String tagId)
                              throws SensorEventException
Returns the 'tag URI' value from the current event for the specified tag ID

Parameters:
tagId - - the tag ID to process
Throws:
SensorEventException

getTagTagUriByIndex

public java.lang.String getTagTagUriByIndex(java.lang.String index)
                                     throws SensorEventException
Returns the 'tag URI' value from the current event for the specified tag index

Parameters:
index - - the tag index to process
Throws:
SensorEventException

getTagRawUri

public java.lang.String getTagRawUri(java.lang.String tagId)
                              throws SensorEventException
Returns the 'raw URI' value from the current event for the specified tag ID

Parameters:
tagId - - the tag ID to process
Throws:
SensorEventException

getTagRawUriByIndex

public java.lang.String getTagRawUriByIndex(java.lang.String index)
                                     throws SensorEventException
Returns the 'raw URI' value from the current event for the specified tag index

Parameters:
index - - the tag index to process
Throws:
SensorEventException

getTagAntenna

public java.lang.String getTagAntenna(java.lang.String tagId)
                               throws SensorEventException
Returns the 'antenna' value from the current event for the specified tag ID

Parameters:
tagId - - the tag ID to process
Throws:
SensorEventException

getTagAntennaByIndex

public java.lang.String getTagAntennaByIndex(java.lang.String index)
                                      throws SensorEventException
Returns the 'antenna' value from the current event for the specified tag index

Parameters:
index - - the tag index to process
Throws:
SensorEventException


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