Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/horizontal/HorizontalProfileMeshCrossOutputState.java @ 811:df6d980c5418
Added more Javadoc in state.profile.horizontal package.
gnv-artifacts/trunk@895 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
---|---|
date | Fri, 09 Apr 2010 10:46:31 +0000 |
parents | c4156275c1e1 |
children | 2423cefe7d39 |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/horizontal/HorizontalProfileMeshCrossOutputState.java Fri Apr 09 10:22:38 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/horizontal/HorizontalProfileMeshCrossOutputState.java Fri Apr 09 10:46:31 2010 +0000 @@ -47,6 +47,8 @@ import org.w3c.dom.Node; /** + * This <code>OutputState</code> is used for 'Horizontalschnitt' products. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> * @author <a href="mailto:iweinzierl@intevation.de">Ingo Weinzierl</a> * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> @@ -75,9 +77,7 @@ super(); } - /** - * @see de.intevation.gnv.state.timeseries.TimeSeriesOutputState#setup(org.w3c.dom.Node) - */ + @Override public void setup(Node configuration) { super.setup(configuration); @@ -86,6 +86,24 @@ } + /** + * This method creates a chart and returns it. + * + * @param chartLables Labels used to decorate the chart. + * @param theme The theme used to adjust the look of the chart. + * @param parameters A collection with parameters this chart contains. + * @param measurements A collection with measurement this chart contains. + * @param dates A collection with dates this chart contains. + * @param result The data collection used to be displayed in this chart. + * @param locale The Locale used to determine the language. + * @param uuid The uuid of the current artifact. + * @param linesVisible A boolean property to determine the visibility of + * lines connecting two points in a chart (not used in this chart type). + * @param shapesVisible A boolean property to determine the visiblity of + * datapoints in this chart (not used in this chart type). + * @param callContext The CallContext object. + * @return a <code>HorizontalCrossProfileChart</code>. + */ @Override protected Chart getChart( ChartLabels chartLables, @@ -212,6 +230,13 @@ } + /** + * The chart subtitle created by this method is build up of the timeperiod. + * + * @param locale The Locale used to adjust the language of the subtitle. + * @param uuid The UUID of the current artifact. + * @return a timeperiod as string. + */ @Override protected String createChartSubtitle(Locale locale, String uuid) { log.debug("create chart subtitle for horizontal crossprofile charts."); @@ -221,6 +246,15 @@ } + /** + * Prepares the input data for chart creation. + * + * @param path The coordinates describing the path the data is processed + * for. + * @param numSamples Number of samples. + * @param input The input data. + * @return finalized data ready for chart creation. + */ public static Collection<Result> process( List<Coordinate> path, int numSamples, @@ -409,3 +443,4 @@ } } } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file