org.lenskit.util

Class ProgressLogger

java.lang.Object

org.lenskit.util.ProgressLogger

public class ProgressLogger
extends java.lang.Object

Utility class for logging progress of some long-running process.

Method Summary

Modifier and Type	Method and Description
void	advance() Record that an item has been completed.
static ProgressLogger	create(org.slf4j.Logger log) Create a new progress logger.
java.lang.String	elapsedTime() Get a string representation of the elapsed time.
double	finish() Log that the process has finished.
static java.lang.String	formatElapsedTime(double seconds) Format elapsed time.
void	logProgress() Log the current progress to the logger.
ProgressLogger	setCount(int n) Set the number of total items to be processed.
ProgressLogger	setLabel(java.lang.String lbl) Set the label to be used in log messages.
ProgressLogger	setPeriod(int p) Set the period for progress messages.
ProgressLogger	setWindow(int w) Set the window to use for smoothing averages.
ProgressLogger	start() Start the progress logger’s timer.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ProgressLogger create(org.slf4j.Logger log)

Create a new progress logger.

Parameters:

log - The logger to which progress should be logged.

Returns:

The progress logger.

setLabel

public ProgressLogger setLabel(java.lang.String lbl)

Set the label to be used in log messages.

Parameters:

lbl - The label.

Returns:

The logger (for chaining).

setCount

public ProgressLogger setCount(int n)

Set the number of total items to be processed.

Parameters:

n - The total number of items to be processed.

Returns:

The logger (for chaining).

setPeriod

public ProgressLogger setPeriod(int p)

Set the period for progress messages.

Parameters:

p - The progress message period.

Returns:

The logger (for chaining).

setWindow

public ProgressLogger setWindow(int w)

Set the window to use for smoothing averages.

Parameters:

w - The window size, in number of periods.

Returns:

The progress logger (for chaining).

start

public ProgressLogger start()

Start the progress logger’s timer.

Returns:

The progress logger (for chaining).

advance

public void advance()

Record that an item has been completed.

logProgress

public void logProgress()

Log the current progress to the logger.

finish

public double finish()

Log that the process has finished.

Returns:

The number of seconds.

elapsedTime

public java.lang.String elapsedTime()

Get a string representation of the elapsed time.

Returns:

The elapsed string as a human-friendly string.

formatElapsedTime

public static java.lang.String formatElapsedTime(double seconds)

Format elapsed time.

Parameters:

seconds - The number of seconds that have elapsed.

Returns:

The time, formatted as a string.