Version: ${maven.project.version}

org.soaplab.services.events
Class PercentProgressEvent

java.lang.Object
  extended by org.soaplab.services.events.AnalysisEvent
      extended by org.soaplab.services.events.PercentProgressEvent
All Implemented Interfaces:
EventConstants

public class PercentProgressEvent
extends AnalysisEvent

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

Version:
$Id: PercentProgressEvent.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
PercentProgressEvent(float percentage)
          A usual constructor, taking just the percentage.
PercentProgressEvent(java.lang.Object source, java.lang.String message, float percentage)
          The most general constructor, taking a message, percentage, and the event source.
PercentProgressEvent(java.lang.String message, float percentage)
          A constructor taking a general message and percentage.
 
Method Summary
 float getPercentage()
          Get the percentage.
 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

PercentProgressEvent

public PercentProgressEvent(java.lang.Object source,
                            java.lang.String message,
                            float percentage)
The most general constructor, taking a message, percentage, and the event source.


PercentProgressEvent

public PercentProgressEvent(java.lang.String message,
                            float percentage)
A constructor taking a general message and percentage. The event source is considered unknown.


PercentProgressEvent

public PercentProgressEvent(float percentage)
A usual constructor, taking just the percentage. There will be no accompanied message, nor the event source.

Method Detail

getPercentage

public float getPercentage()
Get the percentage.


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

Version: ${maven.project.version}

Submit a bug or feature
Generated: Tue Jun 14 15:18:14 AST 2011