public abstract class ProgressMonitor extends Object implements ProgressReporter
Modifier and Type | Class and Description |
---|---|
static class |
ProgressMonitor.Builder
Builder class for a customizable progress monitor
|
static class |
ProgressMonitor.DefaultProgressFormatter |
static class |
ProgressMonitor.DelegatingProgressMonitor |
static interface |
ProgressMonitor.ProgressFormatter |
static class |
ProgressMonitor.ReportingProgressMonitor
Chain more than one monitor / reporter
|
Progress.Default
Constructor and Description |
---|
ProgressMonitor() |
Modifier and Type | Method and Description |
---|---|
static ProgressMonitor.Builder |
builder(String name) |
static ProgressMonitor |
create(String name,
long maxProgress,
PrintStream theOut)
Creates a default progress monitor that prints progress at every percent increments.
|
static ProgressMonitor |
fixedIntervalMonitor(String taskName,
String elementName,
long interval,
PrintStream out)
Returns a progress monitor that prints status at fixed intervals and does not have a notion of
maxProgress . |
static ProgressMonitor |
minimal(String name,
OutputStream output)
Returns a monitor that does not track progress value but prints a message at the beginning and at the end.
|
static ProgressMonitor |
newBufferedMonitor(ProgressMonitor monitor,
long limit)
A non thread-safe progress monitor that propagates progress in batches to another progress monitor.
|
static ProgressMonitor |
newMultiplyingMonitor(ProgressMonitor monitor,
int multiplier)
A progress monitor that multiples the progress by a constant amount before passing it to another
progress monitor.
|
abstract void |
print()
Print the current progress, implementations may implement this as a no-op
|
static ProgressMonitor |
silent()
Returns a monitor that does absolutely nothing.
|
abstract void |
stop()
Stops the current progress monitor causing it to print a final message
|
static ProgressMonitor.ProgressFormatter |
tpsFormatter(long theTripleCount)
Returns a message format that appends the tps (triples/sec) metric at the end of default progress message regardless of what progress unit is used
for the underlying progress monitor.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close, increment, incrementMaxProgress, stage
current, hasProgress, maxProgress, stage
public abstract void print()
ProgressReporter
print
in interface ProgressReporter
public abstract void stop()
stop
in interface ProgressReporter
public static ProgressMonitor.ProgressFormatter tpsFormatter(long theTripleCount)
public static ProgressMonitor silent()
public static ProgressMonitor create(String name, long maxProgress, PrintStream theOut)
public static ProgressMonitor.Builder builder(String name)
public static ProgressMonitor minimal(String name, OutputStream output)
public static ProgressMonitor fixedIntervalMonitor(String taskName, String elementName, long interval, PrintStream out)
maxProgress
.
This class is *NOT* thread-safe.taskName
- name of the task used at the beginning of each lineelementName
- name of the elements that are being processed (e.g. triples, literals, etc.)interval
- number of elements to process before reporting progresspublic static ProgressMonitor newMultiplyingMonitor(ProgressMonitor monitor, int multiplier)
monitor
- delegated monitormultiplier
- amount which progress will be multipliedpublic static ProgressMonitor newBufferedMonitor(ProgressMonitor monitor, long limit)
monitor
- delegated monitorlimit
- until which progress will be buffered locallyCopyright © 2010-2016 Stardog Union. All Rights Reserved.