diff flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WstValueTable.java @ 1838:853cd2120d69

Cosmetics, doc. flys-artifacts/trunk@3174 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Felix Wolfsteller <felix.wolfsteller@intevation.de>
date Mon, 07 Nov 2011 10:48:13 +0000
parents eb35570df0e8
children ddd425858169
line wrap: on
line diff
--- a/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WstValueTable.java	Mon Nov 07 10:43:51 2011 +0000
+++ b/flys-artifacts/src/main/java/de/intevation/flys/artifacts/model/WstValueTable.java	Mon Nov 07 10:48:13 2011 +0000
@@ -20,6 +20,9 @@
 
 import org.apache.commons.math.exception.MathIllegalArgumentException;
 
+/**
+ * W, Q and km data from database 'wsts' spiced with interpolation algorithms.
+ */
 public class WstValueTable
 implements   Serializable
 {
@@ -86,7 +89,7 @@
     } // class Position
 
     /**
-     * A row, typically a position where measurements whrere taken.
+     * A row, typically a position where measurements were taken.
      */
     public static final class Row
     implements                Serializable, Comparable<Row>
@@ -106,6 +109,9 @@
             this.ws = ws;
         }
 
+        /**
+         * Compare according to place of measurement (km).
+         */
         public int compareTo(Row other) {
             double d = km - other.km;
             if (d < -0.0001) return -1;
@@ -351,8 +357,10 @@
         }
     } // class Row
 
+    /** Rows in table. */
     protected List<Row> rows;
 
+    /** Columns in table. */
     protected Column [] columns;
 
     public WstValueTable() {
@@ -369,6 +377,7 @@
         this.rows    = rows;
     }
 
+    /** Sort rows (by km). */
     public void sortRows() {
         Collections.sort(rows);
     }
@@ -433,10 +442,16 @@
         return ws;
     }
 
+    /**
+     * Interpolate W and Q values at a given km.
+     */
     public double [][] interpolateWQ(double km) {
         return interpolateWQ(km, null);
     }
 
+    /**
+     * Interpolate W and Q values at a given km.
+     */
     public double [][] interpolateWQ(double km, Calculation errors) {
         return interpolateWQ(km, DEFAULT_Q_STEPS, errors);
     }

http://dive4elements.wald.intevation.org