diff gnv-artifacts/src/main/java/de/intevation/gnv/raster/PolygonDatasetProducer.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 6cff63d0c434
children feae2f9d6c6f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/raster/PolygonDatasetProducer.java	Tue Apr 06 13:07:11 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/raster/PolygonDatasetProducer.java	Tue Apr 06 16:53:43 2010 +0000
@@ -12,16 +12,34 @@
 import java.util.List;
 
 /**
+ * Vectorizer backend to produce polygon datasets suitable to being
+ * displayed with {@link de.intevation.gnv.jfreechart.PolygonPlot}.
+ * 
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public class PolygonDatasetProducer
 extends      AbstractProducer
 {
+    /**
+     * Maps value integers to series of polygons to group
+     * them by value.
+     */
     protected HashMap<Integer, PolygonSeries> polygonSeries;
 
+    /**
+     * Default constructor.
+     */
     protected PolygonDatasetProducer() {
     }
 
+    /**
+     * Constructor to create a PolygonDatasetProducer with
+     * a given world bound 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 PolygonDatasetProducer(
         double minX, double minY,
         double maxX, double maxY
@@ -79,6 +97,11 @@
         }
     }
 
+    /**
+     * Creates a new PolygonDataset from the polygons build by this
+     * backend.
+     * @return the new PolygonDataset
+     */
     public PolygonDataset getPolygonDataset() {
         return new PolygonDataset(polygonSeries.values());
     }

http://dive4elements.wald.intevation.org