diff gnv-artifacts/src/main/java/de/intevation/gnv/raster/AbstractProducer.java @ 801:d766fe2d917a

More javadoc. gnv-artifacts/trunk@883 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Tue, 06 Apr 2010 16:53:43 +0000
parents f7038820df2e
children feae2f9d6c6f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/raster/AbstractProducer.java	Tue Apr 06 13:07:11 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/raster/AbstractProducer.java	Tue Apr 06 16:53:43 2010 +0000
@@ -2,17 +2,51 @@
 
 import de.intevation.gnv.raster.Vectorizer.RingsHandler;
 
+/**
+ * Abstract base class for producing multi polygons and 
+ * multi line strings. This base class stores a bounding box
+ * of world coordinates which helps to transform the index
+ * spaced egde data into real world coordinates.
+ *
+ * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
+ */
 public abstract class AbstractProducer
 implements            RingsHandler
 {
+    /**
+     * min x coord of the world.
+     */
     protected double minX;
+
+    /**
+     * min y coord of the world.
+     */
     protected double minY;
+
+    /**
+     * max x coord of the world.
+     */
     protected double maxX;
+
+    /**
+     * max y coord of the world.
+     */
     protected double maxY;
 
+    /**
+     * Default constructor.
+     */
     public AbstractProducer() {
     }
 
+    /**
+     * Constructor to create an Abstract producer with a
+     * given world bounding box.
+     * @param minX Min x coord of the world.
+     * @param minY Min y coord of the world.
+     * @param maxX Max x coord of the world.
+     * @param maxY Max y coord of the world.
+     */
     public AbstractProducer(
         double minX, double minY,
         double maxX, double maxY

http://dive4elements.wald.intevation.org