From 3442a51457777ed4236a208e4ec971261622449a Mon Sep 17 00:00:00 2001
From: Michael Bayne <mdb@samskivert.com>
Date: Fri, 24 May 2013 10:43:37 -0700
Subject: [PATCH] Added a Log for JDBC code; info -> debug for HSQL liaison.

---
 .../java/com/samskivert/jdbc/BaseLiaison.java | 26 ++++++++++---------
 .../jdbc/DataSourceConnectionProvider.java    |  2 +-
 .../com/samskivert/jdbc/HsqldbLiaison.java    | 11 +++++---
 .../java/com/samskivert/jdbc/JDBCUtil.java    |  2 +-
 .../com/samskivert/jdbc/LiaisonRegistry.java  |  2 +-
 src/main/java/com/samskivert/jdbc/Log.java    | 15 +++++++++++
 .../com/samskivert/jdbc/MySQLLiaison.java     |  8 +++---
 .../samskivert/jdbc/PostgreSQLLiaison.java    |  8 +++---
 .../com/samskivert/jdbc/SimpleRepository.java |  2 +-
 .../jdbc/StaticConnectionProvider.java        |  2 +-
 .../samskivert/jdbc/TransitionRepository.java |  2 +-
 .../com/samskivert/jdbc/WriteOnlyUnit.java    |  2 +-
 .../java/com/samskivert/jdbc/jora/Cursor.java |  2 +-
 13 files changed, 51 insertions(+), 33 deletions(-)
 create mode 100644 src/main/java/com/samskivert/jdbc/Log.java

diff --git a/src/main/java/com/samskivert/jdbc/BaseLiaison.java b/src/main/java/com/samskivert/jdbc/BaseLiaison.java
index c21eda28..b5327dbc 100644
--- a/src/main/java/com/samskivert/jdbc/BaseLiaison.java
+++ b/src/main/java/com/samskivert/jdbc/BaseLiaison.java
@@ -14,8 +14,6 @@ import java.util.List;
 
 import com.samskivert.util.StringUtil;
 
-import static com.samskivert.Log.log;
-
 /**
  * A superclass to help with the shrinking subset of SQL our supported dialects can agree on,
  * or when there is disagreement, implement the most standard-compliant version and let the
@@ -106,7 +104,7 @@ public abstract class BaseLiaison implements DatabaseLiaison
         update.append(")");
 
         executeQuery(conn, update.toString());
-        log.info("Database index '" + ixName + "' added to table '" + table + "'");
+        log("Database index '" + ixName + "' added to table '" + table + "'");
         return true;
     }
 
@@ -120,7 +118,7 @@ public abstract class BaseLiaison implements DatabaseLiaison
         String update = "ALTER TABLE " + tableSQL(table) + " ADD PRIMARY KEY " + fields.toString();
 
         executeQuery(conn, update);
-        log.info("Primary key " + fields + " added to table '" + table + "'");
+        log("Primary key " + fields + " added to table '" + table + "'");
     }
 
     // from DatabaseLiaison
@@ -146,7 +144,7 @@ public abstract class BaseLiaison implements DatabaseLiaison
 
         executeQuery(conn, "ALTER TABLE " + tableSQL(table) + " ADD COLUMN " +
                      columnSQL(column) + " " + definition);
-        log.info("Database column '" + column + "' added to table '" + table + "'.");
+        log("Database column '" + column + "' added to table '" + table + "'.");
         return true;
     }
 
@@ -161,7 +159,7 @@ public abstract class BaseLiaison implements DatabaseLiaison
 
         executeQuery(conn, "ALTER TABLE " + tableSQL(table) + " ADD COLUMN " +
                      columnSQL(column) + " " + expandDefinition(newColumnDef));
-        log.info("Database column '" + column + "' added to table '" + table + "'.");
+        log("Database column '" + column + "' added to table '" + table + "'.");
         return true;
     }
 
@@ -175,8 +173,8 @@ public abstract class BaseLiaison implements DatabaseLiaison
 
         executeQuery(conn, "ALTER TABLE " + tableSQL(table) + " CHANGE " +
                      columnSQL(column) + " " + columnSQL(column) + " " + defStr);
-        log.info("Database column '" + column + "' of table '" + table + "' modified to have " +
-                 "definition '" + defStr + "'.");
+        log("Database column '" + column + "' of table '" + table + "' modified to have " +
+            "definition '" + defStr + "'.");
         return true;
     }
 
@@ -186,7 +184,7 @@ public abstract class BaseLiaison implements DatabaseLiaison
     {
         executeQuery(conn, "ALTER TABLE " + tableSQL(table) + " RENAME COLUMN " +
                      columnSQL(from) + " TO " + columnSQL(to));
-        log.info("Renamed column '" + from + "' on table '" + table + "' to '" + to + "'");
+        log("Renamed column '" + from + "' on table '" + table + "' to '" + to + "'");
         return true;
     }
 
@@ -206,7 +204,7 @@ public abstract class BaseLiaison implements DatabaseLiaison
             return false;
         }
         executeQuery(conn, "ALTER TABLE " + tableSQL(table) + " DROP COLUMN " + columnSQL(column));
-        log.info("Database column '" + column + "' removed from table '" + table + "'.");
+        log("Database column '" + column + "' removed from table '" + table + "'.");
         return true;
     }
 
@@ -261,7 +259,7 @@ public abstract class BaseLiaison implements DatabaseLiaison
         builder.append(")");
 
         executeQuery(conn, builder.toString());
-        log.info("Database table '" + table + "' created.");
+        log("Database table '" + table + "' created.");
         return true;
     }
 
@@ -272,7 +270,7 @@ public abstract class BaseLiaison implements DatabaseLiaison
             return false;
         }
         executeQuery(conn, "DROP TABLE " + tableSQL(name));
-        log.info("Table '" + name + "' dropped.");
+        log("Table '" + name + "' dropped.");
         return true;
     }
 
@@ -332,4 +330,8 @@ public abstract class BaseLiaison implements DatabaseLiaison
             buf.append(columnSQL(column));
         }
     }
+
+    protected void log (String message) {
+        Log.log.info(message);
+    }
 }
diff --git a/src/main/java/com/samskivert/jdbc/DataSourceConnectionProvider.java b/src/main/java/com/samskivert/jdbc/DataSourceConnectionProvider.java
index bac25aa6..05fc87a4 100644
--- a/src/main/java/com/samskivert/jdbc/DataSourceConnectionProvider.java
+++ b/src/main/java/com/samskivert/jdbc/DataSourceConnectionProvider.java
@@ -11,7 +11,7 @@ import javax.sql.DataSource;
 
 import com.samskivert.io.PersistenceException;
 
-import static com.samskivert.Log.log;
+import static com.samskivert.jdbc.Log.log;
 
 /**
  * Provides connections using a pair of {@link DataSource} instances (one for read-only operations
diff --git a/src/main/java/com/samskivert/jdbc/HsqldbLiaison.java b/src/main/java/com/samskivert/jdbc/HsqldbLiaison.java
index 5e3c721e..1aeb7b1a 100644
--- a/src/main/java/com/samskivert/jdbc/HsqldbLiaison.java
+++ b/src/main/java/com/samskivert/jdbc/HsqldbLiaison.java
@@ -16,8 +16,6 @@ import java.sql.ResultSet;
 import java.sql.Statement;
 import java.sql.SQLException;
 
-import static com.samskivert.Log.log;
-
 /**
  * Handles liaison for HSQLDB.
  */
@@ -64,7 +62,7 @@ public class HsqldbLiaison extends BaseLiaison
         } finally {
             JDBCUtil.close(stmt);
         }
-        log.info("Initial value of " + tableName + ":" + columnName + " set to " + initValue + ".");
+        log("Initial value of " + tableName + ":" + columnName + " set to " + initValue + ".");
     }
 
     @Override // from DatabaseLiaison
@@ -191,4 +189,11 @@ public class HsqldbLiaison extends BaseLiaison
 
         return builder.toString();
     }
+
+    @Override
+    protected void log (String message) {
+        // HSQL is generally used as a test database, so we don't generally want to hear a bunch of
+        // spam about table creation, etc. every time we start up/run tests
+        Log.log.debug(message);
+    }
 }
diff --git a/src/main/java/com/samskivert/jdbc/JDBCUtil.java b/src/main/java/com/samskivert/jdbc/JDBCUtil.java
index be8e90db..71d4d0a2 100644
--- a/src/main/java/com/samskivert/jdbc/JDBCUtil.java
+++ b/src/main/java/com/samskivert/jdbc/JDBCUtil.java
@@ -23,7 +23,7 @@ import java.sql.Statement;
 
 import com.samskivert.io.PersistenceException;
 import com.samskivert.util.StringUtil;
-import static com.samskivert.Log.log;
+import static com.samskivert.jdbc.Log.log;
 
 /**
  * A repository for JDBC related utility functions.
diff --git a/src/main/java/com/samskivert/jdbc/LiaisonRegistry.java b/src/main/java/com/samskivert/jdbc/LiaisonRegistry.java
index f3625219..a391e352 100644
--- a/src/main/java/com/samskivert/jdbc/LiaisonRegistry.java
+++ b/src/main/java/com/samskivert/jdbc/LiaisonRegistry.java
@@ -11,7 +11,7 @@ import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
 
-import static com.samskivert.Log.log;
+import static com.samskivert.jdbc.Log.log;
 
 /**
  * The liaison registry provides access to the appropriate database liaison implementation for a
diff --git a/src/main/java/com/samskivert/jdbc/Log.java b/src/main/java/com/samskivert/jdbc/Log.java
new file mode 100644
index 00000000..51827c89
--- /dev/null
+++ b/src/main/java/com/samskivert/jdbc/Log.java
@@ -0,0 +1,15 @@
+//
+// samskivert library - useful routines for java programs
+// Copyright (C) 2001-2012 Michael Bayne, et al.
+// http://github.com/samskivert/samskivert/blob/master/COPYING
+
+package com.samskivert.jdbc;
+
+import com.samskivert.util.Logger;
+
+/** A log instance for the JDBC code. */
+public class Log {
+
+    /** We dispatch our log messages through this logger. */
+    public static final Logger log = Logger.getLogger("com.samskivert.jdbc");
+}
diff --git a/src/main/java/com/samskivert/jdbc/MySQLLiaison.java b/src/main/java/com/samskivert/jdbc/MySQLLiaison.java
index 1a20e94a..29cff70a 100644
--- a/src/main/java/com/samskivert/jdbc/MySQLLiaison.java
+++ b/src/main/java/com/samskivert/jdbc/MySQLLiaison.java
@@ -8,8 +8,6 @@ package com.samskivert.jdbc;
 import java.sql.*;
 import java.util.List;
 
-import static com.samskivert.Log.log;
-
 /**
  * A database liaison for the MySQL database.
  */
@@ -86,7 +84,7 @@ public class MySQLLiaison extends BaseLiaison
         update.append(")");
 
         executeQuery(conn, update.toString());
-        log.info("Database index '" + ixName + "' added to table '" + table + "'");
+        log("Database index '" + ixName + "' added to table '" + table + "'");
         return true;
     }
 
@@ -112,8 +110,8 @@ public class MySQLLiaison extends BaseLiaison
         }
         executeQuery(conn, "ALTER TABLE " + table + " CHANGE " + oldColumnName + " " +
                      newColumnName + " " + expandDefinition(newColumnDef));
-        log.info("Renamed column '" + oldColumnName + "' on table '" + table + "' to '" +
-                 newColumnName + "'");
+        log("Renamed column '" + oldColumnName + "' on table '" + table + "' to '" +
+            newColumnName + "'");
         return true;
     }
 
diff --git a/src/main/java/com/samskivert/jdbc/PostgreSQLLiaison.java b/src/main/java/com/samskivert/jdbc/PostgreSQLLiaison.java
index e4cf30db..25a8b0d3 100644
--- a/src/main/java/com/samskivert/jdbc/PostgreSQLLiaison.java
+++ b/src/main/java/com/samskivert/jdbc/PostgreSQLLiaison.java
@@ -7,8 +7,6 @@ package com.samskivert.jdbc;
 
 import java.sql.*;
 
-import static com.samskivert.Log.log;
-
 /**
  * A database liaison for the MySQL database.
  */
@@ -68,7 +66,7 @@ public class PostgreSQLLiaison extends BaseLiaison
         } finally {
             JDBCUtil.close(stmt);
         }
-        log.info("Initial value of " + seqname  + " set to " + initValue + ".");
+        log("Initial value of " + seqname  + " set to " + initValue + ".");
     }
 
     // from DatabaseLiaison
@@ -115,8 +113,8 @@ public class PostgreSQLLiaison extends BaseLiaison
             }
             lbuf.append("defaultValue=").append(defaultValue);
         }
-        log.info("Database column '" + column + "' of table '" + table + "' modified to have " +
-                 "definition [" + lbuf + "].");
+        log("Database column '" + column + "' of table '" + table + "' modified to have " +
+            "definition [" + lbuf + "].");
         return true;
     }
 
diff --git a/src/main/java/com/samskivert/jdbc/SimpleRepository.java b/src/main/java/com/samskivert/jdbc/SimpleRepository.java
index cfba460b..fab1312b 100644
--- a/src/main/java/com/samskivert/jdbc/SimpleRepository.java
+++ b/src/main/java/com/samskivert/jdbc/SimpleRepository.java
@@ -10,7 +10,7 @@ import java.sql.*;
 import com.samskivert.io.PersistenceException;
 import com.samskivert.util.StringUtil;
 
-import static com.samskivert.Log.log;
+import static com.samskivert.jdbc.Log.log;
 
 /**
  * The simple repository should be used for a repository that only needs access to a single JDBC
diff --git a/src/main/java/com/samskivert/jdbc/StaticConnectionProvider.java b/src/main/java/com/samskivert/jdbc/StaticConnectionProvider.java
index 646fde1d..1b8a5844 100644
--- a/src/main/java/com/samskivert/jdbc/StaticConnectionProvider.java
+++ b/src/main/java/com/samskivert/jdbc/StaticConnectionProvider.java
@@ -14,7 +14,7 @@ import com.samskivert.util.ConfigUtil;
 import com.samskivert.util.PropertiesUtil;
 import com.samskivert.util.StringUtil;
 
-import static com.samskivert.Log.log;
+import static com.samskivert.jdbc.Log.log;
 
 /**
  * The static connection provider generates JDBC connections based on configuration information
diff --git a/src/main/java/com/samskivert/jdbc/TransitionRepository.java b/src/main/java/com/samskivert/jdbc/TransitionRepository.java
index f48c8fbf..31656bbf 100644
--- a/src/main/java/com/samskivert/jdbc/TransitionRepository.java
+++ b/src/main/java/com/samskivert/jdbc/TransitionRepository.java
@@ -16,7 +16,7 @@ import java.util.List;
 
 import com.samskivert.io.PersistenceException;
 
-import static com.samskivert.Log.log;
+import static com.samskivert.jdbc.Log.log;
 
 /**
  * Used to note that transitionary code has been run to migrate persistent data. This is especially
diff --git a/src/main/java/com/samskivert/jdbc/WriteOnlyUnit.java b/src/main/java/com/samskivert/jdbc/WriteOnlyUnit.java
index 53251d96..dd269f38 100644
--- a/src/main/java/com/samskivert/jdbc/WriteOnlyUnit.java
+++ b/src/main/java/com/samskivert/jdbc/WriteOnlyUnit.java
@@ -7,7 +7,7 @@ package com.samskivert.jdbc;
 
 import com.samskivert.util.Invoker;
 
-import static com.samskivert.Log.log;
+import static com.samskivert.jdbc.Log.log;
 
 /**
  * Extends {@link com.samskivert.util.Invoker.Unit} and specializes it for writing to a database
diff --git a/src/main/java/com/samskivert/jdbc/jora/Cursor.java b/src/main/java/com/samskivert/jdbc/jora/Cursor.java
index 998e69a4..74e45c9f 100644
--- a/src/main/java/com/samskivert/jdbc/jora/Cursor.java
+++ b/src/main/java/com/samskivert/jdbc/jora/Cursor.java
@@ -8,7 +8,7 @@ package com.samskivert.jdbc.jora;
 import java.util.*;
 import java.sql.*;
 
-import static com.samskivert.Log.log;
+import static com.samskivert.jdbc.Log.log;
 
 /**
  * Cursor is used for successive access to records fetched by SELECT statement.