|
|||||||||||
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.Header
public class Header
Header represents one of the three main groups within an
IBMSensorEvent
.
Each header has
name
name
UUID
default priority
The source component subgroup contains
attribute
with a default value
attribute
with a default value
attribute
with a default value
attribute
with a default value
attribute
with a default value
attribute
with a default value
attribute
with a default value
The interface associated with this class is IHeader
.
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.sensorevent.model.IGroup |
---|
toTypedMap |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
protected Header() throws SensorEventException
SensorEventException
Method Detail |
---|
public static IGenericGroup getInstance() throws SensorEventException
SensorEventException
public static IGenericGroup fromMap(java.util.Map map) throws SensorEventException
map
- the Map containing the Header data
SensorEventException
public java.lang.String getAssetId() throws SensorEventException
getAssetId
in interface IHeader
SensorEventException
public void setAssetId(java.lang.String assetId) throws SensorEventException
setAssetId
in interface IHeader
SensorEventException
public long getDateTime() throws SensorEventException
getDateTime
in interface IHeader
SensorEventException
public java.lang.String getDateTimeAsString() throws SensorEventException
ISO 8601 date string
getDateTimeAsString
in interface IHeader
SensorEventException
public void setDateTime(long dateTime) throws SensorEventException
setDateTime
in interface IHeader
SensorEventException
public java.lang.String getEventId() throws SensorEventException
getEventId
in interface IHeader
SensorEventException
public void setEventId(java.lang.String eventId) throws SensorEventException
setEventId
in interface IHeader
SensorEventException
public java.lang.String getEventType() throws SensorEventException
getEventType
in interface IHeader
SensorEventException
public void setEventType(java.lang.String eventType) throws SensorEventException
setEventType
in interface IHeader
SensorEventException
public java.lang.String getGeoLocation() throws SensorEventException
getGeoLocation
in interface IHeader
SensorEventException
public void setGeoLocation(java.lang.String geoLocation) throws SensorEventException
setGeoLocation
in interface IHeader
SensorEventException
public java.lang.String getOriginatingEventId() throws SensorEventException
getOriginatingEventId
in interface IHeader
SensorEventException
public void setOriginatingEventId(java.lang.String originatingEventId) throws SensorEventException
setOriginatingEventId
in interface IHeader
SensorEventException
public short getPriority() throws SensorEventException
getPriority
in interface IHeader
SensorEventException
public void setPriority(short priority) throws SensorEventException
setPriority
in interface IHeader
SensorEventException
public java.lang.String getSourceId() throws SensorEventException
getSourceId
in interface IHeader
SensorEventException
public void setSourceId(java.lang.String targetId) throws SensorEventException
setSourceId
in interface IHeader
SensorEventException
public java.lang.String getTargetId() throws SensorEventException
getTargetId
in interface IHeader
SensorEventException
public void setTargetId(java.lang.String targetId) throws SensorEventException
setTargetId
in interface IHeader
SensorEventException
public IGroup getSourceGroup() throws SensorEventException
getSourceGroup
in interface IHeader
SensorEventException
public java.lang.String getSourceApplication() throws SensorEventException
getSourceApplication
in interface IHeader
SensorEventException
public void setSourceApplication(java.lang.String s) throws SensorEventException
setSourceApplication
in interface IHeader
SensorEventException
public java.lang.String getSourceComponent() throws SensorEventException
getSourceComponent
in interface IHeader
SensorEventException
public void setSourceComponent(java.lang.String s) throws SensorEventException
setSourceComponent
in interface IHeader
SensorEventException
public java.lang.String getSourceComponentIdType() throws SensorEventException
getSourceComponentIdType
in interface IHeader
SensorEventException
public void setSourceComponentIdType(java.lang.String s) throws SensorEventException
setSourceComponentIdType
in interface IHeader
SensorEventException
public java.lang.String getSourceComponentType() throws SensorEventException
getSourceComponentType
in interface IHeader
SensorEventException
public void setSourceComponentType(java.lang.String s) throws SensorEventException
setSourceComponentType
in interface IHeader
SensorEventException
public java.lang.String getSourceLocation() throws SensorEventException
getSourceLocation
in interface IHeader
SensorEventException
public void setSourceLocation(java.lang.String s) throws SensorEventException
setSourceLocation
in interface IHeader
SensorEventException
public java.lang.String getSourceLocationType() throws SensorEventException
getSourceLocationType
in interface IHeader
SensorEventException
public void setSourceLocationType(java.lang.String s) throws SensorEventException
setSourceLocationType
in interface IHeader
SensorEventException
public java.lang.String getSourceSubComponent() throws SensorEventException
getSourceSubComponent
in interface IHeader
SensorEventException
public void setSourceSubComponent(java.lang.String s) throws SensorEventException
setSourceSubComponent
in interface IHeader
SensorEventException
public java.util.Map toMap() throws SensorEventException
toMap
in interface IGroup
toMap
in interface IHeader
toMap
in class Group
SensorEventException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |