org.soaplab.services.events
Class TimeProgressEvent

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

All Implemented Interfaces:

EventConstants

public class TimeProgressEvent
extends AnalysisEvent

A class representing an event that reports the remaining time of the underlying service/analysis/job.

Version:

$Id: TimeProgressEvent.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

TimeProgressEvent(long timeRemaining)
A usual constructor, taking just the remaining time (in 100 nanoseconds).

TimeProgressEvent(java.lang.Object source, java.lang.String message, long timeRemaining)
The most general constructor, taking a message, remaining time (in 100 nanoseconds), and the event source.

TimeProgressEvent(java.lang.String message, long timeRemaining)
A constructor taking a general message and , remaining time (in 100 nanoseconds).

Method Summary

long	getTimeRemaining() Get the remaining time (in 100 nanoseconds).
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

TimeProgressEvent

public TimeProgressEvent(java.lang.Object source,
                         java.lang.String message,
                         long timeRemaining)

The most general constructor, taking a message, remaining time (in 100 nanoseconds), and the event source.

TimeProgressEvent

public TimeProgressEvent(java.lang.String message,
                         long timeRemaining)

A constructor taking a general message and , remaining time (in 100 nanoseconds). The event source is considered unknown.

TimeProgressEvent

public TimeProgressEvent(long timeRemaining)

A usual constructor, taking just the remaining time (in 100 nanoseconds). There will be no accompanied message, nor the event source.

Method Detail

getTimeRemaining

public long getTimeRemaining()

Get the remaining time (in 100 nanoseconds).

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