Package org.apache.jena.atlas.lib

Class ProgressMonitor

java.lang.Object

org.apache.jena.atlas.lib.ProgressMonitor

public class ProgressMonitor
extends java.lang.Object

Progress monitor - output lines to show the progress of some long running operation. This is based on "ticks", not time. Once per item processed, call the tick() operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProgressMonitor.Output

Constructor Summary

Constructors

Constructor	Description
ProgressMonitor(java.lang.String label, long tickPoint, int superTick, ProgressMonitor.Output output)

Method Summary

Modifier and Type	Method	Description
static ProgressMonitor	create(org.slf4j.Logger log, java.lang.String label, long tickPoint, int superTick)	ProgressMonitor that outputs to a Logger
long	finish()
void	finishMessage()
long	getTicks()
void	start()
void	startMessage()	Print a start message using the label
void	startMessage(java.lang.String msg)	Print a start message using a different string.
void	tick()

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressMonitor

public ProgressMonitor(java.lang.String label,
                       long tickPoint,
                       int superTick,
                       ProgressMonitor.Output output)

Parameters:

label - Label added to output strings. Usually related to the kind of things being monitored. e.g "tuples

tickPoint - Frequent of output messages

superTick - Frequent of "Elapsed" additional message

output - Function called to deal with progress messages.

Method Detail

create

public static ProgressMonitor create(org.slf4j.Logger log,
                                     java.lang.String label,
                                     long tickPoint,
                                     int superTick)

ProgressMonitor that outputs to a Logger

startMessage

public void startMessage()

Print a start message using the label

startMessage

public void startMessage(java.lang.String msg)

Print a start message using a different string.

finishMessage

public void finishMessage()

start

public void start()

finish

public long finish()

getTicks

public long getTicks()

tick

public void tick()