Merge pull request #70 from JeffersonLab/iss69

Add TI time offset to conditions system

Author: mholtrop

conditions/src/main/java/org/hps/conditions/database/DatabaseConditionsManager.java

@@ -947,7 +947,7 @@ private void registerConverters() {
      * @return the <code>ResultSet</code> from the query
      * @throws RuntimeException if there is a query error
      */
-    ResultSet selectQuery(final String query) {
+    public ResultSet selectQuery(final String query) {
         LOGGER.fine("executing SQL select query ..." + '\n' + query);
         ResultSet result = null;
         Statement statement = null;

conditions/src/main/java/org/hps/conditions/database/DatabaseUtilities.java

@@ -16,7 +16,7 @@ public final class DatabaseUtilities {
      *
      * @param resultSet the database <code>ResultSet</code>
      */
-    static void cleanup(final ResultSet resultSet) {
+    public static void cleanup(final ResultSet resultSet) {
         Statement statement = null;
         try {
             statement = resultSet.getStatement();

conditions/src/main/java/org/hps/conditions/trigger/TiTimeOffset.java

@@ -0,0 +1,33 @@
+package org.hps.conditions.trigger;
+
+import org.hps.conditions.api.BaseConditionsObject;
+import org.hps.conditions.api.BaseConditionsObjectCollection;
+import org.hps.conditions.database.Converter;
+import org.hps.conditions.database.Table;
+
+/**
+ * <p>
+ * Represents the per-run trigger time offset in nanoseconds.
+ * </p>
+ * <p>
+ * A single instance of this class is returned for an entire run.
+ * </p>
+ */
+@Table(names = {"ti_time_offsets"})
+@Converter(converter = TiTimeOffsetConverter.class)
+public class TiTimeOffset extends BaseConditionsObject {
+    
+    // FIXME: This is not actually used but it is here to make the conditions manager happy.
+    public static class TiTimeOffsetCollection extends BaseConditionsObjectCollection<TiTimeOffset> {
+    }
+    
+    private Long value = null;
+    
+    TiTimeOffset(Long value) {
+        this.value = value;
+    }
+    
+    public Long getValue() {
+        return value;
+    }
+}

conditions/src/main/java/org/hps/conditions/trigger/TiTimeOffsetConverter.java

@@ -0,0 +1,49 @@
+package org.hps.conditions.trigger;
+
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
+import org.hps.conditions.database.AbstractConditionsObjectConverter;
+import org.hps.conditions.database.DatabaseConditionsManager;
+import org.hps.conditions.database.DatabaseUtilities;
+import org.lcsim.conditions.ConditionsManager;
+
+public class TiTimeOffsetConverter extends AbstractConditionsObjectConverter<TiTimeOffset> {
+
+    public TiTimeOffset getData(final ConditionsManager manager, final String name) {
+
+        final DatabaseConditionsManager databaseConditionsManager = DatabaseConditionsManager.getInstance();
+
+        // Setup connection if necessary.
+        boolean reopenedConnection = false;
+        if (!databaseConditionsManager.isConnected()) {
+            databaseConditionsManager.openConnection();
+            reopenedConnection = true;
+        }
+
+        final String query = "SELECT ti_time_offset from ti_time_offsets WHERE run = " + manager.getRun();
+        final ResultSet resultSet = databaseConditionsManager.selectQuery(query);
+        TiTimeOffset t = null;
+        try {
+            if (resultSet.next()) {
+                t = new TiTimeOffset(resultSet.getLong(1));
+            } else {
+                throw new RuntimeException("No TiTimeOffset condition exists for run " + manager.getRun());
+            }
+        } catch (SQLException e) {
+            throw new RuntimeException(e);
+        }
+
+        DatabaseUtilities.cleanup(resultSet);
+
+        if (reopenedConnection) {
+            databaseConditionsManager.closeConnection();
+        }
+
+        return t;
+    }
+    
+    public Class<TiTimeOffset> getType() {
+        return TiTimeOffset.class;
+    }
+}

conditions/src/test/java/org/hps/conditions/trigger/TiTimeOffsetTest.java

@@ -0,0 +1,29 @@
+package org.hps.conditions.trigger;
+
+import junit.framework.TestCase;
+
+import org.hps.conditions.database.DatabaseConditionsManager;
+import org.lcsim.conditions.ConditionsManager.ConditionsNotFoundException;
+
+public final class TiTimeOffsetTest extends TestCase {
+
+    private static final int RUN_NUMBER = 5772;
+
+    private static DatabaseConditionsManager conditionsManager;
+
+    public void setUp() {
+        conditionsManager = DatabaseConditionsManager.getInstance();
+        try {
+            conditionsManager.setDetector("HPS-PhysicsRun2016-Nominal-v4-4", RUN_NUMBER);
+        } catch (final ConditionsNotFoundException e) {
+            throw new RuntimeException(e);
+        }
+    }
+
+    public void testTiTimeOffset() {
+        System.out.println("Loading TI time offset for run " + conditionsManager.getRun());
+        final TiTimeOffset t = 
+                conditionsManager.getCachedConditions(TiTimeOffset.class, "ti_time_offsets").getCachedData();
+        System.out.println("run " + RUN_NUMBER + "; ti_time_offset = " + t.getValue());
+    }
+}

evio/pom.xml

@@ -19,10 +19,6 @@
       <groupId>org.hps</groupId>
       <artifactId>hps-job</artifactId>
     </dependency>
-    <dependency>
-      <groupId>org.hps</groupId>
-      <artifactId>hps-run-database</artifactId>
-    </dependency>
     <dependency>
       <groupId>org.hps</groupId>
       <artifactId>hps-tracking</artifactId>

evio/src/main/java/org/hps/evio/LCSimEngRunEventBuilder.java

@@ -5,6 +5,7 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import org.hps.conditions.trigger.TiTimeOffset;
 import org.hps.record.epics.EpicsData;
 import org.hps.record.epics.EpicsEvioProcessor;
 import org.hps.record.evio.EvioEventUtilities;
@@ -17,9 +18,9 @@
 import org.hps.record.triggerbank.SSPData;
 import org.hps.record.triggerbank.TDCData;
 import org.hps.record.triggerbank.TIData;
-import org.hps.rundb.RunManager;
 import org.jlab.coda.jevio.EvioEvent;
 import org.lcsim.conditions.ConditionsEvent;
+import org.lcsim.conditions.ConditionsManager;
 import org.lcsim.event.EventHeader;
 
 /**
@@ -99,38 +100,11 @@ public void conditionsChanged(final ConditionsEvent conditionsEvent) {
         svtEventFlagger.initialize();
 
         // Set TI time offset from run database.
-        setTiTimeOffsetForRun(conditionsEvent.getConditionsManager().getRun());
+        ConditionsManager mgr = conditionsEvent.getConditionsManager();
+        TiTimeOffset t = mgr.getCachedConditions(TiTimeOffset.class, "ti_time_offsets").getCachedData();
+        currentTiTimeOffset = t.getValue();
     }
 
-    /**
-     * Get TI time offset from the run database, if available.
-     * @param run the run number
-     */
-    private void setTiTimeOffsetForRun(int run) {
-        currentTiTimeOffset = null;
-        RunManager runManager = RunManager.getRunManager();
-        if (runManager.getRun() != null) {
-            if (runManager.runExists()) {
-                currentTiTimeOffset = runManager.getRunSummary().getTiTimeOffset();
-                LOGGER.info("TI time offset set to " + currentTiTimeOffset + " for run "
-                        + run + " from database");
-            } else {
-                LOGGER.warning("Run " + run 
-                        + " does not exist in the run database.");
-            }
-        } else {
-            LOGGER.info("Run manager is not initialized; TI time offset not available.");
-        }
-        /* Make sure connection is closed immediately. --JM */
-        try {
-            LOGGER.info("Closing run manager db connection ...");
-            RunManager.getRunManager().closeConnection();
-            LOGGER.info("Run manager db connection was closed.");
-        } catch (Exception e) {
-            e.printStackTrace();
-        }
-    }
-
     /**
      * Get the time from the TI data with time offset applied from run database.
      *

run-database/src/main/java/org/hps/rundb/RunManager.java

@@ -1,6 +1,5 @@
 package org.hps.rundb;
 
-import java.io.File;
 import java.sql.Connection;
 import java.sql.SQLException;
 import java.util.List;
@@ -22,11 +21,6 @@
  * @author jeremym
  */
 public final class RunManager implements ConditionsListener {
-
-    /**
-     * Name of system property that can be used to specify custom database connection parameters.
-     */
-    private static final String CONNECTION_PROPERTY_FILE = "org.hps.conditions.connection.file";
 
     /**
      * The default connection parameters for read-only access to the run database.
@@ -95,20 +89,7 @@ public RunManager(final Connection connection) {
     /**
      * Class constructor using default connection parameters.
      */
-    public RunManager() {
-        
-        /**
-         * Read database URL from system prop setting.
-         * The database, password and user from that file are overridden.
-         */
-        if (System.getProperties().get(CONNECTION_PROPERTY_FILE) != null) {
-            final String propFile = (String) System.getProperties().get(CONNECTION_PROPERTY_FILE);
-            this.connectionParameters = ConnectionParameters.fromProperties(new File(propFile));
-            this.connectionParameters.setDatabase("hps_run_db_v2");
-            this.connectionParameters.setPassword("darkphoton");
-            this.connectionParameters.setUser("hpsuser");
-            
-        }        
+    public RunManager() {        
         this.connection = this.connectionParameters.createConnection();
         factory = new DaoProvider(this.connection);
         LOGGER.log(Level.INFO, this.connectionParameters.toString());