org.soaplab.services.events
Class HeartbeatProgressEvent

java.lang.Object
  org.soaplab.services.events.AnalysisEvent
      org.soaplab.services.events.HeartbeatProgressEvent

All Implemented Interfaces:

EventConstants

public class HeartbeatProgressEvent
extends AnalysisEvent

A class representing an event that indicates that the underlying service/analysis/job is still in progress.

Version:

$Id: HeartbeatProgressEvent.java,v 1.2 2006/11/03 20:28:56 marsenger Exp $

Author:

Martin Senger

Field Summary

Fields inherited from interface org.soaplab.services.events.EventConstants

ANALYSIS_EVENT, HEARTBEAT_PROGRESS, MESSAGE, NEW_STATE, PERCENT_PROGRESS, PERCENTAGE, PREVIOUS_STATE, REMAINING, STATE_CHANGED, STEP_PROGRESS, STEPS_COMPLETED, TIME_PROGRESS, TIMESTAMP, TIMESTAMP_FORMAT, TOTAL_STEPS

Constructor Summary

HeartbeatProgressEvent()
A usual constructor, taking nothing.

HeartbeatProgressEvent(java.lang.Object source, java.lang.String message)
The most general constructor, taking a message, and the event source.

Method Summary

org.jdom.Element

toXML() Create an XML element representing this event.

Methods inherited from class org.soaplab.services.events.AnalysisEvent

formatSource, getMessage, getSource, getTimestamp, isOlderThan, setTimestamp, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HeartbeatProgressEvent

public HeartbeatProgressEvent()

A usual constructor, taking nothing. There will be no accompanied message, nor the event source.

HeartbeatProgressEvent

public HeartbeatProgressEvent(java.lang.Object source,
                              java.lang.String message)

The most general constructor, taking a message, and the event source.

Method Detail

toXML

public org.jdom.Element toXML()

Create an XML element representing this event.

Overrides:

toXML in class AnalysisEvent

Returns:

a jDom element that can be used for building the whole XML document