changeset 891:a277ebde74e4

Added more JavaDoc geo-backend/trunk@917 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 13 Apr 2010 11:28:47 +0000
parents e9ca6be4dbd2
children 6ae8cd579184
files geo-backend/ChangeLog geo-backend/src/main/java/de/intevation/gnv/geobackend/base/connectionpool/exception/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/base/connectionpool/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/base/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/QueryContainer.java geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/QueryContainerFactory.java geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/exception/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/exception/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/connectionpool/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/datasources/exception/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/datasources/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/package.html geo-backend/src/main/java/de/intevation/gnv/geobackend/util/package.html
diffstat 14 files changed, 45 insertions(+), 16 deletions(-) [+]
line wrap: on
line diff
--- a/geo-backend/ChangeLog	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/ChangeLog	Tue Apr 13 11:28:47 2010 +0000
@@ -1,3 +1,20 @@
+2010-04-13  Tim Englich  <tim.englich@intevation.de>
+
+	* src/main/java/de/intevation/gnv/geobackend/util/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/sde/datasources/exception/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/sde/datasources/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/sde/connectionpool/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/sde/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/base/query/exception/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/base/query/container/exception/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/base/query/container/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/base/query/container/QueryContainerFactory.java, 
+	  src/main/java/de/intevation/gnv/geobackend/base/query/container/QueryContainer.java,
+	  src/main/java/de/intevation/gnv/geobackend/base/connectionpool/exception/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/base/connectionpool/package.html,
+	  src/main/java/de/intevation/gnv/geobackend/base/package.html: 
+	  Added more Javadoc.
+
 2010-04-13  Tim Englich  <tim.englich@intevation.de>
 
 	* src/main/java/de/intevation/gnv/geobackend/util/DateUtils.java,
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/connectionpool/exception/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/connectionpool/exception/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,6 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+Package that contains Exceptionclasses for it's Parentpackage.
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/connectionpool/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/connectionpool/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,7 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+This package contains Classes that provides an <code>ConnectionPool</code>
+for <code>java.sql.Connection</code>-Objects
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,7 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+This package contains Interfaces and Classes to provide Access to Data without
+using an <code>java.sql.ResultSet</code>-object in the Code that use this Module.
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/QueryContainer.java	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/QueryContainer.java	Tue Apr 13 11:28:47 2010 +0000
@@ -1,10 +1,12 @@
 package de.intevation.gnv.geobackend.base.query.container;
 
+import java.util.Properties;
+
 import de.intevation.gnv.geobackend.base.query.container.exception.QueryContainerException;
 
-import java.util.Properties;
-
 /**
+ * Querycontainer is an Interface which defines the Method that are
+ * required to provide the access to SQL-Queries.
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/QueryContainerFactory.java	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/QueryContainerFactory.java	Tue Apr 13 11:28:47 2010 +0000
@@ -1,14 +1,15 @@
 package de.intevation.gnv.geobackend.base.query.container;
 
-import de.intevation.gnv.geobackend.base.query.container.exception.QueryContainerException;
-
 import java.util.Properties;
 
 import org.apache.log4j.Logger;
 
+import de.intevation.gnv.geobackend.base.query.container.exception.QueryContainerException;
+
 /**
+ * Factoryclass to provide a singleton-Instance of an 
+ * <code>QueryContainer</code>-Object
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
- *
  */
 public class QueryContainerFactory {
 
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/exception/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/exception/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,6 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+Package that contains Exceptionclasses for it's Parentpackage.
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/container/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,7 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+This package contains Classes which provide the Access to SQL-Queries which
+are stored in an separate Resource-File (e.g. an Propertiesfile).
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/exception/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/base/query/exception/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,6 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+Package that contains Exceptionclasses for it's Parentpackage.
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/connectionpool/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/connectionpool/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,7 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+This package contains Classes that provides an <code>ConnectionPool</code>
+for <code>ArcSDEConnection</code>-Objects.
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/datasources/exception/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/datasources/exception/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,6 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+Package that contains Exceptionclasses for it's Parentpackage.
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/datasources/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/datasources/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,10 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+This package contains Classes that Wrapps an ArcSDEConnection into a 
+<code>java.sql.Connection</code>.
+All other required Wrapper-Classes 
+(e.g Statements,ResultSet, ResultSetMetadata) 
+are also available in the package.
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/sde/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,7 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+This package and it's subpackages contains Classes for the DataAccess to
+the ArcSDE-Databasebackend.
 </body>
 </html>
--- a/geo-backend/src/main/java/de/intevation/gnv/geobackend/util/package.html	Tue Apr 13 09:37:59 2010 +0000
+++ b/geo-backend/src/main/java/de/intevation/gnv/geobackend/util/package.html	Tue Apr 13 11:28:47 2010 +0000
@@ -3,6 +3,6 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+Package that contains utility-Classes for this Module
 </body>
 </html>

http://dive4elements.wald.intevation.org