org.jscience.net.progress
Interface ProgressListener

All Known Implementing Classes:
ProgressMailer, ProgressPrinter, ProgressWindow

public interface ProgressListener

Monitor the progress of some lengthly operation. This interface makes no assumption about the output device. It may be the standard output stream (see ProgressPrinter implementation), a window (ProgressWindow) or mails automatically sent to some address (ProgressMailer). Additionnaly, this interface provides support for non-fatal warning and exception reports.

All ProgressListener implementations are multi-thread safe, even the Swing implemention. ProgressListener can be invoked from any thread, which never need to be the Swing's thread. This is usefull for performing lenghtly operation in a background thread. Example:

  ProgressListener p = new ProgressPrinter();
  p.setDecription("Loading data");
  p.start();
  for (int j=0; j<1000; j++) {
      // ... some process...
      if ((j & 255) == 0)
          p.progress(j/10f);
  }
  p.complete();
 

Note: The line if ((j & 255) == 0) is used for reducing the amount of calls to progress(float) (only once every 256 steps). This is not mandatory, but may speed up the process.

See Also:
ProgressMonitor

Method Summary
 void complete()
          Indique que l'op�ration est termin�e.
 void dispose()
          Lib�re les ressources utilis�es par cet objet.
 void exceptionOccurred(java.lang.Throwable exception)
          Indique qu'une exception est survenue pendant le traitement de l'op�ration.
 java.lang.String getDescription()
          Retourne le message d'�crivant l'op�ration en cours.
 void progress(float percent)
          Indique l'�tat d'avancement de l'op�ration.
 void setDescription(java.lang.String description)
          Sp�cifie un message qui d�crit l'op�ration en cours.
 void started()
          Indique que l'op�ration a commenc�e.
 void warningOccurred(java.lang.String source, java.lang.String margin, java.lang.String warning)
          Envoie un message d'avertissement.
 

Method Detail

getDescription

java.lang.String getDescription()
Retourne le message d'�crivant l'op�ration en cours. Si aucun message n'a �t� d�finie, retourne null.

Returns:
DOCUMENT ME!

setDescription

void setDescription(java.lang.String description)
Sp�cifie un message qui d�crit l'op�ration en cours. Ce message est typiquement sp�cifi�e avant le d�but de l'op�ration. Toutefois, cette m�thode peut aussi �tre appel�e � tout moment pendant l'op�ration sans que cela affecte le pourcentage accompli. La valeur null signifie qu'on ne souhaite plus afficher de description.

Parameters:
description - DOCUMENT ME!

started

void started()
Indique que l'op�ration a commenc�e.


progress

void progress(float percent)
Indique l'�tat d'avancement de l'op�ration. Le progr�s est repr�sent� par un pourcentage variant de 0 � 100 inclusivement. Si la valeur sp�cifi�e est en dehors de ces limites, elle sera automatiquement ramen�e entre 0 et 100.

Parameters:
percent - DOCUMENT ME!

complete

void complete()
Indique que l'op�ration est termin�e. L'indicateur visuel informant des progr�s sera ramen� � 100% ou dispara�tra, selon l'impl�mentation de la classe d�riv�e. Si des messages d'erreurs ou d'avertissements �taient en attente, ils seront �crits.


dispose

void dispose()
Lib�re les ressources utilis�es par cet objet. Si l'�tat d'avancement �tait affich� dans une fen�tre, cette fen�tre peut �tre d�truite.


warningOccurred

void warningOccurred(java.lang.String source,
                     java.lang.String margin,
                     java.lang.String warning)
Envoie un message d'avertissement. Ce message pourra �tre envoy� vers le p�riph�rique d'erreur standard, appara�tre dans une fen�tre ou �tre tout simplement ignor�.

Parameters:
source - Cha�ne de caract�re d�crivant la source de l'avertissement. Il s'agira par exemple du nom du fichier dans lequel une anomalie a �t� d�tect�e. Peut �tre nul si la source n'est pas connue.
margin - Texte � placer dans la marge de l'avertissement warning, ou null s'il n'y en a pas. Il s'agira le plus souvent du num�ro de ligne o� s'est produite l'erreur dans le fichier source.
warning - Message d'avertissement � �crire.

exceptionOccurred

void exceptionOccurred(java.lang.Throwable exception)
Indique qu'une exception est survenue pendant le traitement de l'op�ration. Cette m�thode peut afficher la trace de l'exception dans une fen�tre ou � la console, d�pendemment de la classe d�riv�e.

Parameters:
exception - DOCUMENT ME!