Changeset 106 for trunk/corelib/src/org/bridgedb/rdb/DBConnector.java

Timestamp:

07/19/09 19:24:43 (3 years ago)

Author:

martijn

Message:

Fixed style and javadoc issues

Files:

• trunk/corelib/src/org/bridgedb/rdb/DBConnector.java (modified) (7 diffs)

trunk/corelib/src/org/bridgedb/rdb/DBConnector.java

@@ -42 +42 @@
         
         /**
-         * Type for gene database
+         * Type for gene database.
          */
         public static final int TYPE_GDB = 0;
         /**
-         * Type for expression database
+         * Type for expression database.
          */
         public static final int TYPE_GEX = 1;
@@ -53 +53 @@
         
         /**
-         * Close the given connection
+         * Close the given connection.
          * @param con The connection to be closed
-         * @throws Exception
+         * @throws IDMapperException when there was a database error
          */
         public void closeConnection(Connection con) throws IDMapperException 
@@ -63 +63 @@
         
         /**
-         * Close the given connection, and optionally finalize it after creation (using {@link #PROP_FINALIZE})
+         * Close the given connection, and optionally finalize it after creation (using {@link #PROP_FINALIZE}).
          * @param con The connection to be closed
          * @param props Close properties (one of {@link #PROP_NONE}, {@link #PROP_FINALIZE} or {@link #PROP_RECREATE})
-         * @throws Exception
+         * @throws IDMapperException when there was a database error
          */
         public void closeConnection(Connection con, int props) throws IDMapperException 
@@ -83 +83 @@
 
         /**
-         * Set the database type (one of {@link #TYPE_GDB} or {@link #TYPE_GEX})
+         * Set the database type (one of {@link #TYPE_GDB} or {@link #TYPE_GEX}).
          * @param type The type of the database that will be used for this class
          */
@@ -89 +89 @@
         
         /**
-         * Get the database type (one of {@link #TYPE_GDB} or {@link #TYPE_GEX})
-         * return The type of the database that is used for this class
+         * Get the database type (one of {@link #TYPE_GDB} or {@link #TYPE_GEX}).
+         * @return The type of the database that is used for this class
          */
         public int getDbType() { return dbType; }
         
-
-                
         /**
          * This method is called to finalize the given database after creation
@@ -103 +101 @@
          * The database connection needs to be closed before running this method.
          * @param dbName The name of the database to finalize   
-         * @throws Exception
          * @return The name of the finalized database
+         * @throws IDMapperException when there was a database error
          */
         public abstract String finalizeNewDatabase(String dbName) throws IDMapperException;
@@ -113 +111 @@
          * after all data is added to the database.
          * @param con A connection to the database
-         * @throws SQLException
+         * @throws IDMapperException when there was a database error
          */
         public void compact(Connection con) throws IDMapperException