# HG changeset patch # User Felix Wolfsteller # Date 1347025754 0 # Node ID 7b14d00bca8a04766dfd3a6708351d8dbbd65193 # Parent c91e7db0fd4bcf85e9c39823191cb2261708c79e Cosmetics, docs. flys-artifacts/trunk@5391 c6561f87-3c4e-4783-a992-168aeb5c3f6f diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/artifacts/ChartArtifact.java --- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/ChartArtifact.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/ChartArtifact.java Fri Sep 07 13:49:14 2012 +0000 @@ -30,6 +30,7 @@ import de.intevation.flys.artifacts.resources.Resources; +/** Artifact, open to generate any (?) out. */ public class ChartArtifact extends FLYSArtifact { private static final Logger logger = diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/Datacage.java --- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/Datacage.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/Datacage.java Fri Sep 07 13:49:14 2012 +0000 @@ -451,7 +451,6 @@ } protected boolean cleanDatabase() { - log.debug("cleanDatabase"); boolean success = sqlExecutor.new Instance() { diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/DatacageBackendListener.java --- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/DatacageBackendListener.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/datacage/DatacageBackendListener.java Fri Sep 07 13:49:14 2012 +0000 @@ -14,6 +14,7 @@ import org.w3c.dom.Document; +/** Triggers Datacage to update db. */ public class DatacageBackendListener implements BackendListener { diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/RiverSelect.java --- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/RiverSelect.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/states/RiverSelect.java Fri Sep 07 13:49:14 2012 +0000 @@ -30,7 +30,6 @@ /** The logger used in this class. */ private static Logger logger = Logger.getLogger(RiverSelect.class); - /** Error message that is thrown if no river was found based on a given * name.*/ public static final String ERROR_NO_SUCH_RIVER = diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/exports/TimeseriesChartGenerator.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/TimeseriesChartGenerator.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/TimeseriesChartGenerator.java Fri Sep 07 13:49:14 2012 +0000 @@ -480,6 +480,7 @@ } + /** Get (zoom)values from request. */ public Bounds getDomainAxisRange() { String[] ranges = getDomainAxisRangeFromRequest(); @@ -551,10 +552,15 @@ } + /** + * @param plot the plot. + * @param axis the value (x, time) axis of which to set bounds. + * @param total the current bounds (?). + */ protected void zoomX( XYPlot plot, ValueAxis axis, - Bounds total, + Bounds total,//we could equally nicely getXBounds(0) Bounds user ) { if (logger.isDebugEnabled()) { @@ -586,6 +592,9 @@ } + /** + * @param user zoom values in percent. + */ protected void zoomY( XYPlot plot, ValueAxis axis, @@ -624,6 +633,8 @@ /** * Adjusts the axes of a plot. This method sets the labelFont of the * X axis. + * + * (Duplicate in XYChartGenerator). * * @param plot The XYPlot of the chart. */ diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/exports/TypeSection.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/TypeSection.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/TypeSection.java Fri Sep 07 13:49:14 2012 +0000 @@ -18,6 +18,7 @@ } + /** Set a string value for a attribute with additional (choice) type. */ public void setChoiceStringValue(String key, String value, String choiceType) { if (value == null || value.length() == 0) { return; diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/XYChartGenerator.java Fri Sep 07 13:49:14 2012 +0000 @@ -862,6 +862,8 @@ * Adjusts the axes of a plot. This method sets the labelFont of the * X axis. * + * (Duplicate in TimeseriesChartGenerator) + * * @param plot The XYPlot of the chart. */ protected void adjustAxes(XYPlot plot) { diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/exports/fixings/FixATExport.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/fixings/FixATExport.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/fixings/FixATExport.java Fri Sep 07 13:49:14 2012 +0000 @@ -30,8 +30,10 @@ import org.w3c.dom.Document; import org.w3c.dom.NodeList; +/** Export result of fixation analysis. */ public class FixATExport extends AbstractExporter { + /** Private logger. */ private static Logger logger = Logger.getLogger(FixATExport.class); @@ -96,3 +98,4 @@ // Nothing to do here. } } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/exports/fixings/FixChartGenerator.java --- a/flys-artifacts/src/main/java/de/intevation/flys/exports/fixings/FixChartGenerator.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/fixings/FixChartGenerator.java Fri Sep 07 13:49:14 2012 +0000 @@ -10,9 +10,13 @@ import org.apache.log4j.Logger; import org.w3c.dom.Document; +/** + * Base class for FixChartGenerator. + */ public abstract class FixChartGenerator extends XYChartGenerator { + /** Private logger. */ private static Logger logger = Logger.getLogger(FixChartGenerator.class); public static final double INVALID_KM = Double.valueOf(-1d); diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/jfree/Bounds.java --- a/flys-artifacts/src/main/java/de/intevation/flys/jfree/Bounds.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/jfree/Bounds.java Fri Sep 07 13:49:14 2012 +0000 @@ -6,6 +6,7 @@ /** + * Somewhat better Ranges. * @author Ingo Weinzierl */ public interface Bounds extends Serializable { diff -r c91e7db0fd4b -r 7b14d00bca8a flys-artifacts/src/main/java/de/intevation/flys/jfree/DoubleBounds.java --- a/flys-artifacts/src/main/java/de/intevation/flys/jfree/DoubleBounds.java Fri Sep 07 12:03:48 2012 +0000 +++ b/flys-artifacts/src/main/java/de/intevation/flys/jfree/DoubleBounds.java Fri Sep 07 13:49:14 2012 +0000 @@ -42,6 +42,11 @@ } + /** + * Set extended range to ValueAxis. + * @param percent how many percent to extend (in each direction, + * thus 10 percent on [0,100] -> [-10,110]. + */ @Override public void applyBounds(ValueAxis axis, int percent) { double space = (upper - lower) / 100 * percent;