org.ow2.clif.storage.api
Interface BladeEvent

All Superinterfaces:
java.lang.Comparable, java.io.Serializable
All Known Implementing Classes:
AbstractEvent, ActionEvent, AlarmEvent, CPUEvent, DiskEvent, JMX_JVMEvent, JVMEvent, LifeCycleEvent, MemoryEvent, NetworkEvent, ProbeEvent, RTPEvent

public interface BladeEvent
extends java.lang.Comparable, java.io.Serializable

Common/base interface for every event generated by blades

Author:
Bruno Dillenseger

Method Summary
 long getDate()
           
 java.lang.String[] getFieldLabels()
           
 java.lang.Object getFieldValue(java.lang.String fieldLabel)
           
 java.lang.String getTypeLabel()
           
 java.lang.String toString(long dateOrigin, java.lang.String separator)
           
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getTypeLabel

java.lang.String getTypeLabel()
Returns:
a label uniquely designating this class of event

getDate

long getDate()
Returns:
the date of this event

toString

java.lang.String toString(long dateOrigin,
                          java.lang.String separator)
Parameters:
dateOrigin - the origin date in milliseconds (since 1st January 1970). This value is substracted from the event date before printing, thus allowing a change of date origin.
separator - the separator string to be used to separate the event values
Returns:
a text line describing this scenario event, consisting of values separated by the given separator string. The first field shall be an integer giving the date of the event.

getFieldLabels

java.lang.String[] getFieldLabels()
Returns:
an array of labels identifying the fields (attributes) hold by this event, in the same order as they are displayed by toString(long, String).
See Also:
toString(long, String)

getFieldValue

java.lang.Object getFieldValue(java.lang.String fieldLabel)
Parameters:
fieldLabel - the label of the target field
Returns:
the value as an Object hold by the given field.