comparison 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
comparison
equal deleted inserted replaced
801:d766fe2d917a 802:4abe172be970
14 import java.util.Collection; 14 import java.util.Collection;
15 15
16 import org.apache.log4j.Logger; 16 import org.apache.log4j.Logger;
17 17
18 /** 18 /**
19 * Vectorizer backend to generate iso lines which are able to be visualized
20 * via {@link de.intevation.gnv.jfreechart.PolygonPlot} as line strings
21 * and custom labels on the chart.
22 *
19 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> 23 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
20 */ 24 */
21 public class IsoPolygonSeriesProducer 25 public class IsoPolygonSeriesProducer
22 extends IsoProducer 26 extends IsoProducer
23 { 27 {
24 private static Logger log = Logger.getLogger( 28 private static Logger log = Logger.getLogger(
25 IsoPolygonSeriesProducer.class); 29 IsoPolygonSeriesProducer.class);
26 30
27 public static final Float LINE_WIDTH = Float.valueOf(0.1f); 31 /**
32 * The line width of the line string used in the chart.
33 */
34 public static final Float LINE_WIDTH = Float.valueOf(0.1f);
28 35
36 /**
37 * Constructor to create an IsoPolygonSeriesProducer with a
38 * given world bounding box.
39 * @param minX Min x coord of the world.
40 * @param minY Min y coord of the world.
41 * @param maxX Max x coord of the world.
42 * @param maxY Max y coord of the world.
43 */
29 public IsoPolygonSeriesProducer( 44 public IsoPolygonSeriesProducer(
30 double minX, double minY, 45 double minX, double minY,
31 double maxX, double maxY 46 double maxX, double maxY
32 ) { 47 ) {
33 super(minX, minY, maxX, maxY); 48 super(minX, minY, maxX, maxY);
34 } 49 }
35 50
51 /**
52 * Returns a collection of series with line strings
53 * with no AttributeGenerator.
54 * @return The collection with line strings.
55 */
36 public Collection<PolygonSeries> getSeries() { 56 public Collection<PolygonSeries> getSeries() {
37 return getSeries(null); 57 return getSeries(null);
38 } 58 }
39 59
60 /**
61 * Returns a collection of series with line strings.
62 * The label attributes are generated with a given generator.
63 * @param attributeGenerator The attribute generator. Maybe null
64 * if no attributes should be generated.
65 * @return The collection with the line strings.
66 */
40 public Collection<PolygonSeries> getSeries( 67 public Collection<PolygonSeries> getSeries(
41 AttributeGenerator attributeGenerator 68 AttributeGenerator attributeGenerator
42 ) { 69 ) {
43 ArrayList<PolygonSeries> series = new ArrayList<PolygonSeries>(); 70 ArrayList<PolygonSeries> series = new ArrayList<PolygonSeries>();
44 71

http://dive4elements.wald.intevation.org