gr.demokritos.iit.jinsect.events
Class ProgressEvent

java.lang.Object
  gr.demokritos.iit.jinsect.events.ProgressEvent

All Implemented Interfaces:

java.io.Serializable

public class ProgressEvent
extends java.lang.Object
implements java.io.Serializable

A class describing a progress event, with a task description and a progress indicating number.

See Also:

Serialized Form

Field Summary

double	Progress A number indicative of the progress.
java.lang.String	SubtaskName The name of the subtask under progress.
java.lang.String	TaskName The name of the task under progress.

Constructor Summary

ProgressEvent(java.lang.String sTaskName, double dProgress)
Initializes a progrss evenet.

Method Summary

ProgressEvent	increaseProgress() Updates the progress of the object by an increase of one.
java.lang.String	toString()
ProgressEvent	updateProgress(double dNewProgress) Updates the progress of the object.
ProgressEvent	updateSubtask(java.lang.String sSubtaskName) Updates the current subtask of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TaskName

public java.lang.String TaskName

The name of the task under progress.

Progress

public double Progress

A number indicative of the progress.

SubtaskName

public java.lang.String SubtaskName

The name of the subtask under progress.

Constructor Detail

ProgressEvent

public ProgressEvent(java.lang.String sTaskName,
                     double dProgress)

Initializes a progrss evenet.

Parameters:

sTaskName - The name of the task under progress.

dProgress - The current progress.

Method Detail

updateProgress

public final ProgressEvent updateProgress(double dNewProgress)

Updates the progress of the object.

Parameters:

dNewProgress - The new value for the progress.

increaseProgress

public final ProgressEvent increaseProgress()

Updates the progress of the object by an increase of one.

updateSubtask

public final ProgressEvent updateSubtask(java.lang.String sSubtaskName)

Updates the current subtask of the object.

Parameters:

sSubtaskName - The name of the current subtask

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object