to.etc.util

Class Progress

java.lang.Object

to.etc.util.Progress

public class Progress
extends Object

A progress reporter utility. A single instance defines progress in user-specified numeric terms (for instance record 12 of 1012312), and gets translated to a percentage. Progress instances can obtain sub-progress parts that are Progress entries all by themselves and can define their work in their terms; they get mapped to the defined part of work in their parent(s).

Author:

Frits Jalvingh Created on Oct 16, 2009

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Progress.Info

Constructor Summary

Constructors

Constructor and Description
Progress(String name) Top-level progress indicator for a given task.

Method Summary

Modifier and Type	Method and Description
void	addListener(IProgressListener l)
void	cancel() Request the action to be cancelled.
void	complete()
Progress	createParallelProgress(String name, double work)
Progress	createSubProgress(String name, double work) Create a single (non-parallel) sub-progress indicator for the specified portion of work.
String	getActionPath(int levels) Get the path until the first parallel subprocess or the specified level
double	getCompletedWork()
double	getFraction()
String	getName()
List<Progress.Info>	getParallels(int level) Return all parallel-running progress parts, starting with the root one.
Progress	getParent()
int	getPercentage()
Progress	getRoot() Return the root progress handler; this NEVER returns null - it returns itself if it is the root.
double	getTotalWork()
void	increment(double inc)
boolean	isCancelable()
boolean	isCancelled()
void	removeListener(IProgressListener l)
void	setCancelable(boolean yes)
void	setCompleted(double now) Set the amount of work completed.
void	setCompleted(double now, String extra)
void	setTotalWork(double work) Set the current amount of work.
void	setTotalWork(double work, String extra) Set the current amount of work.
protected void	updated()

Methods inherited from class java.lang.Object

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

Constructor Detail

Progress

public Progress(@Nullable
                String name)

Top-level progress indicator for a given task.

Method Detail

getParallels

@Nonnull
public List<Progress.Info> getParallels(int level)

Return all parallel-running progress parts, starting with the root one.

Parameters:

level -

Returns:

getRoot

@Nonnull
public Progress getRoot()

Return the root progress handler; this NEVER returns null - it returns itself if it is the root.

Returns:

getParent

@Nullable
public Progress getParent()

isCancelable

public boolean isCancelable()

getName

@Nullable
public String getName()

getTotalWork

public double getTotalWork()

getCompletedWork

public double getCompletedWork()

getPercentage

public int getPercentage()

getFraction

public double getFraction()

getActionPath

@Nonnull
public String getActionPath(int levels)

Get the path until the first parallel subprocess or the specified level

cancel

public void cancel()

Request the action to be cancelled.

setCancelable

public void setCancelable(boolean yes)

isCancelled

public boolean isCancelled()

setTotalWork

public void setTotalWork(double work)

Set the current amount of work.

Parameters:

work -

name -

setTotalWork

public void setTotalWork(double work,
                         @Nullable
                         String extra)

Set the current amount of work.

Parameters:

work -

extra -

setCompleted

public void setCompleted(double now)

Set the amount of work completed. It can only be set to a valid value, and it can only advance, not go back.

Parameters:

now -

setCompleted

public void setCompleted(double now,
                         @Nullable
                         String extra)

complete

public void complete()

increment

public void increment(double inc)

createSubProgress

@Nonnull
public Progress createSubProgress(@Nullable
                                           String name,
                                           double work)

Create a single (non-parallel) sub-progress indicator for the specified portion of work.

Returns:

createParallelProgress

@Nonnull
public Progress createParallelProgress(@Nullable
                                                String name,
                                                double work)

updated

protected void updated()

addListener

public void addListener(@Nonnull
                        IProgressListener l)

removeListener

public void removeListener(@Nonnull
                           IProgressListener l)