com.ibm.sensorevent.model
Class Header

java.lang.Object
  extended by com.ibm.sensorevent.model.generic.GenericGroup
      extended by com.ibm.sensorevent.model.Group
          extended by com.ibm.sensorevent.model.Header
All Implemented Interfaces:
IGenericGroup, IGroup, IHeader, java.io.Serializable

public class Header
extends Group
implements IHeader

Header represents one of the three main groups within an IBMSensorEvent.

Each header has

The source component subgroup contains

The interface associated with this class is IHeader.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
 
Fields inherited from class com.ibm.sensorevent.model.generic.GenericGroup
attributes, groups, name
 
Constructor Summary
protected Header()
          Constructs a Header
 
Method Summary
static IGenericGroup fromMap(java.util.Map map)
          Factory method to create a Header from a java.util.Map
 java.lang.String getAssetId()
          Returns the header's asset ID attribute value
 long getDateTime()
          Returns the header's date-time attribute value as a long millisecond value
 java.lang.String getDateTimeAsString()
          Returns the header's date-time attribute value as an ISO 8601 date string
 java.lang.String getEventId()
          Returns the header's event ID attribute value
 java.lang.String getEventType()
          Returns the header's event type attribute value
 java.lang.String getGeoLocation()
          Returns the header's geographical location attribute value
static IGenericGroup getInstance()
          Factory method to create a Header
 java.lang.String getOriginatingEventId()
          Returns the header's originating event ID attribute value
 short getPriority()
          Returns the header's priority attribute value
 java.lang.String getSourceApplication()
          Returns the header's source application attribute value
 java.lang.String getSourceComponent()
          Returns the header's source component attribute value
 java.lang.String getSourceComponentIdType()
          Returns the header's source component ID type attribute value
 java.lang.String getSourceComponentType()
          Returns the header's source component type attribute value
 IGroup getSourceGroup()
          Returns the header's source component subgroup
 java.lang.String getSourceId()
          Returns the header's source ID attribute value
 java.lang.String getSourceLocation()
          Returns the header's source component location attribute value
 java.lang.String getSourceLocationType()
          Returns the header's source component location type attribute value
 java.lang.String getSourceSubComponent()
          Returns the header's source component subcomponent attribute value
 java.lang.String getTargetId()
          Returns the header's target ID attribute value
 void setAssetId(java.lang.String assetId)
          Sets the header's asset ID attribute value
 void setDateTime(long dateTime)
          Sets the header's date-time attribute value to the long millisecond value
 void setEventId(java.lang.String eventId)
          Sets the header's event ID attribute value
 void setEventType(java.lang.String eventType)
          Sets the header's event type attribute value
 void setGeoLocation(java.lang.String geoLocation)
          Sets the header's geographical location attribute value
 void setOriginatingEventId(java.lang.String originatingEventId)
          Sets the header's originating event ID attribute value
 void setPriority(short priority)
          Sets the header's priority attribute value
 void setSourceApplication(java.lang.String s)
          Sets the header's source application attribute value
 void setSourceComponent(java.lang.String s)
          Sets the header's source component attribute value
 void setSourceComponentIdType(java.lang.String s)
          Sets the header's source component ID type attribute value
 void setSourceComponentType(java.lang.String s)
          Sets the header's source component type attribute value
 void setSourceId(java.lang.String targetId)
          Sets the header's source ID attribute value
 void setSourceLocation(java.lang.String s)
          Sets the header's source component location attribute value
 void setSourceLocationType(java.lang.String s)
          Sets the header's source component location type attribute value
 void setSourceSubComponent(java.lang.String s)
          Sets the header's source component subcomponent attribute value
 void setTargetId(java.lang.String targetId)
          Sets the header's target ID attribute value
 java.util.Map toMap()
          Converts the header to a java.util.Map
 
Methods inherited from class com.ibm.sensorevent.model.Group
fromTypedMap, getInstance, processGroup, processMap, processTypedGroup, processTypedMap, 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
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

