# HG changeset patch
# User Felix Wolfsteller <felix.wolfsteller@intevation.de>
# Date 1318941096 0
# Node ID eb35570df0e8daa41ac678464df6e9ac4dc68d0b
# Parent  fa932d618989a5f278718ca754b26448187f5dec
Cosmetics, docs.

flys-artifacts/trunk@3002 c6561f87-3c4e-4783-a992-168aeb5c3f6f

diff -r fa932d618989 -r eb35570df0e8 flys-artifacts/ChangeLog
--- a/flys-artifacts/ChangeLog	Tue Oct 18 12:27:49 2011 +0000
+++ b/flys-artifacts/ChangeLog	Tue Oct 18 12:31:36 2011 +0000
@@ -1,3 +1,14 @@
+2011-10-18	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
+
+	Cosmetics, docs.
+
+	* src/main/java/de/intevation/flys/artifacts/model/WaterlevelFacet.java,
+	  src/main/java/de/intevation/flys/artifacts/model/ManagedFacet.java,
+	  src/main/java/de/intevation/flys/artifacts/model/WstValueTable.java,
+	  src/main/java/de/intevation/flys/exports/ComputedDischargeCurveGenerator.java,
+	  src/main/java/de/intevation/flys/jfree/FLYSAnnotation.java:
+	  Cosmetics, docs.
+
 2011-10-18	Felix Wolfsteller	<felix.wolfsteller@intevation.de>
 
 	* src/main/java/de/intevation/flys/artifacts/model/WKmsImpl.java:
diff -r fa932d618989 -r eb35570df0e8 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/ManagedFacet.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/ManagedFacet.java	Tue Oct 18 12:27:49 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/ManagedFacet.java	Tue Oct 18 12:31:36 2011 +0000
@@ -1,5 +1,7 @@
 package de.intevation.flys.artifacts.model;
 
+import org.apache.log4j.Logger;
+
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
@@ -27,9 +29,13 @@
     /** A property that determines if this facet is active or not. */
     protected int active;
 
+    /** The logger that is used in this class. */
+    private static Logger logger = Logger.getLogger(ManagedFacet.class);
+
     /** A property that determines if this facet is visible or not. */
     protected int visible;
 
+
     public ManagedFacet() {
     }
 
@@ -51,6 +57,9 @@
     }
 
 
+    /**
+     * Sets position (will be merged to position in ThemeList).
+     */
     public void setPosition(int pos) {
         this.position = pos;
     }
@@ -81,6 +90,10 @@
     }
 
 
+    /**
+     * Get uuid of related artifact.
+     * @return uuid of related artifact.
+     */
     public String getArtifact() {
         return uuid;
     }
diff -r fa932d618989 -r eb35570df0e8 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WaterlevelFacet.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WaterlevelFacet.java	Tue Oct 18 12:27:49 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WaterlevelFacet.java	Tue Oct 18 12:31:36 2011 +0000
@@ -12,6 +12,9 @@
 
 import de.intevation.flys.artifacts.states.DefaultState.ComputeType;
 
+/**
+ * Facet of a Waterlevel (WQKms).
+ */
 public class WaterlevelFacet extends DefaultFacet {
 
     private static Logger logger = Logger.getLogger(WaterlevelFacet.class);
diff -r fa932d618989 -r eb35570df0e8 flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WstValueTable.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WstValueTable.java	Tue Oct 18 12:27:49 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WstValueTable.java	Tue Oct 18 12:31:36 2011 +0000
@@ -27,6 +27,9 @@
 
     public static final int DEFAULT_Q_STEPS = 500;
 
+    /**
+     * A Column in the table, typically representing one measurement session.
+     */
     public static final class Column
     implements                Serializable
     {
@@ -58,6 +61,9 @@
         }
     } // class Column
 
+    /**
+     * A (weighted) position used for interpolation.
+     */
     public static final class QPosition {
 
         protected int    index;
@@ -79,6 +85,9 @@
 
     } // class Position
 
+    /**
+     * A row, typically a position where measurements whrere taken.
+     */
     public static final class Row
     implements                Serializable, Comparable<Row>
     {
@@ -229,6 +238,7 @@
             return new double [][] { outWs, outQs };
         }
 
+
         public double [][] interpolateWQ(
             int           steps,
             WstValueTable table,
diff -r fa932d618989 -r eb35570df0e8 flys-artifacts/src/main/java/de/intevation/flys/exports/ComputedDischargeCurveGenerator.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/exports/ComputedDischargeCurveGenerator.java	Tue Oct 18 12:27:49 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/exports/ComputedDischargeCurveGenerator.java	Tue Oct 18 12:31:36 2011 +0000
@@ -32,7 +32,6 @@
     private static Logger logger =
         Logger.getLogger(ComputedDischargeCurveGenerator.class);
 
-
     public static final String I18N_CHART_TITLE =
         "chart.computed.discharge.curve.title";
 
@@ -104,11 +103,11 @@
         }
         else if (name.equals(COMPUTED_DISCHARGE_MAINVALUES_Q)) {
             doMainValueQAnnotations(
-                f.getData(artifact, context), facet, attr,visible);
+                f.getData(artifact, context), facet, attr, visible);
         }
         else if (name.equals(COMPUTED_DISCHARGE_MAINVALUES_W)) {
             doMainValueWAnnotations(
-                f.getData(artifact, context), facet, attr,visible);
+                f.getData(artifact, context), facet, attr, visible);
         }
         else {
             logger.warn("Unknown facet type for computed discharge: " + name);
diff -r fa932d618989 -r eb35570df0e8 flys-artifacts/src/main/java/de/intevation/flys/jfree/FLYSAnnotation.java
--- a/flys-artifacts/src/main/java/de/intevation/flys/jfree/FLYSAnnotation.java	Tue Oct 18 12:27:49 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/jfree/FLYSAnnotation.java	Tue Oct 18 12:31:36 2011 +0000
@@ -6,7 +6,9 @@
 
 import org.jfree.chart.annotations.XYTextAnnotation;
 
-
+/**
+ * List of Annotations with name and theme.
+ */
 public class FLYSAnnotation {
 
     protected List<XYTextAnnotation> annotations;