add some comments to help understanding the approach

[gpl/argeo-slc.git] / runtime / org.argeo.slc.specs / src / main / java / org / argeo / slc / execution / ExecutionFlowDescriptor.java

diff --git a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java
index d9a3e66574903db85a9e2f93fab95756b42e76d3..f4329309996bc9fd6ee855be9731415953bcf446 100644 (file)
--- a/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java
+++ b/runtime/org.argeo.slc.specs/src/main/java/org/argeo/slc/execution/ExecutionFlowDescriptor.java
@@ -21,14 +21,27 @@ import java.util.Map;
 
 /**
  * 
- * @author bsinou
+ * Implements both archetype and implementation of a given process.
+ * 
+ * At specification time, <code>executionSpec</code> represents the spec of the
+ * parameters accepted by the process, with, among others: type, default value
+ * and, optionally, possible values for each parameter. Thus ExecutionSpec might
+ * be a huge object. Note that when marshalling only a reference to a specific
+ * ExecutionSpec is stored in the XML to optimize performance and avoid
+ * redundancy between various ExecutionFlowDesciptor that might have the same
+ * ExecutionSpec.
+ * 
+ * At runtime, we build a RealizedFlow which references an
+ * ExecutionFlowDescriptor. As it happens AFTER marshalling / unmarshalling
+ * process, the ExecutionSpec is null but we manage to retrieve the
+ * ExecutionSpec and store it in the RealizedFlow, whereas set values of the
+ * parameters are stored in the <code>values</code> map.
  * 
- *         This class implements the archetype of a given process.
+ * Generally, values object are either a <code>PrimitiveAccessor</code> or a
+ * <code>RefValue</code> but can be other objects.
+ * 
+ * @author bsinou
  * 
- *         WARNING : for now both <code>values</code> and
- *         <code>executionSpec</code> which are rundundant are used. Should be
- *         improved in further version. Note also that a third redundant field,
- *         <code>RealizedFlow.executionSpec</code> is also to be cleaned.
  * 
  */
 public class ExecutionFlowDescriptor implements Serializable {