Header

protected Header()
          throws SensorEventException
Constructs a Header

Throws:
SensorEventException
Method Detail

getInstance

public static IGenericGroup getInstance()
                                 throws SensorEventException
Factory method to create a Header

Throws:
SensorEventException

fromMap

public static IGenericGroup fromMap(java.util.Map map)
                             throws SensorEventException
Factory method to create a Header from a java.util.Map

Parameters:
map - the Map containing the Header data
Throws:
SensorEventException

getAssetId

public java.lang.String getAssetId()
                            throws SensorEventException
Returns the header's asset ID attribute value

Specified by:
getAssetId in interface IHeader
Throws:
SensorEventException

setAssetId

public void setAssetId(java.lang.String assetId)
                throws SensorEventException
Sets the header's asset ID attribute value

Specified by:
setAssetId in interface IHeader
Throws:
SensorEventException

getDateTime

public long getDateTime()
                 throws SensorEventException
Returns the header's date-time attribute value as a long millisecond value

Specified by:
getDateTime in interface IHeader
Throws:
SensorEventException

getDateTimeAsString

public java.lang.String getDateTimeAsString()
                                     throws SensorEventException
Returns the header's date-time attribute value as an ISO 8601 date string

Specified by:
getDateTimeAsString in interface IHeader
Throws:
SensorEventException

setDateTime

public void setDateTime(long dateTime)
                 throws SensorEventException
Sets the header's date-time attribute value to the long millisecond value

Specified by:
setDateTime in interface IHeader
Throws:
SensorEventException

getEventId

public java.lang.String getEventId()
                            throws SensorEventException
Returns the header's event ID attribute value

Specified by:
getEventId in interface IHeader
Throws:
SensorEventException

setEventId

public void setEventId(java.lang.String eventId)
                throws SensorEventException
Sets the header's event ID attribute value

Specified by:
setEventId in interface IHeader
Throws:
SensorEventException

getEventType

public java.lang.String getEventType()
                              throws SensorEventException
Returns the header's event type attribute value

Specified by:
getEventType in interface IHeader
Throws:
SensorEventException

setEventType

public void setEventType(java.lang.String eventType)
                  throws SensorEventException
Sets the header's event type attribute value

Specified by:
setEventType in interface IHeader
Throws:
SensorEventException

getGeoLocation

public java.lang.String getGeoLocation()
                                throws SensorEventException
Returns the header's geographical location attribute value

Specified by:
getGeoLocation in interface IHeader
Throws:
SensorEventException

setGeoLocation

public void setGeoLocation(java.lang.String geoLocation)
                    throws SensorEventException
Sets the header's geographical location attribute value

Specified by:
setGeoLocation in interface IHeader
Throws:
SensorEventException

getOriginatingEventId

public java.lang.String getOriginatingEventId()
                                       throws SensorEventException
Returns the header's originating event ID attribute value

Specified by:
getOriginatingEventId in interface IHeader
Throws:
SensorEventException

setOriginatingEventId

public void setOriginatingEventId(java.lang.String originatingEventId)
                           throws SensorEventException
Sets the header's originating event ID attribute value

Specified by:
setOriginatingEventId in interface IHeader
Throws:
SensorEventException

getPriority

public short getPriority()
                  throws SensorEventException
Returns the header's priority attribute value

Specified by:
getPriority in interface IHeader
Throws:
SensorEventException

setPriority

public void setPriority(short priority)
                 throws SensorEventException
Sets the header's priority attribute value

Specified by:
setPriority in interface IHeader
Throws:
SensorEventException

getSourceId

public java.lang.String getSourceId()
                             throws SensorEventException
Returns the header's source ID attribute value

Specified by:
getSourceId in interface IHeader
Throws:
SensorEventException

setSourceId

public void setSourceId(java.lang.String targetId)
                 throws SensorEventException
Sets the header's source ID attribute value

Specified by:
setSourceId in interface IHeader
Throws:
SensorEventException

