org.soaplab.services.events
Class StepProgressEvent

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

All Implemented Interfaces:

EventConstants

public class StepProgressEvent
extends AnalysisEvent

A class representing an event that reports the numnber of total and completed steps for the underlying service/analysis/job.

Version:

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

StepProgressEvent(int totalSteps, int completedSteps)
A usual constructor, taking just the number of total and completed steps.

StepProgressEvent(java.lang.Object source, java.lang.String message, int totalSteps, int completedSteps)
The most general constructor, taking a message, number of total and completed steps, and the event source.

StepProgressEvent(java.lang.String message, int totalSteps, int completedSteps)
A constructor taking a general message and number of total and completed steps.

Method Summary

int	getCompletedSteps() Get the number of completed steps.
int	getTotalSteps() Get the number of total steps.
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

StepProgressEvent

public StepProgressEvent(java.lang.Object source,
                         java.lang.String message,
                         int totalSteps,
                         int completedSteps)

The most general constructor, taking a message, number of total and completed steps, and the event source.

StepProgressEvent

public StepProgressEvent(java.lang.String message,
                         int totalSteps,
                         int completedSteps)

A constructor taking a general message and number of total and completed steps. The event source is considered unknown.

StepProgressEvent

public StepProgressEvent(int totalSteps,
                         int completedSteps)

A usual constructor, taking just the number of total and completed steps. There will be no accompanied message, nor the event source.

Method Detail

getTotalSteps

public int getTotalSteps()

Get the number of total steps.

getCompletedSteps

public int getCompletedSteps()

Get the number of completed steps.

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