net.sf.ij_plugins.util.progress

Class ProgressAccumulator

java.lang.Object

net.sf.ij_plugins.util.progress.DefaultProgressReporter

net.sf.ij_plugins.util.progress.ProgressAccumulator

All Implemented Interfaces:

ProgressListener, ProgressReporter

public class ProgressAccumulator
extends DefaultProgressReporter
implements ProgressListener

Utility for aggregating progress events from multiple ProgressReporter's

Author:

Jarek Sacha

Constructor Summary

Constructors

Constructor and Description
ProgressAccumulator()

Method Summary

Methods

Modifier and Type	Method and Description
void	addProgressReporter(ProgressReporter reporter) Add progress reporter with default weight of 1.
void	addProgressReporter(ProgressReporter reporter, double weight) Add progress reporter with given weight.
void	addProgressReporter(ProgressReporter reporter, double weight, java.lang.String message) Add progress reporter with given weight.
double	getMinimumChange()
void	progressNotification(ProgressEvent event) sent to this listener new progress event.
void	removeAllProgressReporter()
void	removeProgressReporter(ProgressReporter reporter)
void	setMinimumChange(double minimumChange)

Methods inherited from class net.sf.ij_plugins.util.progress.DefaultProgressReporter

addProgressListener, currentProgress, notifyProgressListeners, notifyProgressListeners, notifyProgressListeners, removeAllProgressListener, removeProgressListener, setCurrentProgress

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressAccumulator

public ProgressAccumulator()

Method Detail

getMinimumChange

public double getMinimumChange()

setMinimumChange

public void setMinimumChange(double minimumChange)

addProgressReporter

public void addProgressReporter(ProgressReporter reporter)

Add progress reporter with default weight of 1. If reporter already exists its weight will be changed to 1.

Parameters:

reporter - reporter

addProgressReporter

public void addProgressReporter(ProgressReporter reporter,
                       double weight)

Add progress reporter with given weight. If reporter already exists its weight and message will be updated.

Parameters:

reporter - reporter

weight - weight

addProgressReporter

public void addProgressReporter(ProgressReporter reporter,
                       double weight,
                       java.lang.String message)

Add progress reporter with given weight. If reporter already exists its weight and message will be updated.

Parameters:

reporter - reporter

weight - weight

message - message that will be reported when this reporter send progress event. If null the original message send by reporter will be used.

removeProgressReporter

public void removeProgressReporter(ProgressReporter reporter)

removeAllProgressReporter

public void removeAllProgressReporter()

progressNotification

public void progressNotification(ProgressEvent event)

Description copied from interface: ProgressListener

sent to this listener new progress event.

Specified by:

progressNotification in interface ProgressListener

Parameters:

event - event information.