org.jscience.net.progress
Class ProgressPrinter

java.lang.Object
  extended by org.jscience.net.progress.ProgressPrinter
All Implemented Interfaces:
ProgressListener

public class ProgressPrinter
extends java.lang.Object
implements ProgressListener

Informe l'utilisateur des progr�s d'une op�ration � l'aide de messages envoy� vers un flot. L'avancement de l'op�ration sera affich� en pourcentage sur une ligne (g�n�ralement le p�riph�rique de sortie standard). Cette classe peut aussi �crire des avertissements, ce qui est utile entre autre lors de la lecture d'un fichier de donn�es durant laquelle on veut signaler des anomalies mais sans arr�ter la lecture pour autant.


Constructor Summary
ProgressPrinter()
          Construit un objet qui �crira sur le p�riph�rique de sortie standard (System.out) l'�tat d'avancement d'une op�ration.
ProgressPrinter(java.io.PrintWriter out)
          Construit un objet qui �crira sur le p�riph�rique de sortie sp�cifi� l'�tat d'avancement d'une op�ration.
ProgressPrinter(java.io.PrintWriter out, int maxLength)
          Construit un objet qui �crira sur le p�riph�rique de sortie sp�cifi� l'�tat d'avancement d'une op�ration.
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProgressPrinter

public ProgressPrinter()
Construit un objet qui �crira sur le p�riph�rique de sortie standard (System.out) l'�tat d'avancement d'une op�ration. La longueur par d�faut des lignes sera de 80 caract�res.


ProgressPrinter

public ProgressPrinter(java.io.PrintWriter out)
Construit un objet qui �crira sur le p�riph�rique de sortie sp�cifi� l'�tat d'avancement d'une op�ration. La longueur par d�faut des lignes sera de 80 caract�res.

Parameters:
out - DOCUMENT ME!

ProgressPrinter

public ProgressPrinter(java.io.PrintWriter out,
                       int maxLength)
Construit un objet qui �crira sur le p�riph�rique de sortie sp�cifi� l'�tat d'avancement d'une op�ration.

Parameters:
out - p�riph�rique de sortie � utiliser pour �crire l'�tat d'avancement.
maxLength - Longueur maximale des lignes. Cette information est utilis�e par warningOccurred(java.lang.String, java.lang.String, java.lang.String) pour r�partir sur plusieurs lignes des messages qui ferait plus que la longueur lineLength.
Method Detail

getDescription

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

Specified by:
getDescription in interface ProgressListener
Returns:
DOCUMENT ME!

setDescription

public 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.

Specified by:
setDescription in interface ProgressListener
Parameters:
description - DOCUMENT ME!

started

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

Specified by:
started in interface ProgressListener

progress

public 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.

Specified by:
progress in interface ProgressListener
Parameters:
percent - DOCUMENT ME!

complete

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

Specified by:
complete in interface ProgressListener

dispose

public void dispose()
Lib�re les ressources utilis�es par cet objet. L'impl�mentation par d�faut ne fait rien.

Specified by:
dispose in interface ProgressListener

warningOccurred

public void warningOccurred(java.lang.String source,
                            java.lang.String margin,
                            java.lang.String warning)
Envoie un message d'avertissement. La premi�re fois que cette m�thode est appell�e, le mot "AVERTISSEMENTS" sera �crit en lettres majuscules au milieu d'une bo�te. Si une source est sp�cifi�e (argument source), elle ne sera �crite qu'� la condition qu'elle n'est pas la m�me que celle du dernier avertissement. Si une note de marge est sp�cifi�e (argument margin), elle sera �crite entre parenth�ses � la gauche de l'avertissement warning.

Specified by:
warningOccurred in interface ProgressListener
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. Si ce message est plus long que la largeur de l'�cran (telle que sp�cifi�e au moment de la construction, alors il sera automatiquement distribu� sur plusieurs lignes correctements indent�es.

exceptionOccurred

public void exceptionOccurred(java.lang.Throwable exception)
Indique qu'une exception est survenue pendant le traitement de l'op�ration. L'impl�mentation par d�faut �crit "Exception" dans une bo�te, puis envoie la trace vers le p�riph�rique de sortie sp�cifi�e au constructeur.

Specified by:
exceptionOccurred in interface ProgressListener
Parameters:
exception - DOCUMENT ME!