diff gnv-artifacts/src/main/java/de/intevation/gnv/raster/IsoPolygonSeriesProducer.java @ 802:4abe172be970

Finished Javadoc of the raster package. gnv-artifacts/trunk@884 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Wed, 07 Apr 2010 07:49:12 +0000
parents d766fe2d917a
children f953c9a559d8
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/raster/IsoPolygonSeriesProducer.java	Tue Apr 06 16:53:43 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/raster/IsoPolygonSeriesProducer.java	Wed Apr 07 07:49:12 2010 +0000
@@ -16,6 +16,10 @@
 import org.apache.log4j.Logger;
 
 /**
+ * Vectorizer backend to generate iso lines which are able to be visualized
+ * via {@link de.intevation.gnv.jfreechart.PolygonPlot} as line strings
+ * and custom labels on the chart.
+ *
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public class IsoPolygonSeriesProducer
@@ -24,8 +28,19 @@
     private static Logger log = Logger.getLogger(
         IsoPolygonSeriesProducer.class);
 
-	public static final Float LINE_WIDTH = Float.valueOf(0.1f);
+    /**
+     * The line width of the line string used in the chart.
+     */
+    public static final Float LINE_WIDTH = Float.valueOf(0.1f);
 
+    /**
+     * Constructor to create an IsoPolygonSeriesProducer 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 IsoPolygonSeriesProducer(
         double minX, double minY,
         double maxX, double maxY
@@ -33,10 +48,22 @@
         super(minX, minY, maxX, maxY);
     }
 
+    /**
+     * Returns a collection of series with line strings
+     * with no AttributeGenerator.
+     * @return The collection with line strings.
+     */
     public Collection<PolygonSeries> getSeries() {
         return getSeries(null);
     }
 
+    /**
+     * Returns a collection of series with line strings.
+     * The label attributes are generated with a given generator.
+     * @param attributeGenerator The attribute generator. Maybe null
+     * if no attributes should be generated.
+     * @return The collection with the line strings.
+     */
     public Collection<PolygonSeries> getSeries(
         AttributeGenerator attributeGenerator
     ) {

http://dive4elements.wald.intevation.org