add some metadata for better output handling

Author: moovida

apps/src/main/java/org/hortonmachine/database/addons/whetgeo/WhetgeoStateChartData.java

@@ -32,15 +32,26 @@
  */
 public class WhetgeoStateChartData {
     public double[] gridEta = new double[0];
+    /** Per-cell parameter-set label, same order as {@link #gridEta}; empty if the output
+     *  wasn't written with {@code parameter_id} (see {@code Whetgeo1DOutputsHandler}). */
+    public int[] gridParameterID = new int[0];
 
     public long[] topBCTimes = new long[0];
     public double[] topBCValues = new double[0];
+    /** e.g. "TOP_COUPLED"; null if the output wasn't written with one
+     *  (see {@code Whetgeo1DOutputsHandler.TABLE_OUTPUT_METADATA}). */
+    public String topBCType;
 
     public long[] bottomBCTimes = new long[0];
     public double[] bottomBCValues = new double[0];
+    public String bottomBCType;
 
     public List<DepthSeries> depthSeries = new ArrayList<>();
 
+    /** SWRC parameter snapshot per parameter set id, if the output was written with one
+     *  (see {@code Whetgeo1DOutputsHandler.TABLE_OUTPUT_SWRC_PARAMETERS}); empty otherwise. */
+    public List<SwrcParams> swrcParameters = new ArrayList<>();
+
     /**
      * One state variable's full (timestamp, eta) -&gt; value grid, flattened into
      * three parallel arrays (one triple per row of {@code output_state}).
@@ -57,4 +68,23 @@ public DepthSeries( String name, String axisLabel ) {
             this.axisLabel = axisLabel;
         }
     }
+
+    /** One row of {@code output_swrc_parameters}: the soil properties for one parameter set. */
+    public static class SwrcParams {
+        public final int id;
+        public final double thetaS;
+        public final double thetaR;
+        public final double ks;
+        public final double n;
+        public final double alpha;
+
+        public SwrcParams( int id, double thetaS, double thetaR, double ks, double n, double alpha ) {
+            this.id = id;
+            this.thetaS = thetaS;
+            this.thetaR = thetaR;
+            this.ks = ks;
+            this.n = n;
+            this.alpha = alpha;
+        }
+    }
 }

apps/src/main/java/org/hortonmachine/database/addons/whetgeo/WhetgeoStateChartDataLoader.java

@@ -23,6 +23,7 @@
 import java.util.Map;
 
 import org.hortonmachine.database.addons.whetgeo.WhetgeoStateChartData.DepthSeries;
+import org.hortonmachine.database.addons.whetgeo.WhetgeoStateChartData.SwrcParams;
 import org.hortonmachine.dbs.compat.ADb;
 import org.hortonmachine.dbs.compat.IHMResultSet;
 import org.hortonmachine.dbs.compat.IHMStatement;
