org.omg.lsae.notifications
Class AnalysisEvent

java.lang.Object
  org.omg.lsae.notifications.AnalysisEvent

Direct Known Subclasses:

HeartBeatEvent, PercentEvent, StateEvent, StepEvent, TimeProgressEvent

public abstract class AnalysisEvent
extends Object

This class represent the base LSAE Notification Event. ------------ TODO -> should this really be abstract? Spec might allow for instantiation of this class ------------

Author:

Eddie

Constructor Summary

AnalysisEvent()
Default Constructor

Method Summary

static AnalysisEvent[]	createFromXML(Object xmlData)
String	getMessage()
String	getQueryId()
String	getTimestamp()
abstract boolean	isCompleted()
void	setMessage(String msg)
void	setQueryId(String id)
void	setTimestamp(String time) TODO - is there a specific format?
abstract String	toString()
abstract String	toXMLString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AnalysisEvent

public AnalysisEvent()

Default Constructor

Method Detail

setMessage

public void setMessage(String msg)

Parameters:

msg - the event message to set

getMessage

public String getMessage()

Returns:

the event message

setQueryId

public void setQueryId(String id)

Parameters:

id - the queryId to set

getQueryId

public String getQueryId()

Returns:

the events queryId

setTimestamp

public void setTimestamp(String time)

TODO - is there a specific format?

Parameters:

time - the events timestamp

getTimestamp

public String getTimestamp()

Returns:

the events timestamp

isCompleted

public abstract boolean isCompleted()

Returns:

true if the event is completed, false otherwise.

toString

public abstract String toString()

Overrides:

toString in class Object

toXMLString

public abstract String toXMLString()

Returns:

the XML representation of this LSAE notification event object.

createFromXML

public static AnalysisEvent[] createFromXML(Object xmlData)
                                     throws MobyException

Parameters:

xmlData - the xml to parse into an AnalysisEvent object

Returns:

an array of AnalysisEvent objects

Throws:

MobyException - if there is a problem parsing the xml