X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2FProgress.java;h=bb143efaae10e7e21e7fe45c8617256450eb1e7b;hb=59e9bd1e353b9d01cee7da6055ebd36d8d045d3a;hp=b6137f18bf6144d72f186b8e93b6bd70768846b5;hpb=2a35af0bc418c83eaf2be88f706fbfb06d4e9674;p=fanfix.git
diff --git a/src/be/nikiroo/utils/Progress.java b/src/be/nikiroo/utils/Progress.java
index b6137f1..bb143ef 100644
--- a/src/be/nikiroo/utils/Progress.java
+++ b/src/be/nikiroo/utils/Progress.java
@@ -6,14 +6,29 @@ 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.
+ *
+ * A {@link Progress} can have a name, and that name will be reported through
+ * the event system (it will report the first non-null name in the stack from
+ * the {@link Progress} from which the event originated to the parent the event
+ * is listened on).
+ *
+ * The {@link Progress} also has a table of keys/values shared amongst all the
+ * hierarchy (note that when adding a {@link Progress} to others, its values
+ * will be prioritized if some with the same keys were already present in the
+ * hierarchy).
*
* @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.
@@ -30,6 +45,7 @@ public class Progress {
public void progress(Progress progress, String name);
}
+ private Map map = new HashMap();
private Progress parent = null;
private Object lock = new Object();
private String name;
@@ -37,8 +53,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.
@@ -92,7 +108,7 @@ public class Progress {
/**
* The name of this {@link Progress} step.
*
- * @return the name
+ * @return the name, can be NULL
*/
public String getName() {
return name;
@@ -106,7 +122,7 @@ public class Progress {
*/
public void setName(String name) {
this.name = name;
- changed(this);
+ changed(this, name);
}
/**
@@ -125,17 +141,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");
}
@@ -159,11 +175,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");
@@ -181,20 +197,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;
}
@@ -208,7 +224,7 @@ public class Progress {
* @return the progress the value
*/
public int getProgress() {
- return progress;
+ return (int) Math.round(relativeProgress * (max - min));
}
/**
@@ -220,21 +236,14 @@ 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;
- /**
- * Check if the action corresponding to this {@link Progress} is done (i.e.,
- * if its progress value == its max value).
- *
- * @return TRUE if it is
- */
- public boolean isDone() {
- return progress >= max;
+ relativeLocalProgress = ((double) progress) / (max - min);
+
+ setRelativeProgress(this, name,
+ relativeLocalProgress + childrenProgress);
+ }
}
/**
@@ -244,41 +253,114 @@ public class Progress {
* @return the progress
*/
public double getRelativeProgress() {
- return (((double) progress) / (max - min));
+ return relativeProgress;
}
/**
- * Return the list of direct children of this {@link Progress}.
+ * Set the total progress value (including the optional children
+ * {@link Progress}), on a 0 to 1 scale.
+ *
+ * Will generate a changed event from this very {@link Progress}.
*
- * @return the children (Who will think of the children??)
+ * @param relativeProgress
+ * the progress to set
*/
- public Set getChildren() {
- return children.keySet();
+ public void setRelativeProgress(double relativeProgress) {
+ setRelativeProgress(this, name, relativeProgress);
}
/**
* Set the total progress value (including the optional children
- * {@link Progress}), on a {@link Progress#getMin()} to
- * {@link Progress#getMax()} scale.
+ * {@link Progress}), on a 0 to 1 scale.
*
* @param pg
- * the {@link Progress} to report as the progression emitter
+ * the {@link Progress} to report as the progression emitter (can
+ * be NULL, will then be considered 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
+ * @param relativeProgress
* the progress to set
*/
- private void setTotalProgress(Progress pg, String name, int progress) {
- synchronized (getLock()) {
- progress = Math.max(min, progress);
- progress = Math.min(max, progress);
-
- if (progress != this.progress) {
- this.progress = progress;
- changed(pg);
- }
+ 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 == its max value).
+ *
+ * @return TRUE if it is
+ */
+ public boolean isDone() {
+ return getProgress() == max;
+ }
+
+ /**
+ * Mark the {@link Progress} as done by setting its value to max.
+ */
+ 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}.
+ *
+ * Can return an empty list, but never NULL.
+ *
+ * @return the children (Who will think of the children??)
+ */
+ public List getChildren() {
+ synchronized (lock) {
+ return new ArrayList(children.keySet());
+ }
+ }
+
+ /**
+ * The weight of this children if it is actually a child of this.
+ *
+ * @param child
+ * the child to get the weight of
+ *
+ * @return NULL if this is not a child of this
+ */
+ public Double getWeight(Progress child) {
+ synchronized (lock) {
+ return children.get(child);
}
}
@@ -286,14 +368,23 @@ public class Progress {
* Notify the listeners that this {@link Progress} changed value.
*
* @param pg
- * the emmiter
+ * 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
*/
- private void changed(Progress pg) {
+ private void changed(Progress pg, String name) {
if (pg == null) {
pg = this;
}
- synchronized (getLock()) {
+ if (name == null) {
+ name = this.name;
+ }
+
+ synchronized (lock) {
for (ProgressListener l : listeners) {
l.progress(pg, name);
}
@@ -311,7 +402,9 @@ public class Progress {
* the listener
*/
public void addProgressListener(ProgressListener l) {
- this.listeners.add(l);
+ synchronized (lock) {
+ this.listeners.add(l);
+ }
}
/**
@@ -323,7 +416,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);
+ }
}
/**
@@ -336,59 +431,105 @@ 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));
+ + "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);
+ synchronized (lock) {
+ // Should not happen but just in case
+ if (this.map != progress.map) {
+ this.map.putAll(progress.map);
+ }
+ progress.map = this.map;
+ progress.parent = this;
+ this.children.put(progress, weight);
+ progress.addProgressListener(progressListener);
+ }
}
/**
- * The lock object to use (this one or the recursively-parent one).
+ * Set the given value for the given key on this {@link Progress} and it's
+ * children.
*
- * @return the lock object to use
+ * @param key
+ * the key
+ * @param value
+ * the value
*/
- private Object getLock() {
- synchronized (lock) {
- if (parent != null) {
- return parent.getLock();
- }
+ public void put(Object key, Object value) {
+ map.put(key, value);
+ }
- return lock;
+ /**
+ * Return the value associated with this key as a {@link String} if any,
+ * NULL if not.
+ *
+ * If the value is not NULL but not a {@link String}, it will be converted
+ * via {@link Object#toString()}.
+ *
+ * @param key
+ * the key to check
+ *
+ * @return the value or NULL
+ */
+ public String getString(Object key) {
+ Object value = map.get(key);
+ if (value == null) {
+ return null;
}
+
+ return value.toString();
+ }
+
+ /**
+ * Return the value associated with this key if any, NULL if not.
+ *
+ * @param key
+ * the key to check
+ *
+ * @return the value or NULL
+ */
+ public Object get(Object key) {
+ return map.get(key);
+ }
+
+ @Override
+ public String toString() {
+ return "[Progress]" //
+ + (name == null || name.isEmpty() ? "" : " " + name) //
+ + ": " + getProgress() + " / " + getMax() //
+ + (children.isEmpty() ? ""
+ : " (with " + children.size() + " children)") //
+ ;
}
}