1 package be
.nikiroo
.utils
;
3 import java
.util
.ArrayList
;
4 import java
.util
.EventListener
;
5 import java
.util
.HashMap
;
8 import java
.util
.Map
.Entry
;
12 * Progress reporting system, possibly nested.
16 public class Progress
{
17 public interface ProgressListener
extends EventListener
{
19 * A progression event.
22 * the {@link Progress} object that generated it, not
23 * necessarily the same as the one where the listener was
24 * attached (it could be a child {@link Progress} of this
27 * the first non-null name of the {@link Progress} step that
28 * generated this event
30 public void progress(Progress progress
, String name
);
33 private Progress parent
= null;
34 private Object lock
= new Object();
36 private Map
<Progress
, Double
> children
;
37 private List
<ProgressListener
> listeners
;
40 private int localProgress
;
41 private int progress
; // children included
44 * Create a new default unnamed {@link Progress}, from 0 to 100.
51 * Create a new default {@link Progress}, from 0 to 100.
54 * the name of this {@link Progress} step
56 public Progress(String name
) {
61 * Create a new unnamed {@link Progress}, from min to max.
64 * the minimum progress value (and starting value) -- must be
67 * the maximum progress value
69 public Progress(int min
, int max
) {
74 * Create a new {@link Progress}, from min to max.
77 * the name of this {@link Progress} step
79 * the minimum progress value (and starting value) -- must be
82 * the maximum progress value
84 public Progress(String name
, int min
, int max
) {
86 this.children
= new HashMap
<Progress
, Double
>();
87 this.listeners
= new ArrayList
<Progress
.ProgressListener
>();
93 * The name of this {@link Progress} step.
97 public String
getName() {
102 * The name of this {@link Progress} step.
107 public void setName(String name
) {
109 // will fire an action event:
110 setProgress(this.localProgress
);
114 * The minimum progress value.
118 public int getMin() {
123 * The minimum progress value.
130 * if min < 0 or if min > max
132 public void setMin(int min
) {
134 throw new Error("negative values not supported");
137 synchronized (getLock()) {
140 "The minimum progress value must be <= the maximum progress value");
148 * The maximum progress value.
152 public int getMax() {
157 * The maximum progress value (must be >= the minimum progress value).
166 public void setMax(int max
) {
167 synchronized (getLock()) {
170 "The maximum progress value must be >= the minimum progress value");
178 * Set both the minimum and maximum progress values.
186 * if min < 0 or if min > max
188 public void setMinMax(int min
, int max
) {
190 throw new Error("negative values not supported");
195 "The minimum progress value must be <= the maximum progress value");
198 synchronized (getLock()) {
205 * Get the total progress value (including the optional children
206 * {@link Progress}) on a {@link Progress#getMin()} to
207 * {@link Progress#getMax()} scale.
209 * @return the progress the value
211 public int getProgress() {
216 * Set the local progress value (not including the optional children
217 * {@link Progress}), on a {@link Progress#getMin()} to
218 * {@link Progress#getMax()} scale.
221 * the progress to set
223 public void setProgress(int progress
) {
224 synchronized (getLock()) {
225 int diff
= this.progress
- this.localProgress
;
226 this.localProgress
= progress
;
227 setTotalProgress(this, name
, progress
+ diff
);
232 * Check if the action corresponding to this {@link Progress} is done (i.e.,
233 * if its progress value is >= its max value).
235 * @return TRUE if it is
237 public boolean isDone() {
238 return progress
>= max
;
242 * Get the total progress value (including the optional children
243 * {@link Progress}) on a 0.0 to 1.0 scale.
245 * @return the progress
247 public double getRelativeProgress() {
248 return (((double) progress
) / (max
- min
));
252 * Return the list of direct children of this {@link Progress}.
254 * @return the children (who will think of them??)
256 public Set
<Progress
> getChildren() {
257 return children
.keySet();
261 * Set the total progress value (including the optional children
262 * {@link Progress}), on a {@link Progress#getMin()} to
263 * {@link Progress#getMax()} scale.
266 * the {@link Progress} to report as the progression emitter
268 * the current name (if it is NULL, the first non-null name in
269 * the hierarchy will overwrite it) of the {@link Progress} who
270 * emitted this change
272 * the progress to set
274 private void setTotalProgress(Progress pg
, String name
, int progress
) {
275 synchronized (getLock()) {
276 this.progress
= progress
;
278 for (ProgressListener l
: listeners
) {
279 l
.progress(pg
, name
);
285 * Add a {@link ProgressListener} that will trigger on progress changes.
287 * Note: the {@link Progress} that will be reported will be the active
288 * progress, not necessarily the same as the current one (it could be a
289 * child {@link Progress} of this {@link Progress}).
294 public void addProgressListener(ProgressListener l
) {
295 this.listeners
.add(l
);
299 * Remove a {@link ProgressListener} that would trigger on progress changes.
304 * @return TRUE if it was found (and removed)
306 public boolean removeProgressListener(ProgressListener l
) {
307 return this.listeners
.remove(l
);
311 * Add a child {@link Progress} of the given weight.
314 * the child {@link Progress} to add
316 * the weight (on a {@link Progress#getMin()} to
317 * {@link Progress#getMax()} scale) of this child
318 * {@link Progress} in relation to its parent
321 * if weight exceed {@link Progress#getMax()} or if progress
322 * already has a parent
324 public void addProgress(Progress progress
, double weight
) {
325 if (weight
< min
|| weight
> max
) {
326 throw new Error(String
.format(
327 "Progress object %s cannot have a weight of %f, "
328 + "it is outside of its parent (%s) range (%f)",
329 progress
.name
, weight
, name
, max
));
332 if (progress
.parent
!= null) {
333 throw new Error(String
.format(
334 "Progress object %s cannot be added to %s, "
335 + "as it already has a parent (%s)", progress
.name
,
336 name
, progress
.parent
.name
));
339 progress
.addProgressListener(new ProgressListener() {
340 public void progress(Progress pg
, String name
) {
341 synchronized (getLock()) {
342 double total
= ((double) localProgress
) / (max
- min
);
343 for (Entry
<Progress
, Double
> entry
: children
.entrySet()) {
344 total
+= (entry
.getValue() / (max
- min
))
345 * entry
.getKey().getRelativeProgress();
349 name
= Progress
.this.name
;
352 setTotalProgress(pg
, name
,
353 (int) Math
.round(total
* (max
- min
)));
358 this.children
.put(progress
, weight
);
362 * The lock object to use (this one or the recursively-parent one).
364 * @return the lock object to use
366 private Object
getLock() {
367 synchronized (lock
) {
368 if (parent
!= null) {
369 return parent
.getLock();