@@ -60,7 +61,17 @@ private WhetgeoStateChartDataLoader() {
     public static WhetgeoStateChartData load( ADb db ) throws Exception {
         WhetgeoStateChartData data = new WhetgeoStateChartData();
 
-        data.gridEta = loadGridEta(db);
+        boolean withParameterID = hasColumn(db, Whetgeo1DOutputsHandler.TABLE_OUTPUT_GRID,
+                Whetgeo1DOutputsHandler.COL_PARAMETER_ID);
+        loadGrid(db, data, withParameterID);
+
+        if (withParameterID && db.hasTable(Whetgeo1DOutputsHandler.TABLE_OUTPUT_SWRC_PARAMETERS)) {
+            data.swrcParameters = loadSwrcParameters(db);
+        }
+
+        if (db.hasTable(Whetgeo1DOutputsHandler.TABLE_OUTPUT_METADATA)) {
+            loadBCTypes(db, data);
+        }
 
         if (hasColumn(db, Whetgeo1DOutputsHandler.TABLE_OUTPUT_SCALARS, Whetgeo1DOutputsHandler.COL_TOP_BC)) {
             ScalarSeries topBC = loadScalarSeries(db, Whetgeo1DOutputsHandler.COL_TOP_BC);
@@ -85,19 +96,60 @@ public static WhetgeoStateChartData load( ADb db ) throws Exception {
         return data;
     }
 
-    private static double[] loadGridEta( ADb db ) throws Exception {
-        String sql = "SELECT " + Whetgeo1DOutputsHandler.COL_ETA + " FROM " + Whetgeo1DOutputsHandler.TABLE_OUTPUT_GRID
-                + " ORDER BY " + Whetgeo1DOutputsHandler.COL_ETA;
+    private static void loadGrid( ADb db, WhetgeoStateChartData data, boolean withParameterID ) throws Exception {
+        String sql = "SELECT " + Whetgeo1DOutputsHandler.COL_ETA + (withParameterID
+                ? ", " + Whetgeo1DOutputsHandler.COL_PARAMETER_ID
+                : "") + " FROM " + Whetgeo1DOutputsHandler.TABLE_OUTPUT_GRID + " ORDER BY "
+                + Whetgeo1DOutputsHandler.COL_ETA;
         List<Double> eta = new ArrayList<>();
+        List<Integer> parameterID = new ArrayList<>();
         db.<Void>execOnConnection(connection -> {
             try (IHMStatement stmt = connection.createStatement(); IHMResultSet rs = stmt.executeQuery(sql)) {
                 while( rs.next() ) {
                     eta.add(rs.getDouble(1));
+                    if (withParameterID) {
+                        parameterID.add(rs.getInt(2));
+                    }
+                }
+            }
+            return null;
+        });
+        data.gridEta = eta.stream().mapToDouble(Double::doubleValue).toArray();
+        if (withParameterID) {
+            data.gridParameterID = parameterID.stream().mapToInt(Integer::intValue).toArray();
+        }
+    }
+
+    private static List<SwrcParams> loadSwrcParameters( ADb db ) throws Exception {
+        String sql = "SELECT " + Whetgeo1DOutputsHandler.COL_ID + ", " + Whetgeo1DOutputsHandler.COL_THETA_S + ", "
+                + Whetgeo1DOutputsHandler.COL_THETA_R + ", " + Whetgeo1DOutputsHandler.COL_KS + ", "
+                + Whetgeo1DOutputsHandler.COL_N + ", " + Whetgeo1DOutputsHandler.COL_ALPHA + " FROM "
+                + Whetgeo1DOutputsHandler.TABLE_OUTPUT_SWRC_PARAMETERS + " ORDER BY " + Whetgeo1DOutputsHandler.COL_ID;
+        List<SwrcParams> params = new ArrayList<>();
+        db.<Void>execOnConnection(connection -> {
+            try (IHMStatement stmt = connection.createStatement(); IHMResultSet rs = stmt.executeQuery(sql)) {
+                while( rs.next() ) {
+                    params.add(new SwrcParams(rs.getInt(1), rs.getDouble(2), rs.getDouble(3), rs.getDouble(4),
+                            rs.getDouble(5), rs.getDouble(6)));
+                }
+            }
+            return null;
+        });
+        return params;
+    }
+
+    private static void loadBCTypes( ADb db, WhetgeoStateChartData data ) throws Exception {
+        String sql = "SELECT " + Whetgeo1DOutputsHandler.COL_TOP_BC_TYPE + ", "
+                + Whetgeo1DOutputsHandler.COL_BOTTOM_BC_TYPE + " FROM " + Whetgeo1DOutputsHandler.TABLE_OUTPUT_METADATA;
+        db.<Void>execOnConnection(connection -> {
+            try (IHMStatement stmt = connection.createStatement(); IHMResultSet rs = stmt.executeQuery(sql)) {
+                if (rs.next()) {
+                    data.topBCType = rs.getString(1);
+                    data.bottomBCType = rs.getString(2);
                 }
             }
             return null;
         });
-        return eta.stream().mapToDouble(Double::doubleValue).toArray();
     }
 
     private static ScalarSeries loadScalarSeries( ADb db, String column ) throws Exception {

apps/src/main/java/org/hortonmachine/database/addons/whetgeo/WhetgeoStateChartPanelBuilder.java

@@ -17,27 +17,34 @@
  */
 package org.hortonmachine.database.addons.whetgeo;
 
+import java.awt.BasicStroke;
 import java.awt.BorderLayout;
 import java.awt.Color;
+import java.awt.FlowLayout;
 import java.awt.Font;
 import java.text.DecimalFormat;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 
 import javax.swing.BorderFactory;
 import javax.swing.BoxLayout;
+import javax.swing.JCheckBox;
 import javax.swing.JLabel;
 import javax.swing.JPanel;
 import javax.swing.SwingConstants;
 
 import org.hortonmachine.database.addons.whetgeo.WhetgeoStateChartData.DepthSeries;
+import org.hortonmachine.database.addons.whetgeo.WhetgeoStateChartData.SwrcParams;
 import org.hortonmachine.gears.utils.colors.ColorUtilities;
 import org.jfree.chart.ChartPanel;
 import org.jfree.chart.JFreeChart;
 import org.jfree.chart.axis.DateAxis;
 import org.jfree.chart.axis.NumberAxis;
 import org.jfree.chart.plot.CombinedDomainXYPlot;
+import org.jfree.chart.plot.ValueMarker;
 import org.jfree.chart.plot.XYPlot;
 import org.jfree.chart.renderer.PaintScale;
 import org.jfree.chart.renderer.xy.XYBarRenderer;
@@ -46,8 +53,10 @@
 import org.jfree.data.xy.DefaultIntervalXYDataset;
 import org.jfree.data.xy.DefaultXYZDataset;
 import org.jfree.data.xy.IntervalXYDataset;
+import org.jfree.ui.RectangleAnchor;
 import org.jfree.ui.RectangleEdge;
 import org.jfree.ui.RectangleInsets;
+import org.jfree.ui.TextAnchor;
 
 /**
  * Builds the WHETGEO 1D state (Hovmoller-style) chart: an optional top/bottom
@@ -115,38 +124,66 @@ public static JPanel build( WhetgeoStateChartData data, String title ) {
         combinedPlot.setGap(12);
         boolean hasChartRow = false;
 
+        String topLabel = bcLabel("Top Boundary Condition", data.topBCType);
         double[] topDistinct = distinctSorted(data.topBCTimes.length > 0 ? data.topBCValues : new double[0]);
         if (data.topBCTimes.length > 0 && topDistinct.length > 1) {
-            combinedPlot.add(buildBCPlot("Top Boundary Condition", data.topBCTimes, data.topBCValues, TOP_BC_COLOR), 1);
+            combinedPlot.add(buildBCPlot(topLabel, data.topBCTimes, data.topBCValues, TOP_BC_COLOR), 1);
             hasChartRow = true;
         } else if (topDistinct.length == 1) {
-            addConstantValueRow(constantRows, "Top Boundary Condition", topDistinct[0]);
+            addConstantValueRow(constantRows, topLabel, topDistinct[0]);
         }
 
+        String bottomLabel = bcLabel("Bottom Boundary Condition", data.bottomBCType);
         double[] bottomDistinct = distinctSorted(data.bottomBCTimes.length > 0 ? data.bottomBCValues : new double[0]);
         if (data.bottomBCTimes.length > 0 && bottomDistinct.length > 1) {
-            combinedPlot.add(buildBCPlot("Bottom Boundary Condition", data.bottomBCTimes, data.bottomBCValues,
-                    BOTTOM_BC_COLOR), 1);
+            combinedPlot.add(buildBCPlot(bottomLabel, data.bottomBCTimes, data.bottomBCValues, BOTTOM_BC_COLOR), 1);
             hasChartRow = true;
         } else if (bottomDistinct.length == 1) {
-            addConstantValueRow(constantRows, "Bottom Boundary Condition", bottomDistinct[0]);
+            addConstantValueRow(constantRows, bottomLabel, bottomDistinct[0]);
         }
 
+        List<LayerBoundary> layerBoundaries = computeLayerBoundaries(data);
+        List<XYPlot> heatmapPlots = new ArrayList<>();
+
         List<PaintScaleLegend> legends = new ArrayList<>();
         for( int i = 0; i < data.depthSeries.size(); i++ ) {
             DepthSeries series = data.depthSeries.get(i);
             Color[] ramp = HEATMAP_RAMPS[i % HEATMAP_RAMPS.length];
             double[] bounds = valueBounds(series.values);
             PaintScale scale = new TwoColorPaintScale(bounds[0], bounds[1], ramp[0], ramp[1]);
 
-            combinedPlot.add(buildHeatmapPlot(series, scale), 2);
+            XYPlot heatmapPlot = buildHeatmapPlot(series, scale, layerBoundaries);
+            heatmapPlots.add(heatmapPlot);
+            combinedPlot.add(heatmapPlot, 2);
             hasChartRow = true;
             legends.add(buildLegend(series, scale, bounds));
         }
 
-        JPanel panel = new JPanel(new BorderLayout());
+        JPanel topArea = new JPanel();
+        topArea.setLayout(new BoxLayout(topArea, BoxLayout.Y_AXIS));
+        if (!layerBoundaries.isEmpty()) {
+            JCheckBox showAnnotationsCheck = new JCheckBox("Show layer annotations", true);
+            showAnnotationsCheck.setAlignmentX(JCheckBox.LEFT_ALIGNMENT);
+            showAnnotationsCheck.addActionListener(e -> {
+                boolean show = showAnnotationsCheck.isSelected();
+                for( XYPlot plot : heatmapPlots ) {
+                    plot.clearRangeMarkers();
+                    if (show) {
+                        addLayerBoundaryMarkers(plot, layerBoundaries);
+                    }
+                }
+            });
+            JPanel checkRow = new JPanel(new FlowLayout(FlowLayout.LEFT, 8, 4));
+            checkRow.add(showAnnotationsCheck);
+            topArea.add(checkRow);
+        }
         if (constantRows.getComponentCount() > 0) {
-            panel.add(constantRows, BorderLayout.NORTH);
+            topArea.add(constantRows);
+        }
+
+        JPanel panel = new JPanel(new BorderLayout());
+        if (topArea.getComponentCount() > 0) {
+            panel.add(topArea, BorderLayout.NORTH);
         }
         if (hasChartRow) {
             JFreeChart chart = new JFreeChart(title, JFreeChart.DEFAULT_TITLE_FONT, combinedPlot, false);
@@ -185,7 +222,7 @@ private static XYPlot buildBCPlot( String axisLabel, long[] times, double[] valu
         return plot;
     }
 
-    private static XYPlot buildHeatmapPlot( DepthSeries series, PaintScale scale ) {
+    private static XYPlot buildHeatmapPlot( DepthSeries series, PaintScale scale, List<LayerBoundary> layerBoundaries ) {
         double[] xValues = series.times.length > 0 ? toDoubleArray(series.times) : new double[0];
         double[] yValues = series.eta;
         double[] zValues = series.values;
@@ -210,9 +247,84 @@ private static XYPlot buildHeatmapPlot( DepthSeries series, PaintScale scale ) {
         plot.setRenderer(0, renderer);
         plot.setRangeAxis(0, depthAxis);
         plot.mapDatasetToRangeAxis(0, 0);
+
+        addLayerBoundaryMarkers(plot, layerBoundaries);
+
         return plot;
     }
 
+    /** Draws one dashed, labeled {@link ValueMarker} per layer boundary onto {@code plot} -
+     *  factored out so the "Show layer annotations" checkbox can call it again after {@code
+     *  plot.clearRangeMarkers()} without rebuilding the whole chart. */
+    private static void addLayerBoundaryMarkers( XYPlot plot, List<LayerBoundary> layerBoundaries ) {
+        for( LayerBoundary boundary : layerBoundaries ) {
+            ValueMarker marker = new ValueMarker(boundary.topEta);
+            marker.setPaint(Color.DARK_GRAY);
+            marker.setStroke(
+                    new BasicStroke(1f, BasicStroke.CAP_BUTT, BasicStroke.JOIN_MITER, 1f, new float[]{4f, 4f}, 0f));
+            marker.setLabel(boundary.label);
+            marker.setLabelFont(marker.getLabelFont().deriveFont(Font.PLAIN, 9f));
+            marker.setLabelPaint(Color.DARK_GRAY);
+            marker.setLabelAnchor(RectangleAnchor.TOP_LEFT);
+            marker.setLabelTextAnchor(TextAnchor.BOTTOM_LEFT);
+            marker.setLabelOffset(new RectangleInsets(2, 4, 2, 4));
+            plot.addRangeMarker(marker);
+        }
+    }
+
+    /**
+     * One value per internal transition between parameter sets in {@link
+     * WhetgeoStateChartData#gridEta}, each labeled with the SWRC parameters of the
+     * layer above that boundary - empty if the output wasn't written with {@code
+     * parameter_id}/{@code output_swrc_parameters} (see {@code
+     * Whetgeo1DOutputsHandler}), so older outputs just render without annotations.
+     *
+     * <p>
+     * {@code gridEta} holds cell *centers*, not layer edges, so the boundary itself
+     * is the midpoint between the last cell of the lower layer and the first cell
+     * of the layer above it - not either cell's own eta - otherwise the drawn line
+     * lands half a cell-thickness away from the real boundary (e.g. -1.01 instead
+     * of the true -1.00 for two 0.02 m-thick layers).
+     */
+    private static List<LayerBoundary> computeLayerBoundaries( WhetgeoStateChartData data ) {
+        List<LayerBoundary> boundaries = new ArrayList<>();
+        if (data.gridParameterID.length != data.gridEta.length || data.swrcParameters.isEmpty()) {
+            return boundaries;
+        }
+        Map<Integer, SwrcParams> byId = new HashMap<>();
+        for( SwrcParams p : data.swrcParameters ) {
+            byId.put(p.id, p);
+        }
+
+        // gridEta is ascending; a boundary exists wherever parameterID changes
+        // between two consecutive cells
+        for( int i = 1; i < data.gridEta.length; i++ ) {
+            int lowerID = data.gridParameterID[i - 1];
+            int upperID = data.gridParameterID[i];
+            if (lowerID == upperID) {
+                continue;
+            }
+            SwrcParams p = byId.get(upperID);
+            if (p == null) {
+                continue;
+            }
+            double boundaryEta = (data.gridEta[i - 1] + data.gridEta[i]) / 2.0;
+            String label = String.format("θS=%.3f  θR=%.3f  Ks=%.2e", p.thetaS, p.thetaR, p.ks);
+            boundaries.add(new LayerBoundary(boundaryEta, label));
+        }
+        return boundaries;
+    }
+
+    private static class LayerBoundary {
+        final double topEta;
+        final String label;
+
+        LayerBoundary( double topEta, String label ) {
+            this.topEta = topEta;
+            this.label = label;
+        }
+    }
+
     /**
      * Forces the same reserved width and the same tick number format on every sub-plot's range
      * axis - see the class javadoc for why that's needed for the shared time axis to actually
@@ -257,6 +369,14 @@ private static String formatConstant( double value ) {
         return String.valueOf(value);
     }
 
+    /** Appends the BC type (e.g. "TOP_COUPLED") to the label if the output was written with
+     *  one (see {@code Whetgeo1DOutputsHandler.TABLE_OUTPUT_METADATA}); a plain fallback
+     *  label otherwise, so a value alone doesn't have to stand in for what kind of condition
+     *  produced it. */
+    private static String bcLabel( String base, String bcType ) {
+        return bcType == null ? base : base + " (" + bcType + ")";
+    }
+
     private static double[] valueBounds( double[] values ) {
         double lowerBound = Arrays.stream(values).min().orElse(0);
         double upperBound = Arrays.stream(values).max().orElse(1);