Changeset 71 for trunk/CrossPare/src/de

Timestamp:

05/04/16 10:52:04 (8 years ago)

Author:

sherbold

Message:

• MySQL result storage can now work with credential files
• code documentation

Location:

trunk/CrossPare/src/de/ugoe/cs/cpdp/eval

Files:

• IResultStorage.java (modified) (1 diff)
• MySQLResultStorage.java (modified) (5 diffs)

trunk/CrossPare/src/de/ugoe/cs/cpdp/eval/IResultStorage.java

@@ +1 @@
+// Copyright 2015 Georg-August-Universit�t G�ttingen, Germany
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
 package de.ugoe.cs.cpdp.eval;
 
+/**
+ * <p>
+ * Interface for result storages.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ */
 public interface IResultStorage {
 
+    /**
+     * <p>
+     * Stores a new experiment result
+     * </p>
+     *
+     * @param result
+     *            result to be stored
+     */
     public void addResult(ExperimentResult result);
-    
+
+    /**
+     * <p>
+     * Checks if a result is already contained in the storage.
+     * </p>
+     *
+     * @param experimentName
+     *            name of the experiment
+     * @param productName
+     *            name of the product
+     * @return true of the results ofr the given product and experiment are contained in the result
+     *         storage
+     */
     public boolean containsResult(String experimentName, String productName);
 }

trunk/CrossPare/src/de/ugoe/cs/cpdp/eval/MySQLResultStorage.java

@@ +1 @@
+// Copyright 2015 Georg-August-Universit�t G�ttingen, Germany
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
 
 package de.ugoe.cs.cpdp.eval;
 
+import java.io.FileInputStream;
+import java.io.IOException;
 import java.sql.Connection;
 import java.sql.DriverManager;
@@ -7 +22 @@
 import java.sql.SQLException;
 import java.sql.Statement;
+import java.util.Properties;
 
+import de.lmu.ifi.dbs.elki.logging.Logging.Level;
 import de.ugoe.cs.util.console.Console;
 
