de.ipcon.tools.progress

Class AcceleratingProgressHandlerWithTotal

java.lang.Object

de.ipcon.tools.progress.ProgressHandler

de.ipcon.tools.progress.ProgressHandlerWithTotal

de.ipcon.tools.progress.AcceleratingProgressHandlerWithTotal

public class AcceleratingProgressHandlerWithTotal
extends ProgressHandlerWithTotal

A class for handling progress with an accelerating effect, where the progress appears to speed up as it nears completion.

This class extends ProgressHandlerWithTotal and provides functionality for reporting progress that accelerates based on an exponent value. The exponent determines how quickly the reported progress increases as the actual progress nears completion. An exponent greater than 1 results in slower initial reported progress and faster progress towards completion, while an exponent less than 1 has the opposite effect.

The acceleration effect can be useful for providing more intuitive progress feedback to users, especially in tasks where the time to complete each sub-task may vary significantly or to give the users the feeling of a "faster" system.

For further reading on the topic, refer to this paper: Rethinking the Progress Bar

See Also:

ProgressHandlerWithTotal

Constructor Summary

Constructors

Constructor and Description
AcceleratingProgressHandlerWithTotal(long _countTotal) Constructs a new AcceleratingProgressHandlerWithTotal with the given total count, update interval, roundTo, maximum update delay, estimation base total, exponent and defaultThingsDesc.
AcceleratingProgressHandlerWithTotal(long _countTotal, int _updateInterval)
AcceleratingProgressHandlerWithTotal(long _countTotal, int _updateInterval, int _roundTo)
AcceleratingProgressHandlerWithTotal(long _countTotal, int _updateInterval, int _roundTo, int _maxUpdateDelay)
AcceleratingProgressHandlerWithTotal(long _countTotal, int _updateInterval, int _roundTo, int _maxUpdateDelay, long _estimationBaseTotal)
AcceleratingProgressHandlerWithTotal(long _countTotal, int _updateInterval, int _roundTo, int _maxUpdateDelay, long _estimationBaseTotal, double _exponent)
AcceleratingProgressHandlerWithTotal(long _countTotal, int _updateInterval, int _roundTo, int _maxUpdateDelay, long _estimationBaseTotal, double _exponent, java.lang.String _defaultThingsDesc)
AcceleratingProgressHandlerWithTotal(long _countTotal, int _updateInterval, int _roundTo, int _maxUpdateDelay, long _estimationBaseTotal, double _exponent, java.lang.String _defaultThingsDesc, org.apache.log4j.Logger _defaultLogger)
AcceleratingProgressHandlerWithTotal(long _countTotal, int _updateInterval, int _roundTo, int _maxUpdateDelay, long _estimationBaseTotal, double _exponent, java.lang.String _defaultThingsDesc, org.apache.log4j.Logger _defaultLogger, java.lang.String _defaultLogPrefix)

Method Summary

Modifier and Type	Method and Description
double	getPercent() Returns the percentage of progress done, taking into account the accelerating effect.
double	getUnmodifiedPercent() Returns the raw percentage of progress done, without the accelerating effect applied.

Methods inherited from class de.ipcon.tools.progress.ProgressHandlerWithTotal

getCountTotal, getEstimationBaseHandled, getEstimationBaseTotal, getLogLevel, getMessage, getMessage, getMessage, getPercentDefaultFormatted, getTodoTime, setCountTotal, setEstimationBaseTotal, tick, tick

Methods inherited from class de.ipcon.tools.progress.ProgressHandler

finalResultToLog, finalResultToLog, finalResultToLog, finalResultToLog, finalResultToLog, finalResultToLog, finalResultToLog, getCountHandled, getDefaultLogger, getDefaultLogPrefix, getDefaultThingsDesc, getRunningTime, getStartedAt, isDone, printFinalResult, printFinalResult, printFinalResult, printFinalResult, printFinalResult, printProgress, printProgress, printProgress, printProgress, progressToLog, progressToLog, progressToLog, progressToLog, setCountHandled, setDefaultLogger, setDefaultLogPrefix, setDefaultThingsDesc, setLogLevel, tick, tickAndPrintProgress, tickAndPrintProgress, tickAndPrintProgress, tickAndPrintProgress, tickAndProgressToLog, tickAndProgressToLog, tickAndProgressToLog, tickAndProgressToLog

Methods inherited from class java.lang.Object

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

Constructor Detail

