Improve comments

[gpl/argeo-slc.git] / org.argeo.slc / src / main / java / org / argeo / slc / core / test / tree / TreeTestResult.java

diff --git a/org.argeo.slc/src/main/java/org/argeo/slc/core/test/tree/TreeTestResult.java b/org.argeo.slc/src/main/java/org/argeo/slc/core/test/tree/TreeTestResult.java
index 3c5be7305e3547c33683abcf59bbfe59898b5662..fb1b0130c951027a29f576381bd38357d47d5476 100644 (file)
--- a/org.argeo.slc/src/main/java/org/argeo/slc/core/test/tree/TreeTestResult.java
+++ b/org.argeo.slc/src/main/java/org/argeo/slc/core/test/tree/TreeTestResult.java
@@ -3,6 +3,7 @@ package org.argeo.slc.core.test.tree;
 import java.util.List;\r
 import java.util.SortedMap;\r
 import java.util.TreeMap;\r
+import java.util.Vector;\r
 \r
 import org.apache.commons.logging.Log;\r
 import org.apache.commons.logging.LogFactory;\r
@@ -18,32 +19,44 @@ import org.argeo.slc.core.test.TestResultId;
 import org.argeo.slc.core.test.TestResultListener;\r
 import org.argeo.slc.core.test.TestResultPart;\r
 \r
+/**\r
+ * Complex implementation of a test result compatible with a tree based\r
+ * structure.\r
+ */\r
 public class TreeTestResult implements TestResult, StructureAware {\r
        private Log log = LogFactory.getLog(TreeTestResult.class);\r
        /** For ORM */\r
        private Long tid;\r
 \r
        private NumericTRId testResultId;\r
-       private List<TestResultListener> listeners;\r
+       private List<TestResultListener> listeners = new Vector<TestResultListener>();\r
 \r
        private TreeSPath currentPath;\r
-       \r
+\r
        private boolean isClosed = false;\r
 \r
        private SortedMap<TreeSPath, PartSubList> resultParts = new TreeMap<TreeSPath, PartSubList>();\r
 \r
+       private StructureRegistry registry;\r
+       \r
        public TestResultId getTestResultId() {\r
                return testResultId;\r
        }\r
 \r
+       /**\r
+        * Use of a <code>NumericTRId</code> is required by Hibernate. <b>It may\r
+        * change in the future.</b>\r
+        */\r
        public NumericTRId getNumericResultId() {\r
                return testResultId;\r
        }\r
 \r
+       /** Sets the test result id as a numeric test result id.*/\r
        public void setNumericResultId(NumericTRId testResultId) {\r
                this.testResultId = testResultId;\r
        }\r
 \r
+       /** Sets the list of listeners.*/\r
        public void setListeners(List<TestResultListener> listeners) {\r
                this.listeners = listeners;\r
        }\r
@@ -69,25 +82,30 @@ public class TreeTestResult implements TestResult, StructureAware {
 \r
        public void notifyCurrentPath(StructureRegistry registry, StructurePath path) {\r
                currentPath = (TreeSPath) path;\r
+               this.registry = registry;\r
        }\r
 \r
+       /** Gets the current path.*/\r
        public TreeSPath getCurrentPath() {\r
                return currentPath;\r
        }\r
 \r
+       /** Gets all the results structured as a map of <code>PartSubList<code>s. */\r
        public SortedMap<TreeSPath, PartSubList> getResultParts() {\r
                return resultParts;\r
        }\r
 \r
+       /** Used by ORM systems. */\r
        void setResultParts(SortedMap<TreeSPath, PartSubList> resultParts) {\r
                this.resultParts = resultParts;\r
        }\r
 \r
        public void close() {\r
-               if(isClosed){\r
-                       throw new SlcException("Test Result #"+getTestResultId()+" alredy closed.");\r
+               if (isClosed) {\r
+                       throw new SlcException("Test Result #" + getTestResultId()\r
+                                       + " alredy closed.");\r
                }\r
-               \r
+\r
                synchronized (listeners) {\r
                        for (TestResultListener listener : listeners) {\r
                                listener.close();\r
@@ -95,7 +113,7 @@ public class TreeTestResult implements TestResult, StructureAware {
                        listeners.clear();\r
                }\r
                isClosed = true;\r
-               log.info("Test Result #"+getTestResultId()+" closed.");\r
+               log.info("Test Result #" + getTestResultId() + " closed.");\r
        }\r
 \r
        Long getTid() {\r
@@ -106,4 +124,14 @@ public class TreeTestResult implements TestResult, StructureAware {
                this.tid = tid;\r
        }\r
 \r
+       /** Gets the related registry (can be null).*/\r
+       public StructureRegistry getRegistry() {\r
+               return registry;\r
+       }\r
+\r
+       /** Sets the related registry.*/\r
+       public void setRegistry(StructureRegistry registry) {\r
+               this.registry = registry;\r
+       }\r
+\r
 }\r