org.jscience.net.progress
Class ProgressMailer

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

public class ProgressMailer
extends java.lang.Object
implements ProgressListener

Informe l'utilisateur des progr�s d'une op�ration en envoyant des courriers �lectroniques � intervalles r�gulier.


Constructor Summary
ProgressMailer(javax.mail.Session session, javax.mail.Address[] address)
          Construit un objet qui informera des progr�s en envoyant des courriels.
ProgressMailer(java.lang.String host, java.lang.String address)
          Construit un objet qui informera des progr�s en envoyant des courriels.
 
Method Summary
 void complete()
          Envoie un courrier �lectronique indiquant que l'op�ration vient de se terminer.
 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.
 long getTimeInterval()
          Retourne le laps de temps minimal entre deux courriers �lectroniques informant des progr�s.
 void progress(float percent)
          Envoie un courrier �lectronique informant des progr�s de l'op�ration.
 void setDescription(java.lang.String description)
          Sp�cifie un message qui d�crit l'op�ration en cours.
 void setTimeInterval(long interval)
          Sp�cifie le laps de temps minimal entre deux courriers �lectroniques informant des progr�s.
 void started()
          Envoie un courrier �lectronique indiquant que l'op�ration vient de commencer.
 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

ProgressMailer

public ProgressMailer(java.lang.String host,
                      java.lang.String address)
               throws javax.mail.internet.AddressException
Construit un objet qui informera des progr�s en envoyant des courriels.

Parameters:
host - Nom du serveur � utiliser pour envoyer des courriels.
address - Adresse � laquelle envoyer les messages.
Throws:
javax.mail.internet.AddressException - si l'adresse sp�cifi�e n'est pas dans un format valide.

ProgressMailer

public ProgressMailer(javax.mail.Session session,
                      javax.mail.Address[] address)
Construit un objet qui informera des progr�s en envoyant des courriels.

Parameters:
session - Session � utiliser pour envoyer des courriels.
address - DOCUMENT ME!
Method Detail

getTimeInterval

public long getTimeInterval()
Retourne le laps de temps minimal entre deux courriers �lectroniques informant des progr�s. On attendra que ce laps de temps soit �coul�s avant d'envoyer un nouveau courriel.

Returns:
Intervalle de temps en millisecondes.

setTimeInterval

public void setTimeInterval(long interval)
Sp�cifie le laps de temps minimal entre deux courriers �lectroniques informant des progr�s. On attendra que ce laps de temps soit �coul�s avant d'envoyer un nouveau courriel. Par d�faut, un courriel n'est envoy� qu'une fois tous les heures.

Parameters:
interval - Intervalle de temps en millisecondes.

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()
Envoie un courrier �lectronique indiquant que l'op�ration vient de commencer.

Specified by:
started in interface ProgressListener

progress

public void progress(float percent)
Envoie un courrier �lectronique informant des progr�s de l'op�ration. Cette information ne sera pas n�cessairement prise en compte. Cette m�thode n'envoie des rapport qu'� des intervalles de temps assez espac�s (par d�faut 3 heure) afin de ne pas innonder l'utilisateur de courriels.

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

complete

public void complete()
Envoie un courrier �lectronique indiquant que l'op�ration vient de se terminer.

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. Ce message sera envoy�e par courrier �lectronique.

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.

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 envoie la trace de l'exception par courrier �lectronique.

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