Mercurial > dive4elements > gnv-client
diff 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 |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/AbstractStatistics.java Fri Apr 09 13:09:25 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/statistics/AbstractStatistics.java Fri Apr 09 14:34:45 2010 +0000 @@ -7,6 +7,10 @@ import org.apache.log4j.Logger; /** + * An abstract implementation of <code>Statistics</code> with a default + * implementation of the {@link #generateStatisticsValues(org.apache.commons.math.stat.descriptive.DescriptiveStatistics, org.apache.commons.math.stat.regression.SimpleRegression, java.lang.String)} + * method. + * * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> */ public abstract class AbstractStatistics @@ -18,6 +22,15 @@ public AbstractStatistics() { } + /** + * This method takes a statistics object and puts relevant values into a + * <code>StatisticSet</code>. + * + * @param lStatistics A statistics object. + * @param lRegression A simple regression. + * @param statisticName Name for the resulting statistic. + * @return a set of statistics. + */ protected StatisticSet generateStatisticsValues( DescriptiveStatistics lStatistics, SimpleRegression lRegression,