changeset 820:8288f4a0d7e6

Added more Javadoc. gnv-artifacts/trunk@906 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Mon, 12 Apr 2010 13:23:18 +0000
parents 6925d18580c0
children 9b41dbe92d9d
files gnv-artifacts/ChangeLog gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataServiceException.java gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/package.html
diffstat 4 files changed, 30 insertions(+), 26 deletions(-) [+]
line wrap: on
line diff
--- a/gnv-artifacts/ChangeLog	Mon Apr 12 13:12:21 2010 +0000
+++ b/gnv-artifacts/ChangeLog	Mon Apr 12 13:23:18 2010 +0000
@@ -1,3 +1,10 @@
+2010-04-12  Tim Englich  <tim.englich@intevation.de>
+
+	* src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java: 
+	* src/main/java/de/intevation/gnv/artifacts/services/MetaDataServiceException.java (MetaDataServiceException): 
+	* src/main/java/de/intevation/gnv/artifacts/services/package.html:
+	  Added more Javadoc.
+
 2010-04-12  Tim Englich  <tim.englich@intevation.de>
 
 	* src/main/java/de/intevation/gnv/layer/package.html,
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java	Mon Apr 12 13:12:21 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataService.java	Mon Apr 12 13:23:18 2010 +0000
@@ -1,17 +1,26 @@
 package de.intevation.gnv.artifacts.services;
 
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Iterator;
+
+import javax.xml.xpath.XPathConstants;
+
+import org.apache.log4j.Logger;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+
 import com.vividsolutions.jts.geom.Geometry;
-
 import com.vividsolutions.jts.io.ParseException;
 import com.vividsolutions.jts.io.WKTReader;
 
 import de.intevation.artifactdatabase.DefaultService;
 import de.intevation.artifactdatabase.XMLUtils;
-
 import de.intevation.artifacts.ArtifactNamespaceContext;
 import de.intevation.artifacts.CallMeta;
 import de.intevation.artifacts.ServiceFactory;
-
 import de.intevation.gnv.artifacts.services.requestobjects.DefaultFIS;
 import de.intevation.gnv.artifacts.services.requestobjects.DefaultLayer;
 import de.intevation.gnv.artifacts.services.requestobjects.DefaultMapService;
@@ -20,30 +29,20 @@
 import de.intevation.gnv.artifacts.services.requestobjects.Layer;
 import de.intevation.gnv.artifacts.services.requestobjects.MapService;
 import de.intevation.gnv.artifacts.services.requestobjects.Parameter;
-
 import de.intevation.gnv.geobackend.base.Result;
-
 import de.intevation.gnv.geobackend.base.query.QueryExecutor;
 import de.intevation.gnv.geobackend.base.query.QueryExecutorFactory;
-
 import de.intevation.gnv.geobackend.base.query.exception.QueryException;
-
 import de.intevation.gnv.utils.ArtifactXMLUtilities;
 
-import java.util.ArrayList;
-import java.util.Collection;
-import java.util.Iterator;
-
-import javax.xml.xpath.XPathConstants;
-
-import org.apache.log4j.Logger;
-
-import org.w3c.dom.Document;
-import org.w3c.dom.Element;
-import org.w3c.dom.Node;
-import org.w3c.dom.NodeList;
-
 /**
+ * This Class Provides the Functionality to return only those 
+ * Artifacfactories which fulfill the conditions of the Request.
+ * 
+ * This Service is used to implement the Functionality of the MV-GNV-Interface 
+ * by looking if an Region of an FIS is intersecting the Area which is send 
+ * during the Request or which FIS belongs to the requested MapServices.
+ * 
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
@@ -443,11 +442,6 @@
         return returnValue;
     }
 
-    /**
-     * @param factory
-     * @param globalContext
-     * @see de.intevation.artifactdatabase.DefaultService#setup(de.intevation.artifacts.ServiceFactory, java.lang.Object)
-     */
     @Override
     public void setup(ServiceFactory factory, Object globalContext) {
         log.debug("MetaDataService.setup");
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataServiceException.java	Mon Apr 12 13:12:21 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/MetaDataServiceException.java	Mon Apr 12 13:23:18 2010 +0000
@@ -1,6 +1,7 @@
 package de.intevation.gnv.artifacts.services;
 
 /**
+ * ExceprionClass for MetaDataServices.
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/package.html	Mon Apr 12 13:12:21 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/package.html	Mon Apr 12 13:23:18 2010 +0000
@@ -3,6 +3,8 @@
 <head>
 </head>
 <body>
-DOCUMENT ME!
+This package provides Classes which Implements the Interface 
+de.intevation.artifactdatabase.Service
+to provide different Services offered by the ArtifactDatabase.
 </body>
 </html>

http://dive4elements.wald.intevation.org