Protégé-OWL 3.3.1

edu.stanford.smi.protegex.owl.model
Interface TaskProgressDisplay

All Known Implementing Classes:
NoopProgressDisplay, ProgressDisplayDialog

public interface TaskProgressDisplay

User: matthewhorridge
The University Of Manchester
Medical Informatics Group
Date: Sep 11, 2005

matthew.horridge@cs.man.ac.uk
www.cs.man.ac.uk/~horridgm


Method Summary
 void end(Task task)
          Stops (hides) the progress display.
 void run(Task task)
          Runs the task and starts the display of progress to the user.
 void setMessage(Task task, String message)
          Sets the message that will be displayed to the user.
 void setProgress(Task task, int progress)
          Updates the value of the progress that is displayed to the user.
 void setProgressIndeterminate(Task task, boolean b)
          Sets the progress display to indicate that the progress cannot be determined, but the task is proceding as normal.
 

Method Detail

run

void run(Task task)
         throws Exception
Runs the task and starts the display of progress to the user.

Parameters:
task - The Task that will be run and whose progress will be monitored and displayed.
Throws:
Exception

setProgress

void setProgress(Task task,
                 int progress)
Updates the value of the progress that is displayed to the user.

Parameters:
task - The task which the progress relates to
progress - The progress that will be between the min and max progress for the Task

setProgressIndeterminate

void setProgressIndeterminate(Task task,
                              boolean b)
Sets the progress display to indicate that the progress cannot be determined, but the task is proceding as normal.

Parameters:
b - true if the progress is indeterminate, or false if the progress is not indeterminate.

setMessage

void setMessage(Task task,
                String message)
Sets the message that will be displayed to the user.


end

void end(Task task)
Stops (hides) the progress display. This methods is generally called when the task is complete.


Protégé-OWL 3.3.1

Submit a bug report or feature request
Copyright (c) 1998-2007 Stanford University.