diff gnv-artifacts/src/main/java/de/intevation/gnv/statistics/Statistics.java @ 814:9d427dd2a96a

Added Javadoc in statistic package. gnv-artifacts/trunk@898 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Fri, 09 Apr 2010 14:34:45 +0000
parents b1f5f2a8840f
children 05bf8534a35a
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/Statistics.java	Fri Apr 09 13:09:25 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/Statistics.java	Fri Apr 09 14:34:45 2010 +0000
@@ -22,27 +22,23 @@
 import java.util.Collection;
 
 /**
- * The interface <code>Statistics</code> fulfills the following purposes:
- * <ol>
- * <li>Providng a marker interface for statistics.</li>
- * </ol>
+ * This interface defines one single method to calculate a statistic for a
+ * given data set.
  * 
  * @author blume
- * @version 1.0
- * @serial 1.0
- * @see
- * @since 14.12.2007 09:34:32
  */
 public interface Statistics {
 
    /**
+    * This method takes a data set and creates a statistic from it.
     * 
-    * @param resultSet
-    * @param parameters
-    * @param measurements
-    * @param dates
-    * @return
-    * @throws StatisticsException
+    * @param resultSet The resulting statistic is about this data set.
+    * @param parameters A collection of parameters.
+    * @param measurements A collection of measurements.
+    * @param dates A collection of dates.
+    * @return a collection of statistics.
+    * @throws StatisticsException if an error occured while creating the
+    * statistic.
     */
     public Collection<StatisticSet>  calculateStatistics(
          Object                          resultSet,
@@ -52,3 +48,4 @@
     )
     throws StatisticsException;
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org