Mercurial > dive4elements > gnv-client
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 813:79c1db3ca7cc | 814:9d427dd2a96a |
|---|---|
| 20 import de.intevation.gnv.statistics.exception.StatisticsException; | 20 import de.intevation.gnv.statistics.exception.StatisticsException; |
| 21 | 21 |
| 22 import java.util.Collection; | 22 import java.util.Collection; |
| 23 | 23 |
| 24 /** | 24 /** |
| 25 * The interface <code>Statistics</code> fulfills the following purposes: | 25 * This interface defines one single method to calculate a statistic for a |
| 26 * <ol> | 26 * given data set. |
| 27 * <li>Providng a marker interface for statistics.</li> | |
| 28 * </ol> | |
| 29 * | 27 * |
| 30 * @author blume | 28 * @author blume |
| 31 * @version 1.0 | |
| 32 * @serial 1.0 | |
| 33 * @see | |
| 34 * @since 14.12.2007 09:34:32 | |
| 35 */ | 29 */ |
| 36 public interface Statistics { | 30 public interface Statistics { |
| 37 | 31 |
| 38 /** | 32 /** |
| 33 * This method takes a data set and creates a statistic from it. | |
| 39 * | 34 * |
| 40 * @param resultSet | 35 * @param resultSet The resulting statistic is about this data set. |
| 41 * @param parameters | 36 * @param parameters A collection of parameters. |
| 42 * @param measurements | 37 * @param measurements A collection of measurements. |
| 43 * @param dates | 38 * @param dates A collection of dates. |
| 44 * @return | 39 * @return a collection of statistics. |
| 45 * @throws StatisticsException | 40 * @throws StatisticsException if an error occured while creating the |
| 41 * statistic. | |
| 46 */ | 42 */ |
| 47 public Collection<StatisticSet> calculateStatistics( | 43 public Collection<StatisticSet> calculateStatistics( |
| 48 Object resultSet, | 44 Object resultSet, |
| 49 Collection<KeyValueDescibeData> parameters, | 45 Collection<KeyValueDescibeData> parameters, |
| 50 Collection<KeyValueDescibeData> measurements, | 46 Collection<KeyValueDescibeData> measurements, |
| 51 Collection<KeyValueDescibeData> dates | 47 Collection<KeyValueDescibeData> dates |
| 52 ) | 48 ) |
| 53 throws StatisticsException; | 49 throws StatisticsException; |
| 54 } | 50 } |
| 51 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |