Improve process management

[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 6545727223989660a7886f1a9397954fff2c9648..77cc268169f81d0845b0f083f23049e357f02b69 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
@@ -19,6 +19,27 @@ package org.argeo.slc.execution;
 import java.io.Serializable;
 import java.util.Map;
 
+/**
+ * 
+ * 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.
+ * 
+ * Generally, values object are either a <code>PrimitiveAccessor</code> or a
+ * <code>RefValue</code> but can be other objects.
+ */
 public class ExecutionFlowDescriptor implements Serializable {
        private static final long serialVersionUID = 7101944857038041216L;
        private String name;
@@ -41,10 +62,18 @@ public class ExecutionFlowDescriptor implements Serializable {
                return name;
        }
 
+       /**
+        * @deprecated will be removed in SLC 2.0, the path should be the part of
+        *             the name with '/'
+        */
        public String getPath() {
                return path;
        }
 
+       /**
+        * @deprecated will be removed in SLC 2.0, the path should be the part of
+        *             the name with '/'
+        */
        public void setPath(String path) {
                this.path = path;
        }
@@ -89,4 +118,10 @@ public class ExecutionFlowDescriptor implements Serializable {
                return name.hashCode();
        }
 
+       @Override
+       public String toString() {
+               return (path != null && !path.trim().equals("") ? path + "/" : "")
+                               + name;
+       }
+
 }