de.lmu.ifi.dbs.elki.logging.progress

Class MutableProgress

java.lang.Object

de.lmu.ifi.dbs.elki.logging.progress.AbstractProgress

de.lmu.ifi.dbs.elki.logging.progress.MutableProgress

All Implemented Interfaces:

Progress

public class MutableProgress
extends AbstractProgress

Progress class with a moving target.

Author:

Erich Schubert

Field Summary

Fields

Modifier and Type	Field and Description
private int	total The overall number of items to process.

Constructor Summary

Constructors

Constructor and Description
MutableProgress(String task, int total, Logging logger) Constructor with logging.

Method Summary

Methods

Modifier and Type	Method and Description
StringBuilder	appendToBuffer(StringBuilder buf) Serialize 'indefinite' progress.
int	getTotal() Get the current value of total.
boolean	isComplete() Return whether the progress is complete
void	setTotal(int total) Modify the total value.

Methods inherited from class de.lmu.ifi.dbs.elki.logging.progress.AbstractProgress

getProcessed, getTask, incrementProcessed, setProcessed, setProcessed, testLoggingRate, toString

Methods inherited from class java.lang.Object

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

Field Detail

total

private int total

The overall number of items to process.

Constructor Detail

MutableProgress

public MutableProgress(String task,
               int total,
               Logging logger)

Constructor with logging.

Parameters:

task - Task name.

total - Initial value of total.

logger - Logger to report to

Method Detail

appendToBuffer

public StringBuilder appendToBuffer(StringBuilder buf)

Serialize 'indefinite' progress.

Specified by:

appendToBuffer in interface Progress

Specified by:

appendToBuffer in class AbstractProgress

Parameters:

buf - Buffer to serialize to

Returns:

Buffer the data was serialized to.

isComplete

public boolean isComplete()

Return whether the progress is complete

Returns:

Completion status.

setTotal

public void setTotal(int total)
              throws IllegalArgumentException

Modify the total value.

Parameters:

total -

Throws:

IllegalArgumentException

getTotal

public int getTotal()

Get the current value of total.

Returns:

total