X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2FProgress.java;h=dea6be3fa011c351e4990b39e396368a50174e9d;hb=8c227da67c11370980154c61861bcfb9c73881c5;hp=5af7b30d83b357654d2b34e3bff3faa3eb8de9d6;hpb=0924c45dd84be115c6c622b075445855b13951e5;p=fanfix.git diff --git a/src/be/nikiroo/utils/Progress.java b/src/be/nikiroo/utils/Progress.java index 5af7b30..dea6be3 100644 --- a/src/be/nikiroo/utils/Progress.java +++ b/src/be/nikiroo/utils/Progress.java @@ -6,7 +6,6 @@ import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Map.Entry; -import java.util.Set; /** * Progress reporting system, possibly nested. @@ -14,6 +13,12 @@ import java.util.Set; * @author niki */ public class Progress { + /** + * This event listener is designed to report progress events from + * {@link Progress}. + * + * @author niki + */ public interface ProgressListener extends EventListener { /** * A progression event. @@ -37,8 +42,8 @@ public class Progress { private List listeners; private int min; private int max; - private int localProgress; - private int progress; // children included + private double relativeLocalProgress; + private double relativeProgress; // children included /** * Create a new default unnamed {@link Progress}, from 0 to 100. @@ -106,8 +111,7 @@ public class Progress { */ public void setName(String name) { this.name = name; - // will fire an action event: - setProgress(this.localProgress); + changed(this, name); } /** @@ -126,17 +130,17 @@ public class Progress { * the min to set * * - * @throws Error + * @throws RuntimeException * if min < 0 or if min > max */ public void setMin(int min) { if (min < 0) { - throw new Error("negative values not supported"); + throw new RuntimeException("negative values not supported"); } - synchronized (getLock()) { + synchronized (lock) { if (min > max) { - throw new Error( + throw new RuntimeException( "The minimum progress value must be <= the maximum progress value"); } @@ -160,11 +164,11 @@ public class Progress { * the max to set * * - * @throws Error + * @throws RuntimeException * if max < min */ public void setMax(int max) { - synchronized (getLock()) { + synchronized (lock) { if (max < min) { throw new Error( "The maximum progress value must be >= the minimum progress value"); @@ -182,20 +186,20 @@ public class Progress { * @param max * the max * - * @throws Error + * @throws RuntimeException * if min < 0 or if min > max */ public void setMinMax(int min, int max) { if (min < 0) { - throw new Error("negative values not supported"); + throw new RuntimeException("negative values not supported"); } if (min > max) { - throw new Error( + throw new RuntimeException( "The minimum progress value must be <= the maximum progress value"); } - synchronized (getLock()) { + synchronized (lock) { this.min = min; this.max = max; } @@ -209,7 +213,7 @@ public class Progress { * @return the progress the value */ public int getProgress() { - return progress; + return (int) Math.round(relativeProgress * (max - min)); } /** @@ -221,60 +225,125 @@ public class Progress { * the progress to set */ public void setProgress(int progress) { - synchronized (getLock()) { - int diff = this.progress - this.localProgress; - this.localProgress = progress; - setTotalProgress(this, name, progress + diff); + synchronized (lock) { + double childrenProgress = relativeProgress - relativeLocalProgress; + + relativeLocalProgress = ((double) progress) / (max - min); + + setRelativeProgress(this, name, relativeLocalProgress + + childrenProgress); + } + } + + /** + * Get the total progress value (including the optional children + * {@link Progress}) on a 0.0 to 1.0 scale. + * + * @return the progress + */ + public double getRelativeProgress() { + return relativeProgress; + } + + /** + * Set the total progress value (including the optional children + * {@link Progress}), on a 0 to 1 scale. + * + * @param pg + * the {@link Progress} to report as the progression emitter + * @param name + * the current name (if it is NULL, the first non-null name in + * the hierarchy will overwrite it) of the {@link Progress} who + * emitted this change + * @param relativeProgress + * the progress to set + */ + private void setRelativeProgress(Progress pg, String name, + double relativeProgress) { + synchronized (lock) { + relativeProgress = Math.max(0, relativeProgress); + relativeProgress = Math.min(1, relativeProgress); + this.relativeProgress = relativeProgress; + + changed(pg, name); + } + } + + /** + * Get the total progress value (including the optional children + * {@link Progress}) on a 0 to 1 scale. + * + * @return the progress the value + */ + private int getLocalProgress() { + return (int) Math.round(relativeLocalProgress * (max - min)); + } + + /** + * Add some value to the current progression of this {@link Progress}. + * + * @param step + * the amount to add + */ + public void add(int step) { + synchronized (lock) { + setProgress(getLocalProgress() + step); } } /** * Check if the action corresponding to this {@link Progress} is done (i.e., - * if its progress value is >= its max value). + * if its progress value == its max value). * * @return TRUE if it is */ public boolean isDone() { - return progress >= max; + return getProgress() == max; } /** - * Get the total progress value (including the optional children - * {@link Progress}) on a 0.0 to 1.0 scale. - * - * @return the progress + * Mark the {@link Progress} as done by setting its value to max. */ - public double getRelativeProgress() { - return (((double) progress) / (max - min)); + public void done() { + synchronized (lock) { + double childrenProgress = relativeProgress - relativeLocalProgress; + relativeLocalProgress = 1 - childrenProgress; + setRelativeProgress(this, name, 1d); + } } /** * Return the list of direct children of this {@link Progress}. * - * @return the children (who will think of them??) + * @return the children (Who will think of the children??) */ - public Set getChildren() { - return children.keySet(); + public List getChildren() { + synchronized (lock) { + return new ArrayList(children.keySet()); + } } /** - * Set the total progress value (including the optional children - * {@link Progress}), on a {@link Progress#getMin()} to - * {@link Progress#getMax()} scale. + * Notify the listeners that this {@link Progress} changed value. * * @param pg - * the {@link Progress} to report as the progression emitter + * the emmiter, that is, the (sub-){link Progress} that just + * reported some change, not always the same as this * @param name * the current name (if it is NULL, the first non-null name in * the hierarchy will overwrite it) of the {@link Progress} who * emitted this change - * @param progress - * the progress to set */ - private void setTotalProgress(Progress pg, String name, int progress) { - synchronized (getLock()) { - this.progress = progress; + private void changed(Progress pg, String name) { + if (pg == null) { + pg = this; + } + + if (name == null) { + name = this.name; + } + synchronized (lock) { for (ProgressListener l : listeners) { l.progress(pg, name); } @@ -292,7 +361,9 @@ public class Progress { * the listener */ public void addProgressListener(ProgressListener l) { - this.listeners.add(l); + synchronized (lock) { + this.listeners.add(l); + } } /** @@ -304,7 +375,9 @@ public class Progress { * @return TRUE if it was found (and removed) */ public boolean removeProgressListener(ProgressListener l) { - return this.listeners.remove(l); + synchronized (lock) { + return this.listeners.remove(l); + } } /** @@ -317,59 +390,44 @@ public class Progress { * {@link Progress#getMax()} scale) of this child * {@link Progress} in relation to its parent * - * @throws Error + * @throws RuntimeException * if weight exceed {@link Progress#getMax()} or if progress * already has a parent */ public void addProgress(Progress progress, double weight) { if (weight < min || weight > max) { - throw new Error(String.format( + throw new RuntimeException(String.format( "Progress object %s cannot have a weight of %f, " - + "it is outside of its parent (%s) range (%f)", + + "it is outside of its parent (%s) range (%d)", progress.name, weight, name, max)); } if (progress.parent != null) { - throw new Error(String.format( + throw new RuntimeException(String.format( "Progress object %s cannot be added to %s, " + "as it already has a parent (%s)", progress.name, name, progress.parent.name)); } - progress.addProgressListener(new ProgressListener() { + ProgressListener progressListener = new ProgressListener() { + @Override public void progress(Progress pg, String name) { - synchronized (getLock()) { - double total = ((double) localProgress) / (max - min); + synchronized (lock) { + double total = relativeLocalProgress; for (Entry entry : children.entrySet()) { total += (entry.getValue() / (max - min)) * entry.getKey().getRelativeProgress(); } - if (name == null) { - name = Progress.this.name; - } - - setTotalProgress(pg, name, - (int) Math.round(total * (max - min))); + setRelativeProgress(pg, name, total); } } - }); - - this.children.put(progress, weight); - } + }; - /** - * The lock object to use (this one or the recursively-parent one). - * - * @return the lock object to use - */ - private Object getLock() { synchronized (lock) { - if (parent != null) { - return parent.getLock(); - } - - return lock; + progress.parent = this; + this.children.put(progress, weight); + progress.addProgressListener(progressListener); } } }