X-Git-Url: http://git.nikiroo.be/?p=fanfix.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2FProgress.java;h=bb143efaae10e7e21e7fe45c8617256450eb1e7b;hp=ce88f3d8f8c55941bccc094d58b2fd42954be59c;hb=HEAD;hpb=0988831f084e27de9927c1bb29e338e9263bfa42

diff --git a/src/be/nikiroo/utils/Progress.java b/src/be/nikiroo/utils/Progress.java
index ce88f3d..bb143ef 100644
--- a/src/be/nikiroo/utils/Progress.java
+++ b/src/be/nikiroo/utils/Progress.java
@@ -9,6 +9,16 @@ import java.util.Map.Entry;
 
 /**
  * Progress reporting system, possibly nested.
+ * <p>
+ * 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).
+ * <p>
+ * 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
  */
@@ -35,6 +45,7 @@ public class Progress {
 		public void progress(Progress progress, String name);
 	}
 
+	private Map<Object, Object> map = new HashMap<Object, Object>();
 	private Progress parent = null;
 	private Object lock = new Object();
 	private String name;
@@ -97,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;
@@ -138,7 +149,7 @@ public class Progress {
 			throw new RuntimeException("negative values not supported");
 		}
 
-		synchronized (getLock()) {
+		synchronized (lock) {
 			if (min > max) {
 				throw new RuntimeException(
 						"The minimum progress value must be <= the maximum progress value");
@@ -168,7 +179,7 @@ public class Progress {
 	 *             if max &lt; 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");
@@ -199,7 +210,7 @@ public class Progress {
 					"The minimum progress value must be <= the maximum progress value");
 		}
 
-		synchronized (getLock()) {
+		synchronized (lock) {
 			this.min = min;
 			this.max = max;
 		}
@@ -225,13 +236,13 @@ public class Progress {
 	 *            the progress to set
 	 */
 	public void setProgress(int progress) {
-		synchronized (getLock()) {
+		synchronized (lock) {
 			double childrenProgress = relativeProgress - relativeLocalProgress;
 
 			relativeLocalProgress = ((double) progress) / (max - min);
 
-			setRelativeProgress(this, name, relativeLocalProgress
-					+ childrenProgress);
+			setRelativeProgress(this, name,
+					relativeLocalProgress + childrenProgress);
 		}
 	}
 
@@ -245,12 +256,26 @@ public class Progress {
 		return relativeProgress;
 	}
 
+	/**
+	 * Set the total progress value (including the optional children
+	 * {@link Progress}), on a 0 to 1 scale.
+	 * <p>
+	 * Will generate a changed event from this very {@link Progress}.
+	 * 
+	 * @param relativeProgress
+	 *            the progress to set
+	 */
+	public void setRelativeProgress(double relativeProgress) {
+		setRelativeProgress(this, name, 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
+	 *            the {@link Progress} to report as the progression emitter (can
+	 *            be NULL, will then be considered the same as <tt>this</tt>)
 	 * @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
@@ -260,7 +285,7 @@ public class Progress {
 	 */
 	private void setRelativeProgress(Progress pg, String name,
 			double relativeProgress) {
-		synchronized (getLock()) {
+		synchronized (lock) {
 			relativeProgress = Math.max(0, relativeProgress);
 			relativeProgress = Math.min(1, relativeProgress);
 			this.relativeProgress = relativeProgress;
@@ -286,7 +311,7 @@ public class Progress {
 	 *            the amount to add
 	 */
 	public void add(int step) {
-		synchronized (getLock()) {
+		synchronized (lock) {
 			setProgress(getLocalProgress() + step);
 		}
 	}
@@ -305,7 +330,7 @@ public class Progress {
 	 * Mark the {@link Progress} as done by setting its value to max.
 	 */
 	public void done() {
-		synchronized (getLock()) {
+		synchronized (lock) {
 			double childrenProgress = relativeProgress - relativeLocalProgress;
 			relativeLocalProgress = 1 - childrenProgress;
 			setRelativeProgress(this, name, 1d);
@@ -314,20 +339,37 @@ public class Progress {
 
 	/**
 	 * Return the list of direct children of this {@link Progress}.
+	 * <p>
+	 * Can return an empty list, but never NULL.
 	 * 
 	 * @return the children (Who will think of the children??)
 	 */
 	public List<Progress> getChildren() {
-		synchronized (getLock()) {
+		synchronized (lock) {
 			return new ArrayList<Progress>(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);
+		}
+	}
+
 	/**
 	 * 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 <tt>this</tt>
 	 * @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
@@ -342,7 +384,7 @@ public class Progress {
 			name = this.name;
 		}
 
-		synchronized (getLock()) {
+		synchronized (lock) {
 			for (ProgressListener l : listeners) {
 				l.progress(pg, name);
 			}
@@ -360,7 +402,7 @@ public class Progress {
 	 *            the listener
 	 */
 	public void addProgressListener(ProgressListener l) {
-		synchronized (getLock()) {
+		synchronized (lock) {
 			this.listeners.add(l);
 		}
 	}
@@ -374,7 +416,7 @@ public class Progress {
 	 * @return TRUE if it was found (and removed)
 	 */
 	public boolean removeProgressListener(ProgressListener l) {
-		synchronized (getLock()) {
+		synchronized (lock) {
 			return this.listeners.remove(l);
 		}
 	}
@@ -404,47 +446,90 @@ public class Progress {
 		if (progress.parent != null) {
 			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.parent = this;
-
-		progress.addProgressListener(new ProgressListener() {
+		ProgressListener progressListener = new ProgressListener() {
 			@Override
 			public void progress(Progress pg, String name) {
-				synchronized (getLock()) {
+				synchronized (lock) {
 					double total = relativeLocalProgress;
-					synchronized (getLock()) {
-						for (Entry<Progress, Double> entry : children
-								.entrySet()) {
-							total += (entry.getValue() / (max - min))
-									* entry.getKey().getRelativeProgress();
-						}
+					for (Entry<Progress, Double> entry : children.entrySet()) {
+						total += (entry.getValue() / (max - min))
+								* entry.getKey().getRelativeProgress();
 					}
 
 					setRelativeProgress(pg, name, total);
 				}
 			}
-		});
+		};
 
-		synchronized (getLock()) {
+		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.
+	 * <p>
+	 * 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)") //
+		;
 	}
 }