Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/chart/AbstractChart.java @ 767:79401c871da4
Added and repaired javadoc in de.intevation.gnv.chart package.
gnv-artifacts/trunk@823 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
---|---|
date | Wed, 24 Mar 2010 14:48:55 +0000 |
parents | 3d13fa281a7e |
children | b1f5f2a8840f |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/chart/AbstractChart.java Tue Mar 23 14:11:51 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/chart/AbstractChart.java Wed Mar 24 14:48:55 2010 +0000 @@ -7,25 +7,76 @@ import org.jfree.chart.ChartTheme; /** - * @author Ingo Weinzierl (ingo.weinzierl@intevation.de) + * Abstract chart class to define the basic fields used for chart creation. + * + * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> */ public abstract class AbstractChart implements Chart { + /** + * JFreeChart object. Created after {@link #generateChart()} is called. + */ protected JFreeChart chart; + + /** + * Field storing the visibility of lines in the chart plot. + */ protected boolean linesVisible; + + /** + * Field storing the visibility of points in the chart plot. + */ protected boolean shapesVisible; + /** + * Locale object used for i18n support. + */ protected Locale locale; + /** + * ChartLabels + */ protected ChartLabels labels; + + /** + * ChartTheme + */ protected ChartTheme theme; + + /** + * Collection which contains a bunch of parameters. + */ protected Collection parameters; + + /** + * Collection which contains a bunch of measurements. + */ protected Collection measurements; + + /** + * Collection which contains all data objects used to be displayed in the + * chart. It contains different series and different datasets which is not + * very elegant. + */ protected Collection resultSet; + + /** + * Collection which contains a bunch of date objects. + */ protected Collection dates; + + /** + * Collection which contains a bunch of time gap definitions used to + * detect gaps in timeseries charts. + */ protected Collection timeGaps; + /** + * Abstract method which needs to be implemented by concrete subclasses. + * This method triggers the JFreeChart creation process. After calling this + * method {@link #chart} should be a valid <code>JFreeChart</code> object. + */ public abstract JFreeChart generateChart(); } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :