/**
* 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
*/
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;
/**
* The name of this {@link Progress} step.
*
- * @return the name
+ * @return the name, can be NULL
*/
public String getName() {
return name;
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");
* 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");
"The minimum progress value must be <= the maximum progress value");
}
- synchronized (getLock()) {
+ synchronized (lock) {
this.min = min;
this.max = max;
}
* 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);
}
}
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
*/
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;
* the amount to add
*/
public void add(int step) {
- synchronized (getLock()) {
+ synchronized (lock) {
setProgress(getLocalProgress() + step);
}
}
* 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);
/**
* 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
name = this.name;
}
- synchronized (getLock()) {
+ synchronized (lock) {
for (ProgressListener l : listeners) {
l.progress(pg, name);
}
* the listener
*/
public void addProgressListener(ProgressListener l) {
- synchronized (getLock()) {
+ synchronized (lock) {
this.listeners.add(l);
}
}
* @return TRUE if it was found (and removed)
*/
public boolean removeProgressListener(ProgressListener l) {
- synchronized (getLock()) {
+ synchronized (lock) {
return this.listeners.remove(l);
}
}
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)") //
+ ;
}
}
git://git.nikiroo.be / fanfix.git / blobdiff