Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/statistics/AbstractStatistics.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 | c4156275c1e1 |
| children | 2423cefe7d39 |
comparison
equal
deleted
inserted
replaced
| 813:79c1db3ca7cc | 814:9d427dd2a96a |
|---|---|
| 5 import org.apache.commons.math.stat.regression.SimpleRegression; | 5 import org.apache.commons.math.stat.regression.SimpleRegression; |
| 6 | 6 |
| 7 import org.apache.log4j.Logger; | 7 import org.apache.log4j.Logger; |
| 8 | 8 |
| 9 /** | 9 /** |
| 10 * An abstract implementation of <code>Statistics</code> with a default | |
| 11 * implementation of the {@link #generateStatisticsValues(org.apache.commons.math.stat.descriptive.DescriptiveStatistics, org.apache.commons.math.stat.regression.SimpleRegression, java.lang.String)} | |
| 12 * method. | |
| 13 * | |
| 10 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> | 14 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> |
| 11 */ | 15 */ |
| 12 public abstract class AbstractStatistics | 16 public abstract class AbstractStatistics |
| 13 implements Statistics | 17 implements Statistics |
| 14 { | 18 { |
| 16 AbstractStatistics.class); | 20 AbstractStatistics.class); |
| 17 | 21 |
| 18 public AbstractStatistics() { | 22 public AbstractStatistics() { |
| 19 } | 23 } |
| 20 | 24 |
| 25 /** | |
| 26 * This method takes a statistics object and puts relevant values into a | |
| 27 * <code>StatisticSet</code>. | |
| 28 * | |
| 29 * @param lStatistics A statistics object. | |
| 30 * @param lRegression A simple regression. | |
| 31 * @param statisticName Name for the resulting statistic. | |
| 32 * @return a set of statistics. | |
| 33 */ | |
| 21 protected StatisticSet generateStatisticsValues( | 34 protected StatisticSet generateStatisticsValues( |
| 22 DescriptiveStatistics lStatistics, | 35 DescriptiveStatistics lStatistics, |
| 23 SimpleRegression lRegression, | 36 SimpleRegression lRegression, |
| 24 String statisticName | 37 String statisticName |
| 25 ) { | 38 ) { |