AcceleratingProgressHandlerWithTotal

public AcceleratingProgressHandlerWithTotal(long _countTotal)

Constructs a new AcceleratingProgressHandlerWithTotal with the given total count, update interval, roundTo, maximum update delay, estimation base total, exponent and defaultThingsDesc.

Parameters:

_countTotal - the total number of elements to be handled.

_updateInterval - interval in which progress notifications should be given, in seconds (defaults to 15).

_roundTo - progress notifications are only given if the number of handled elements is a multiple of this (defaults to 100).

_maxUpdateInterval - maximum time in seconds to wait until a progress notification is shown; if this time has passed, a notification will be given, no matter if a "_roundTo compatible value" is reached or not. This can be used to ensure notifications are shown periodically even if progress is extremely slow. If 0, this feature will be deactivated. Defaults to 20.

_estimationBaseTotal - the total number that shall be used for calculating the estimated remaining time to complete.

_exponent - the exponent to use for the accelerating effect; an exponent > 1 will result in slower reported progress at the beginning and faster reported progress at the end, while an exponent < 1 will have the opposite effect. For example, an exponent of 1.5 will reach half the progress at about 70% real progress, but the remaining half will be done very quickly, as only 30% are still to do in reality. Conversely, an exponent of 0.7 will report half progress when only about 38% is done, so the second half will take considerably longer, as 62% still need to be completed. An exponent of 1.0 will cause the real percentage to always be reported.

_defaultThingsDesc - a description of the elements being handled. Can be null.

_defaultLogger - the default logger to output messages too; will be used by the output methods that can take a logger as parameter if none is given; may be null

_defaultLogPrefix - a default prefix to prepend to log messages; will be used if no prefix argument is given to the methods which can take one; may be null

AcceleratingProgressHandlerWithTotal

public AcceleratingProgressHandlerWithTotal(long _countTotal,
                                            int _updateInterval)

AcceleratingProgressHandlerWithTotal

public AcceleratingProgressHandlerWithTotal(long _countTotal,
                                            int _updateInterval,
                                            int _roundTo)

AcceleratingProgressHandlerWithTotal

public AcceleratingProgressHandlerWithTotal(long _countTotal,
                                            int _updateInterval,
                                            int _roundTo,
                                            int _maxUpdateDelay)

AcceleratingProgressHandlerWithTotal

public AcceleratingProgressHandlerWithTotal(long _countTotal,
                                            int _updateInterval,
                                            int _roundTo,
                                            int _maxUpdateDelay,
                                            long _estimationBaseTotal)

AcceleratingProgressHandlerWithTotal

public AcceleratingProgressHandlerWithTotal(long _countTotal,
                                            int _updateInterval,
                                            int _roundTo,
                                            int _maxUpdateDelay,
                                            long _estimationBaseTotal,
                                            double _exponent)

AcceleratingProgressHandlerWithTotal

public AcceleratingProgressHandlerWithTotal(long _countTotal,
                                            int _updateInterval,
                                            int _roundTo,
                                            int _maxUpdateDelay,
                                            long _estimationBaseTotal,
                                            double _exponent,
                                            java.lang.String _defaultThingsDesc)

AcceleratingProgressHandlerWithTotal

public AcceleratingProgressHandlerWithTotal(long _countTotal,
                                            int _updateInterval,
                                            int _roundTo,
                                            int _maxUpdateDelay,
                                            long _estimationBaseTotal,
                                            double _exponent,
                                            java.lang.String _defaultThingsDesc,
                                            org.apache.log4j.Logger _defaultLogger)

AcceleratingProgressHandlerWithTotal

public AcceleratingProgressHandlerWithTotal(long _countTotal,
                                            int _updateInterval,
                                            int _roundTo,
                                            int _maxUpdateDelay,
                                            long _estimationBaseTotal,
                                            double _exponent,
                                            java.lang.String _defaultThingsDesc,
                                            org.apache.log4j.Logger _defaultLogger,
                                            java.lang.String _defaultLogPrefix)

Method Detail

getUnmodifiedPercent

public double getUnmodifiedPercent()

Returns the raw percentage of progress done, without the accelerating effect applied.

Returns:

the raw percentage of progress done

getPercent

public double getPercent()

Returns the percentage of progress done, taking into account the accelerating effect.

Overrides:

getPercent in class ProgressHandlerWithTotal

Returns:

the percentage of progress done