+/**
+ * <p>
+ * Implements a storage of experiment results in a MySQL database.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ */
 public class MySQLResultStorage implements IResultStorage {
+
+    /**
+     * Connection to the database
+     */
     private Connection con = null;
-    
+
+    /**
+     * <p>
+     * Creates a new results storage. Tries to read a properties file mysql.cred located in the
+     * working directory. If this file is not found, the default database configuration is used:
+     * <ul>
+     * <li>dbHost = localhost</li>
+     * <li>dbPort = 3306</li>
+     * <li>dbName = crosspare</li>
+     * <li>dbUser = crosspare</li>
+     * <li>dbPass = benchmark</li>
+     * </p>
+     */
     public MySQLResultStorage() {
-        this("localhost", "3306", "crosspare", "crosspare", "benchmark");
+        Properties dbProperties = new Properties();
+        try {
+            dbProperties.load(new FileInputStream("mysql.cred"));
+        }
+        catch (IOException e) {
+            Console.printerr("Could not load mysql.cred file: " + e.getMessage());
+            Console.printerr("Must be a properties file located in working directory.");
+            Console
+                .traceln(Level.WARNING,
+                         "Using default DB configuration since mysql.cred file could not be loaded");
+        }
+        String dbHost = dbProperties.getProperty("db.host", "localhost");
+        String dbPort = dbProperties.getProperty("db.port", "3306");
+        String dbName = dbProperties.getProperty("db.name", "crosspare");
+        String dbUser = dbProperties.getProperty("db.user", "crosspare");
+        String dbPass = dbProperties.getProperty("db.pass", "benchmark");
+        connectToDB(dbHost, dbPort, dbName, dbUser, dbPass);
     }
-    
-    public MySQLResultStorage(String dbHost, String dbPort, String dbName, String dbUser, String dbPass) {
+
+    /**
+     * <p>
+     * Sets up the database connection
+     * </p>
+     *
+     * @param dbHost
+     *            host of the database
+     * @param dbPort
+     *            port of the database
+     * @param dbName
+     *            name of the database
+     * @param dbUser
+     *            user of the database
+     * @param dbPass
+     *            password of the user
+     */
+    private void connectToDB(String dbHost,
+                             String dbPort,
+                             String dbName,
+                             String dbUser,
+                             String dbPass)
+    {
         try {
             Class.forName("com.mysql.jdbc.Driver");
             con = DriverManager.getConnection("jdbc:mysql://" + dbHost + ":" + dbPort + "/" +
-                    dbName + "?" + "user=" + dbUser + "&" + "password=" + dbPass);
+                dbName + "?" + "user=" + dbUser + "&" + "password=" + dbPass);
         }
         catch (ClassNotFoundException e) {
@@ -34 +111 @@
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see de.ugoe.cs.cpdp.eval.IResultStorage#addResult(de.ugoe.cs.cpdp.eval.ExperimentResult)
+     */
+    @Override
     public void addResult(ExperimentResult result) {
         StringBuilder sql = new StringBuilder();
         sql.append("INSERT INTO crosspare.results VALUES (NULL,");
-        sql.append("\'" + result.getConfigurationName()+"\',");
-        sql.append("\'" + result.getProductName()+"\',");
-        sql.append("\'" + result.getClassifier()+"\',");
-        sql.append(result.getSizeTestData()+",");
-        sql.append(result.getSizeTrainingData()+",");
-        sql.append(result.getSuccHe()+",");
-        sql.append(result.getSuccZi()+",");
-        sql.append(result.getSuccG75()+",");
-        sql.append(result.getSuccG60()+",");
-        sql.append(result.getError()+",");
-        sql.append(result.getRecall()+",");
-        sql.append(result.getPrecision()+",");
-        sql.append(result.getFscore()+",");
-        sql.append(result.getGscore()+",");
-        sql.append(result.getMcc()+",");
-        sql.append(result.getAuc()+",");
-        sql.append(result.getAucec()+",");
-        sql.append(result.getTpr()+",");
-        sql.append(result.getTnr()+",");
-        sql.append(result.getFpr()+",");
-        sql.append(result.getFnr()+",");
-        sql.append(result.getTp()+",");
-        sql.append(result.getFn()+",");
-        sql.append(result.getTn()+",");
-        sql.append(result.getFp()+");");
-        
+        sql.append("\'" + result.getConfigurationName() + "\',");
+        sql.append("\'" + result.getProductName() + "\',");
+        sql.append("\'" + result.getClassifier() + "\',");
+        sql.append(result.getSizeTestData() + ",");
+        sql.append(result.getSizeTrainingData() + ",");
+        sql.append(result.getSuccHe() + ",");
+        sql.append(result.getSuccZi() + ",");
+        sql.append(result.getSuccG75() + ",");
+        sql.append(result.getSuccG60() + ",");
+        sql.append(result.getError() + ",");
+        sql.append(result.getRecall() + ",");
+        sql.append(result.getPrecision() + ",");
+        sql.append(result.getFscore() + ",");
+        sql.append(result.getGscore() + ",");
+        sql.append(result.getMcc() + ",");
+        sql.append(result.getAuc() + ",");
+        sql.append(result.getAucec() + ",");
+        sql.append(result.getTpr() + ",");
+        sql.append(result.getTnr() + ",");
+        sql.append(result.getFpr() + ",");
+        sql.append(result.getFnr() + ",");
+        sql.append(result.getTp() + ",");
+        sql.append(result.getFn() + ",");
+        sql.append(result.getTn() + ",");
+        sql.append(result.getFp() + ");");
+
         Statement stmt;
         try {
@@ -76 +159 @@
         }
     }
-    
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see de.ugoe.cs.cpdp.eval.IResultStorage#containsResult(java.lang.String, java.lang.String)
+     */
     @Override
     public boolean containsResult(String experimentName, String productName) {
-        String sql = "SELECT COUNT(*) as cnt FROM crosspare.results WHERE configurationName=\'" + experimentName + "\' AND productName=\'" + productName + "\';";
+        String sql = "SELECT COUNT(*) as cnt FROM crosspare.results WHERE configurationName=\'" +
+            experimentName + "\' AND productName=\'" + productName + "\';";
         Statement stmt;
         boolean contained = false;
@@ -87 +176 @@
             results.next();
             int count = results.getInt("cnt");
-            contained = count>0;
+            contained = count > 0;
         }
         catch (SQLException e) {