LISTSERV 16.5 - HPS-SVN Archives

java/trunk/record-util/src/main/java/org/hps/record/composite

CompositeLoop.java 953 -> 954

--- java/trunk/record-util/src/main/java/org/hps/record/composite/CompositeLoop.java	2014-09-04 21:36:13 UTC (rev 953)
+++ java/trunk/record-util/src/main/java/org/hps/record/composite/CompositeLoop.java	2014-09-05 18:16:21 UTC (rev 954)
@@ -2,12 +2,10 @@

 
 import java.io.File;
 import java.io.IOException;

-import java.io.PrintStream;

 import java.util.ArrayList;
 import java.util.List;
 
 import org.freehep.record.loop.DefaultRecordLoop;

-import org.freehep.record.loop.RecordLoop.Command;

 import org.freehep.record.source.NoSuchRecordException;
 import org.freehep.record.source.RecordSource;
 import org.hps.record.EndRunException;

@@ -39,19 +37,39 @@

     
     CompositeLoopConfiguration config = null;

+    /**
+     * No argument constructor.  
+     * The {@link #configure(CompositeLoopConfiguration)} method must be
+     * called on the loop manually.
+     */

     public CompositeLoop() {
         setRecordSource(recordSource);
     }

+    /**
+     * Create the loop with the given configuration.
+     * @param config The configuration parameters of the loop.
+     */

     public CompositeLoop(CompositeLoopConfiguration config) {
         setRecordSource(recordSource);
         configure(config);
     }

+    /**
+     * Set to true in order to have this loop stop on all
+     * event processing errors.  Certain types of fatal errors
+     * will never be ignored.
+     * @param stopOnErrors True for this loop to stop on errors.
+     */

     public void setStopOnErrors(boolean stopOnErrors) {
         this.stopOnErrors = stopOnErrors;
     }

+    /**
+     * Add a {@link CompositeLoopAdapter} which will process 
+     * {@link CompositeRecord} objects.
+     * @param adapter The CompositeLoopAdapter object.
+     */

     public void addAdapter(CompositeLoopAdapter adapter) {
         addLoopListener(adapter);
         addRecordListener(adapter);

@@ -68,7 +86,7 @@

     }
                 
     /**

-     * Handle errors in the client such as adapters.

+     * Handle errors from the client such as registered adapters.

      * If the loop is setup to try and continue on errors, 
      * only non-fatal record processing exceptions are ignored.
      */

@@ -90,6 +108,9 @@

         done = true;
     }

+    /**
+     * Handle errors thrown by the <code>RecordSource</code>.
+     */

     protected void handleSourceError(Throwable x) {
 
         x.printStackTrace();

@@ -108,6 +129,14 @@

         done = true;
     }

+    /**
+     * True if an error is ignorable.  If <code>stopOnErrors</code>
+     * is true, then this method always returns false.  Otherwise,
+     * the error cause determines whether the loop can continue 
+     * processing.
+     * @param x The error that occurred.
+     * @return True if the error can be ignored.
+     */

     private boolean isIgnorable(Throwable x) {
         
         // Should the loop try to recover from the error if possible?

@@ -144,10 +173,19 @@

         }
     }

+    /**
+     * True if the loop is done processing.  This is 
+     * set to <code>true</code> when fatal errors occur.
+     * @return
+     */

     public boolean isDone() {
         return done;
     }

+    /**
+     * Get the last error that occurred.
+     * @return The last error that occurred.
+     */

     public Throwable getLastError() {
         return _exception;     
     }

@@ -167,10 +205,19 @@

         paused = false;
     }

+    /**
+     * True if loop is paused.
+     * @return True if loop is current paused.
+     */

     public boolean isPaused() {
         return paused;
     }

