org.soaplab.services.events
Class StateChangeEvent

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

All Implemented Interfaces:

EventConstants

public class StateChangeEvent
extends AnalysisEvent

A class representing an event that characterizes a change of state of the underlying service/analysis/job.

Version:

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

StateChangeEvent(java.lang.Object source, java.lang.String message, java.lang.String previousState, java.lang.String newState)
The most general constructor, taking a message, the two states, the old and new one, and an event source.

StateChangeEvent(java.lang.String previousState, java.lang.String newState)
A usual constructor, taking just two states, the old and new one.

StateChangeEvent(java.lang.String message, java.lang.String previousState, java.lang.String newState)
A constructor taking a general message and two states, the old and new one.

Method Summary

java.lang.String	getNewState() Get the new state as reported by this event.
java.lang.String	getPreviousState() Get the previous state as reported by this event.
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

StateChangeEvent

public StateChangeEvent(java.lang.Object source,
                        java.lang.String message,
                        java.lang.String previousState,
                        java.lang.String newState)

The most general constructor, taking a message, the two states, the old and new one, and an event source.

StateChangeEvent

public StateChangeEvent(java.lang.String message,
                        java.lang.String previousState,
                        java.lang.String newState)

A constructor taking a general message and two states, the old and new one. The event source is considered unknown.

StateChangeEvent

public StateChangeEvent(java.lang.String previousState,
                        java.lang.String newState)

A usual constructor, taking just two states, the old and new one. There will be no accompanied message, nor the event source.

Method Detail

getPreviousState

public java.lang.String getPreviousState()

Get the previous state as reported by this event.

getNewState

public java.lang.String getNewState()

Get the new state as reported by this event.

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