getTargetId

public java.lang.String getTargetId()
                             throws SensorEventException
Returns the header's target ID attribute value

Specified by:
getTargetId in interface IHeader
Throws:
SensorEventException

setTargetId

public void setTargetId(java.lang.String targetId)
                 throws SensorEventException
Sets the header's target ID attribute value

Specified by:
setTargetId in interface IHeader
Throws:
SensorEventException

getSourceGroup

public IGroup getSourceGroup()
                      throws SensorEventException
Returns the header's source component subgroup

Specified by:
getSourceGroup in interface IHeader
Throws:
SensorEventException

getSourceApplication

public java.lang.String getSourceApplication()
                                      throws SensorEventException
Returns the header's source application attribute value

Specified by:
getSourceApplication in interface IHeader
Throws:
SensorEventException

setSourceApplication

public void setSourceApplication(java.lang.String s)
                          throws SensorEventException
Sets the header's source application attribute value

Specified by:
setSourceApplication in interface IHeader
Throws:
SensorEventException

getSourceComponent

public java.lang.String getSourceComponent()
                                    throws SensorEventException
Returns the header's source component attribute value

Specified by:
getSourceComponent in interface IHeader
Throws:
SensorEventException

setSourceComponent

public void setSourceComponent(java.lang.String s)
                        throws SensorEventException
Sets the header's source component attribute value

Specified by:
setSourceComponent in interface IHeader
Throws:
SensorEventException

getSourceComponentIdType

public java.lang.String getSourceComponentIdType()
                                          throws SensorEventException
Returns the header's source component ID type attribute value

Specified by:
getSourceComponentIdType in interface IHeader
Throws:
SensorEventException

setSourceComponentIdType

public void setSourceComponentIdType(java.lang.String s)
                              throws SensorEventException
Sets the header's source component ID type attribute value

Specified by:
setSourceComponentIdType in interface IHeader
Throws:
SensorEventException

getSourceComponentType

public java.lang.String getSourceComponentType()
                                        throws SensorEventException
Returns the header's source component type attribute value

Specified by:
getSourceComponentType in interface IHeader
Throws:
SensorEventException

setSourceComponentType

public void setSourceComponentType(java.lang.String s)
                            throws SensorEventException
Sets the header's source component type attribute value

Specified by:
setSourceComponentType in interface IHeader
Throws:
SensorEventException

getSourceLocation

public java.lang.String getSourceLocation()
                                   throws SensorEventException
Returns the header's source component location attribute value

Specified by:
getSourceLocation in interface IHeader
Throws:
SensorEventException

setSourceLocation

public void setSourceLocation(java.lang.String s)
                       throws SensorEventException
Sets the header's source component location attribute value

Specified by:
setSourceLocation in interface IHeader
Throws:
SensorEventException

getSourceLocationType

public java.lang.String getSourceLocationType()
                                       throws SensorEventException
Returns the header's source component location type attribute value

Specified by:
getSourceLocationType in interface IHeader
Throws:
SensorEventException

setSourceLocationType

public void setSourceLocationType(java.lang.String s)
                           throws SensorEventException
Sets the header's source component location type attribute value

Specified by:
setSourceLocationType in interface IHeader
Throws:
SensorEventException

getSourceSubComponent

public java.lang.String getSourceSubComponent()
                                       throws SensorEventException
Returns the header's source component subcomponent attribute value

Specified by:
getSourceSubComponent in interface IHeader
Throws:
SensorEventException

setSourceSubComponent

public void setSourceSubComponent(java.lang.String s)
                           throws SensorEventException
Sets the header's source component subcomponent attribute value

Specified by:
setSourceSubComponent in interface IHeader
Throws:
SensorEventException

toMap

public java.util.Map toMap()
                    throws SensorEventException
Converts the header to a java.util.Map

Specified by:
toMap in interface IGroup
Specified by:
toMap in interface IHeader
Overrides:
toMap in class Group
Throws:
SensorEventException


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