+    /**
+     * Loop over events from the source.
+     * @param number The number of events to process or -1 for unlimited.
+     * @return The number of records that were processed.
+     */

     public long loop(long number) {
         if (number < 0L) {
             execute(Command.GO, true);

@@ -181,6 +228,10 @@

         return getSupplied();
     }

+    /**
+     * Configure the loop using a {@link CompositeLoopConfiguration} object.
+     * @param config The CompositeLoopConfiguration object containing the loop configuration parameter values.
+     */

     public final void configure(CompositeLoopConfiguration config) {
         
         if (this.config != null)

java/trunk/record-util/src/main/java/org/hps/record/composite

CompositeLoopConfiguration.java 953 -> 954

--- java/trunk/record-util/src/main/java/org/hps/record/composite/CompositeLoopConfiguration.java	2014-09-04 21:36:13 UTC (rev 953)
+++ java/trunk/record-util/src/main/java/org/hps/record/composite/CompositeLoopConfiguration.java	2014-09-05 18:16:21 UTC (rev 954)
@@ -14,10 +14,16 @@

 import org.lcsim.util.Driver;
 
 /**

- * A configuration object for the {@link ProcessingChain}.
- * The instance variables are readable within this package, but
- * must be set through the public set methods when used
- * outside of it, e.g. from MonitoringApplication.

+ * A configuration object for the {@link CompositeLoop}.
+ * 
+ * The instance variables are readable within the package,
+ * e.g. by {@link CompositeLoop}, but their values must be 
+ * set through the public set methods when the class is
+ * used outside its package.
+ * 
+ * Depending on how this object is setup, some arguments
+ * may end up being ignored (e.g. setting a file path
+ * when actually using an ET server, etc.).

  */
 public class CompositeLoopConfiguration {

@@ -39,52 +45,113 @@

     List<Driver> drivers = new ArrayList<Driver>();
     List<CompositeRecordProcessor> compositeProcessors = new ArrayList<CompositeRecordProcessor>();
     List<EtEventProcessor> etProcessors = new ArrayList<EtEventProcessor>();

+                     
+    /**
+     * Set the full path to a file being used as an event source.
+     * This is ignored if the ET system is being used.
+     * @param filePath The full path to a file.
+     * @return This object.
+     */

     public CompositeLoopConfiguration setFilePath(String filePath) {
         this.filePath = filePath;
         return this;
     }

+    /**
+     * Set the ET connection parameters.
+     * This is ignored if using direct file streaming.
+     * @param connection The ET connection parameters.
+     * @return This object.
+     */

     public CompositeLoopConfiguration setEtConnection(EtConnection connection) {
         this.connection = connection;
         return this;
     }

+    /**
+     * Set the data source type e.g. ET server, EVIO file or LCIO file.
+     * @param sourceType The data source type.
+     * @return This object.
+     */

     public CompositeLoopConfiguration setDataSourceType(DataSourceType sourceType) {
         this.sourceType = sourceType;
         return this;
     }

+    /**
+     * Set the processing stage to include i.e. ET only, ET to EVIO, or EVIO to LCIO.
+     * This may be ignored if the argument does not make sense given the 
+     * {@link org.hps.record.enums.DataSourceType} of this configuration.
+     * @param processingStage The processing stage to include in the record chaining.
+     * @return This object.
+     */

     public CompositeLoopConfiguration setProcessingStage(ProcessingStage processingStage) {
         this.processingStage = processingStage;
         return this;
     }

+    /**
+     * Set directly the <code>RecordSource</code> that will supply records.
+     * @param recordSource The <code>RecordSource</code> that will supply records.
+     * @return This object.
+     */

     public CompositeLoopConfiguration setRecordSource(RecordSource recordSource) {
         this.recordSource = recordSource;
         return this;
     }

+    /**
+     * Set the <code>LCSimEventBuilder</code> that will be used to translate from raw EVIO
+     * events to LCIO. 
+     * 
+     * The detector name will be set on this object from within {@link CompositeLoop}. 
+     * 
+     * @param eventBuilder The LCSimEventBuilder object.
+     * @return This object.
+     */

     public CompositeLoopConfiguration setLCSimEventBuilder(LCSimEventBuilder eventBuilder) {
         this.eventBuilder = eventBuilder;
         return this;
     }

+    /**
+     * Set the name of the detector definition to be used e.g. from detector-data/detectors dir. 
+     * @param detectorName The name of the detector.
+     * @return This object.
+     */

     public CompositeLoopConfiguration setDetectorName(String detectorName) {
         this.detectorName = detectorName;
         return this;
     }

+    /**
+     * Set whether the loop will stop when event processing errors occur.
+     * Certain types of errors are considered fatal or are used to control
+     * the loop and will never be ignored (e.g. ET system errors, etc.).
+     * @param stopOnErrors True to stop the loop when errors occur.
+     * @return This object.
+     */

     public CompositeLoopConfiguration setStopOnErrors(boolean stopOnErrors) {
         this.stopOnErrors = stopOnErrors;
         return this;
     }

+    /**
+     * Set whether loop will stop when an end of run record is encountered
+     * e.g. from an EvioEvent.
+     * @param stopOnEndRun True to stop on end of run.
+     * @return This object.
+     */

     public CompositeLoopConfiguration setStopOnEndRun(boolean stopOnEndRun) {
         this.stopOnEndRun = stopOnEndRun;
         return this;
     }

+    /**
+     * Set the maximum number of records to run.
+     * @param maxRecords
+     * @return
+     */

     public CompositeLoopConfiguration setMaxRecords(int maxRecords) {
         if (maxRecords < 1)
             throw new IllegalArgumentException("Invalid maxRecords value: " + maxRecords);

Commit in `java/trunk/record-util/src/main/java/org/hps/record` on MAIN
`AbstractRecordProcessor.java`		-1	953 -> 954
`AbstractRecordQueue.java`	+3	-1	953 -> 954
`EndRunException.java`	+4		953 -> 954
`MaxRecordsException.java`	+6	-1	953 -> 954
`RecordProcessingException.java`	+5	-1	953 -> 954
`RecordProcessor.java`	+5	-1	953 -> 954
`composite/CompositeLoop.java`	+54	-3	953 -> 954
`/CompositeLoopAdapter.java`	+3	-2	953 -> 954
`/CompositeLoopConfiguration.java`	+72	-5	953 -> 954
`/CompositeRecord.java`	+3	-1	953 -> 954
`/EventProcessingThread.java`	+4	-5	953 -> 954
	+159	-21