svn commit: r1548591 - in /uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep: FixedSleepAE.java FixedSleepCR.java NoSleepAE.java NoSleepCR.java

[ch...@apache.org]

Author: challngr
Date: Fri Dec  6 16:45:25 2013
New Revision: 1548591

URL: http://svn.apache.org/r1548591
Log:
UIMA-3450 Add class comments.

Removed:
    uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/NoSleepAE.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/NoSleepCR.java
Modified:
    uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepAE.java
    uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepCR.java

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepAE.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepAE.java?rev=1548591&r1=1548590&r2=1548591&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepAE.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepAE.java Fri Dec  6 16:45:25 2013
@@ -41,8 +41,8 @@ import org.apache.uima.util.Level;
 import org.apache.uima.util.Logger;
 
 /**
- * challngr@us.ibm.com
- * May, 2011
+ * Simple AE for the system test.  It does no computation, instead sleeping to simulate computation.  It
+ * is able to inject errors and adjust it's simulated initialization time.
  */
 
 public class FixedSleepAE extends CasAnnotator_ImplBase 

Modified: uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepCR.java
URL: http://svn.apache.org/viewvc/uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepCR.java?rev=1548591&r1=1548590&r2=1548591&view=diff
==============================================================================
--- uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepCR.java (original)
+++ uima/sandbox/uima-ducc/trunk/uima-ducc-examples/src/main/java/org/apache/uima/ducc/test/randomsleep/FixedSleepCR.java Fri Dec  6 16:45:25 2013
@@ -38,6 +38,20 @@ import org.apache.uima.util.Logger;
 import org.apache.uima.util.Progress;
 import org.apache.uima.util.ProgressImpl;
 
+/**
+ * Colleciton reader for the system tests.  This reads a java properties file containing "work items" which are
+ * actually just sleep times.  Each getNext passes a new sleep time to one of the waiting FixedSleepAE JPs
+ * to simulate real work.
+ *
+ * The CR accepts these overrides:
+ *   - jobfile - this is the name of the properties file with the 'work item' sleep tims
+ *   - compression - this is a number used to adjust each sleep time and hence the duration 
+ *                   of the test.  The sleep time is divided by this number, so a larger
+ *                   compression produces a shorter sleep and a faster run.
+ *   - error_rate - this is passed to the JP for error injection.  It is a float, percentage and
+ *                  indicates the expected rate of errors processing work items to be simulated.
+ */
+
 public class FixedSleepCR extends CollectionReader_ImplBase {
                 
     private volatile Logger logger;