Package uk.ac.ebi.utils.runcontrol

Class PercentProgressLogger

java.lang.Object

uk.ac.ebi.utils.runcontrol.ProgressLogger

uk.ac.ebi.utils.runcontrol.PercentProgressLogger

public class PercentProgressLogger
extends ProgressLogger

It's like ProgressLogger but reports percentages, given a max value that you set initially.

Note that the prog report action receives the progress percentages, not the absolute values.

Instead, ProgressLogger.update(long) and its variants receives an absolute increment, as this is to be used with the progressResolution property.

ProgressLogger.getProgress() reports the absolute progress too, while getPercentProgress() is provided as a shortcut to the percent progress.

Author:

brandizi

Date:

22 May 2019

Constructor Summary

Constructors

Constructor	Description
PercentProgressLogger(long maxProgress)
PercentProgressLogger(String logMessageTemplate, long maxProgress)
PercentProgressLogger(String logMessageTemplate, long maxProgress, long progressResolutionPercent)

Method Summary

Modifier and Type	Method	Description
long	getMaxProgress()	Every progress is reported in integer percentage points calculated with respect to this max value.
double	getPercentProgress()	Uses the absolute progress and getMaxProgress() to report the 0-100 progress
protected void	progressReport(long oldProgress, long newProgress)	Invoked by ProgressLogger.update(long), decides if we have to log the new progress and possibly does it.
void	setMaxProgress(long maxProgress)

Methods inherited from class uk.ac.ebi.utils.runcontrol.ProgressLogger

appendProgressReportAction, getLoggingLevel, getLogMessageTemplate, getProgress, getProgressReportAction, getProgressResolution, reset, setIsThreadSafe, setLoggingLevel, setLogMessageTemplate, setProgressReportAction, setProgressResolution, update, updateWithIncrement, updateWithIncrement

Methods inherited from class java.lang.Object

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

Constructor Details

PercentProgressLogger

public PercentProgressLogger(String logMessageTemplate,
 long maxProgress,
 long progressResolutionPercent)

PercentProgressLogger

public PercentProgressLogger(String logMessageTemplate,
 long maxProgress)

PercentProgressLogger

public PercentProgressLogger(long maxProgress)

Method Details

progressReport

protected void progressReport(long oldProgress,
 long newProgress)

Description copied from class: ProgressLogger

Invoked by ProgressLogger.update(long), decides if we have to log the new progress and possibly does it. If yes, it invokes ProgressLogger.getProgressReportAction().

Overrides:

progressReport in class ProgressLogger

getMaxProgress

public long getMaxProgress()

Every progress is reported in integer percentage points calculated with respect to this max value. Methods like ProgressLogger.update(long) should keep updating with the absolute progress and then progressReport(long, long) will convert everything as needed.

setMaxProgress

public void setMaxProgress(long maxProgress)

getPercentProgress

public double getPercentProgress()

Uses the absolute progress and getMaxProgress() to report the 0-100 progress