org.semanticweb.elk.reasoner
Interface ProgressMonitor

All Known Implementing Classes:
DummyProgressMonitor

public interface ProgressMonitor

Interface for monitoring progress in processes that can take some time to complete.

Author:
Yevgeny Kazakov

Method Summary
 void finish()
          Indicates that the process is finished.
 void report(int state, int maxState)
          Reports the current progress.
 void start(String message)
          This method should be called in the beginning of the process.
 

Method Detail

start

void start(String message)
This method should be called in the beginning of the process. It should be called only once until the method finish() is called.

Parameters:
message - the description of the process.

report

void report(int state,
            int maxState)
Reports the current progress.

Parameters:
state - the current value of the progress. Must not be larger then maxState.
maxState - the maximal (estimated) value of the progress.

finish

void finish()
Indicates that the process is finished. Should be called only if the method start(String) was called before.



Copyright © 2011-2013 Department of Computer Science, University of Oxford. All Rights Reserved.