diff gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/verticalcrosssection/VerticalCrossSectionOutputState.java @ 804:9058c08eac3a

Added more Javadoc in some classes of state.profile. gnv-artifacts/trunk@886 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 08 Apr 2010 10:10:04 +0000
parents c4156275c1e1
children 3ab5754e72e3
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/verticalcrosssection/VerticalCrossSectionOutputState.java	Wed Apr 07 07:52:27 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/profile/verticalcrosssection/VerticalCrossSectionOutputState.java	Thu Apr 08 10:10:04 2010 +0000
@@ -197,6 +197,13 @@
     }
 
 
+    /**
+     * Retrieves the data used to create a VerticalCrossProfileChart.
+     *
+     * @param uuid The UUID of the current artifact.
+     * @param callContext The CallContext object.
+     * @return the data used to create a VerticalCrossProfileChart.
+     */
     protected Object getData(String uuid, CallContext callContext) {
         Collection<Result> result = null;
         InputData meshLine        = inputData.get("mesh_linestring");
@@ -251,6 +258,7 @@
     }
 
 
+    @Override
     protected String getSelectedInputDataName(String uuid, String id) {
         Collection values = getCollection(id, uuid);
 
@@ -325,6 +333,16 @@
 
     public static final double EPSILON = 1e-5d;
 
+
+    /**
+     * Finalize the data used for chart generation. Isolines are added, colors
+     * are assigned to polygons and the seabed is added.
+     *
+     * @param path The path which have been inserted while parameterization.
+     * @param columns The data used to be displayed in a 2D chart.
+     * @param callContext The CallContext object.
+     * @return the finalized data ready for chart generation.
+     */
     protected Object process(
         List<Coordinate>    path,
         AttributedXYColumns columns,
@@ -477,6 +495,13 @@
     }
 
 
+    /**
+     * Pre-process the data returned by database query. The resulting data is
+     * not ready for chart creation!
+     *
+     * @param results Data returned by database.
+     * @return Pre-processed data which is not ready for chart creation yet.
+     */
     protected AttributedXYColumns preProcess(Collection results) {
 
         AttributedXYColumns attColumns = new AttributedXYColumns();
@@ -542,6 +567,26 @@
     }
 
 
+    /**
+     * This <code>getChart</code> method returns a 2D VerticalCrossSectionChart
+     * displaying polygon data with isolines and a legend describing the colors
+     * used in that chart.
+     *
+     * @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 2D chart representing the data as polygons.
+     */
     @Override
     protected Chart getChart(
         ChartLabels  chartLables,
@@ -614,16 +659,22 @@
         return chart;
     }
 
-    /**
-     * @see de.intevation.gnv.state.timeseries.TimeSeriesOutputState#getStatisticsGenerator()
-     */
+
     @Override
     protected Statistics getStatisticsGenerator() {
         return new VerticalCrossSectionStatistics();
     }
 
     /**
-     * @see de.intevation.gnv.state.timeseries.TimeSeriesOutputState#createCSV(java.io.OutputStream, java.util.Collection)
+     * Nothing happens here. <b>This method should never be called</b> until
+     * there is a wise implementation of a csv representation of the polygon
+     * data.
+     *
+     * @param outputStream The output stream used to write the csv file to.
+     * @param chartResult  The data used to be written to csv file.
+     * @throws UnsupportedEncodingException if the encoding is not supported.
+     * @throws IOException if an error occured while writing to output stream.
+     * @throws StateException if an error occured while csv file creation.
      */
     @Override
     protected void createCSV(

http://dive4elements.wald.intevation.org