jvadoc/override

[cdmlib.git] / cdmlib-persistence / src / main / java / eu / etaxonomy / cdm / database / ICdmDataSource.java

diff --git a/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/database/ICdmDataSource.java b/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/database/ICdmDataSource.java
index 099f103b5de9cee1f08ed34d2b398b8cfb51437a..60c6fe2565bba049605809248537ad94580624ca 100644 (file)
--- a/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/database/ICdmDataSource.java
+++ b/cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/database/ICdmDataSource.java
@@ -56,10 +56,16 @@ public interface ICdmDataSource {
        public String getServer();\r
 \r
        /**\r
+        * Returns the name of the datasource on the given server.\r
         * @return\r
         */\r
        public String getDatabase();\r
        \r
+       /**\r
+        * Returns the database type of the data source. \r
+        * @return the database type of the data source. \r
+        * <code>null</code> if the bean or the driver class property does not exist or the driver class is unknown.\r
+        */\r
        public DatabaseTypeEnum getDatabaseType();\r
        \r
        /**\r
@@ -125,7 +131,9 @@ public interface ICdmDataSource {
        public NomenclaturalCode getNomenclaturalCode();\r
 \r
        /**\r
-        * Returns a single the first value of a row of a resultset.\r
+        * Returns the first value of the first row of a result set.<BR>\r
+        * If no row exists in the result set\r
+        * <code>null</code> is returned.\r
         * \r
         * <strong>Caution</strong> This method opens a connection on first use. Subsequent calls will use the same connection.\r
         * Please close the connection when not needed anymore with {@link ICdmDataSource#closeOpenConnections()}\r