Module org.apache.jena.arq

Package org.apache.jena.system.progress

Class ProgressMonitorOutput

java.lang.Object

org.apache.jena.system.progress.ProgressMonitorOutput

All Implemented Interfaces:

ProgressMonitor

public class ProgressMonitorOutput
extends Object
implements ProgressMonitor

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.

Constructor Summary

Constructors

Constructor	Description
ProgressMonitorOutput(String label, long tickPoint, int superTick, MonitorOutput output)

Method Summary

Modifier and Type	Method	Description
static ProgressMonitorOutput	create(MonitorOutput output, String label, long tickPoint, int superTick)	ProgressMonitor that outputs to on a MonitorOutput
static ProgressMonitorOutput	create(org.slf4j.Logger log, String label, long tickPoint, int superTick)	ProgressMonitor that outputs to a Logger
void	finish()	Finish and stop timing.
void	finishMessage(String msg)	Output the finishing message.
void	finishSection()	Finish a section within the overall start-finish.
String	getLabel()
long	getSectionTicks()	Return the number of ticks.
long	getSectionTime()	Return the elapsed section time taken.
long	getTicks()	Return the number of ticks.
long	getTime()	Return the elapsed time taken - this is only valid after ProgressMonitor.finish() has been called.
void	setLabel(String label)
void	start()	Start and start timing.
void	startMessage(String msg)	Print a start message using a different string.
void	startSection()	Start a section within the overall start-finish.
void	tick()	Something happened

Methods inherited from class java.lang.Object

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

Constructor Details

ProgressMonitorOutput

public ProgressMonitorOutput(String label,
 long tickPoint,
 int superTick,
 MonitorOutput 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 Details

create

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

ProgressMonitor that outputs to a Logger

create

public static ProgressMonitorOutput create(MonitorOutput output,
 String label,
 long tickPoint,
 int superTick)

ProgressMonitor that outputs to on a MonitorOutput

startMessage

public void startMessage(String msg)

Print a start message using a different string.

Specified by:

startMessage in interface ProgressMonitor

finishMessage

public void finishMessage(String msg)

Description copied from interface: ProgressMonitor

Output the finishing message. The format is implementation dependent.

Specified by:

finishMessage in interface ProgressMonitor

start

public void start()

Description copied from interface: ProgressMonitor

Start and start timing. This should be paired with a call to ProgressMonitor.finish().

Specified by:

start in interface ProgressMonitor

finish

public void finish()

Description copied from interface: ProgressMonitor

Finish and stop timing. The total time is available with ProgressMonitor.getTime() and the number of items processes with ProgressMonitor.getTicks().

Specified by:

finish in interface ProgressMonitor

tick

public void tick()

Description copied from interface: ProgressMonitor

Something happened

Specified by:

tick in interface ProgressMonitor

getTicks

public long getTicks()

Description copied from interface: ProgressMonitor

Return the number of ticks. Valid after ProgressMonitor.start() has been called.

Specified by:

getTicks in interface ProgressMonitor

getTime

public long getTime()

Description copied from interface: ProgressMonitor

Return the elapsed time taken - this is only valid after ProgressMonitor.finish() has been called.

Specified by:

getTime in interface ProgressMonitor

startSection

public void startSection()

Description copied from interface: ProgressMonitor

Start a section within the overall start-finish.

Specified by:

startSection in interface ProgressMonitor

finishSection

public void finishSection()

Description copied from interface: ProgressMonitor

Finish a section within the overall start-finish.

Specified by:

finishSection in interface ProgressMonitor

getSectionTicks

public long getSectionTicks()

Description copied from interface: ProgressMonitor

Return the number of ticks. Valid after ProgressMonitor.startSection() has been called.

Specified by:

getSectionTicks in interface ProgressMonitor

getSectionTime

public long getSectionTime()

Description copied from interface: ProgressMonitor

Return the elapsed section time taken.

Specified by:

getSectionTime in interface ProgressMonitor

getLabel

public String getLabel()

Specified by:

getLabel in interface ProgressMonitor

setLabel

public void setLabel(String label)

Specified by:

setLabel in interface ProgressMonitor