teichmann@5863: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5863:  * Software engineering by Intevation GmbH
teichmann@5863:  *
teichmann@5994:  * This file is Free Software under the GNU AGPL (>=v3)
teichmann@5863:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5994:  * documentation coming with Dive4Elements River for details.
teichmann@5863:  */
teichmann@5863: 
teichmann@5831: package org.dive4elements.river.artifacts.states;
ingo@399: 
ingo@417: import java.util.ArrayList;
gernotbelger@9277: import java.util.Collections;
gernotbelger@9277: import java.util.Comparator;
ingo@399: import java.util.List;
ingo@399: 
ingo@399: import org.apache.log4j.Logger;
gernotbelger@9277: import org.dive4elements.artifactdatabase.ProtocolUtils;
gernotbelger@9277: import org.dive4elements.artifactdatabase.data.StateData;
teichmann@5831: import org.dive4elements.artifacts.Artifact;
teichmann@5831: import org.dive4elements.artifacts.CallContext;
teichmann@5831: import org.dive4elements.artifacts.common.utils.XMLUtils;
gernotbelger@9277: import org.dive4elements.river.artifacts.D4EArtifact;
teichmann@5831: import org.dive4elements.river.artifacts.access.RangeAccess;
gernotbelger@9277: import org.dive4elements.river.artifacts.model.RangeWithValues;
gernotbelger@9277: import org.dive4elements.river.artifacts.model.WstFactory;
teichmann@5831: import org.dive4elements.river.model.Gauge;
teichmann@5831: import org.dive4elements.river.model.Range;
teichmann@5831: import org.dive4elements.river.model.River;
teichmann@5831: import org.dive4elements.river.model.Wst;
teichmann@5865: import org.dive4elements.river.utils.RiverUtils;
gernotbelger@9277: import org.w3c.dom.Element;
ingo@399: 
ingo@399: /**
felix@3635:  * State to input W/Q data.
gernotbelger@9277:  *
ingo@399:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@399:  */
ingo@399: public class WQAdapted extends DefaultState {
ingo@399: 
gernotbelger@9277:     /** The log used in this state. */
teichmann@8202:     private static Logger log = Logger.getLogger(WQAdapted.class);
ingo@399: 
ingo@2423:     public static final String FIELD_WQ_MODE = "wq_isq";
ingo@401: 
ingo@401:     public static final String FIELD_WQ_VALUES = "wq_values";
ingo@401: 
sascha@636:     public static final class GaugeOrder implements Comparator<Gauge> {
gernotbelger@9277:         private final int order;
sascha@636: 
gernotbelger@9277:         public GaugeOrder(final boolean up) {
gernotbelger@9277:             this.order = up ? 1 : -1;
sascha@636:         }
sascha@636: 
gernotbelger@9277:         @Override
gernotbelger@9277:         public int compare(final Gauge a, final Gauge b) {
gernotbelger@9277:             return this.order * a.getRange().getA().compareTo(b.getRange().getA());
sascha@636:         }
sascha@636:     } // class GaugeOrder
sascha@636: 
gernotbelger@9277:     public static final GaugeOrder GAUGE_UP = new GaugeOrder(true);
sascha@636:     public static final GaugeOrder GAUGE_DOWN = new GaugeOrder(false);
ingo@401: 
felix@3635:     /** Trivial, empty constructor. */
sascha@660:     public WQAdapted() {
sascha@660:     }
sascha@660: 
ingo@399:     /**
tom@8856:      * This method creates one element for each gauge of selected river that
ingo@399:      * is intersected by the given kilometer range. Each element is a tuple of
tom@8856:      * (from;to) where <i>from</i> is the lower bounds of the gauge or
tom@8856:      * the lower
ingo@399:      * kilometer range. <i>to</i> is the upper bounds of the gauge or the upper
ingo@399:      * kilometer range.
ingo@399:      *
gernotbelger@9277:      * @param cr
gernotbelger@9277:      *            The ElementCreator.
gernotbelger@9277:      * @param artifact
gernotbelger@9277:      *            The FLYS artifact.
gernotbelger@9277:      * @param name
gernotbelger@9277:      *            The name of the data item.
gernotbelger@9277:      * @param context
gernotbelger@9277:      *            The CallContext.
ingo@399:      *
ingo@399:      * @return a list of elements that consist of tuples of the intersected
gernotbelger@9277:      *         gauges of the selected river.
ingo@399:      */
sascha@660:     @Override
gernotbelger@9277:     protected Element[] createItems(final XMLUtils.ElementCreator cr, final Artifact artifact, final String name, final CallContext context) {
teichmann@8202:         log.debug("WQAdapted.createItems");
ingo@399: 
ingo@401:         if (name != null && name.equals(FIELD_WQ_MODE)) {
ingo@401:             return createModeItems(cr, artifact, name, context);
gernotbelger@9277:         } else if (name != null && name.equals(FIELD_WQ_VALUES)) {
ingo@401:             return createValueItems(cr, artifact, name, context);
gernotbelger@9277:         } else {
teichmann@8202:             log.warn("Unknown data object: " + name);
ingo@401:             return null;
ingo@401:         }
ingo@401:     }
ingo@401: 
felix@3635:     /** Creates "Q" and "W" items. */
gernotbelger@9277:     protected Element[] createModeItems(final XMLUtils.ElementCreator cr, final Artifact artifact, final String name, final CallContext context) {
teichmann@8202:         log.debug("WQAdapted.createModeItems");
ingo@401: 
gernotbelger@9277:         final Element w = createItem(cr, new String[] { "w", "W" });
gernotbelger@9277:         final Element q = createItem(cr, new String[] { "q", "Q" });
ingo@401: 
ingo@401:         return new Element[] { w, q };
ingo@401:     }
ingo@401: 
felix@5107:     /** Create the items for input to the ranges per mode. */
gernotbelger@9277:     protected Element[] createValueItems(final XMLUtils.ElementCreator cr, final Artifact artifact, final String name, final CallContext context) {
teichmann@8202:         log.debug("WQAdapted.createValueItems");
ingo@401: 
gernotbelger@9277:         final D4EArtifact flysArtifact = (D4EArtifact) artifact;
ingo@399: 
gernotbelger@9277:         final RangeAccess rangeAccess = new RangeAccess(flysArtifact);
gernotbelger@9277:         final double[] dist = rangeAccess.getKmRange();
felix@4855:         // TODO use Access to get River and gauges.
gernotbelger@9277:         final River river = RiverUtils.getRiver(flysArtifact);
gernotbelger@9277:         final Wst wst = WstFactory.getWst(river);
gernotbelger@9277:         final List<Gauge> gauges = RiverUtils.getGauges(flysArtifact);
ingo@399: 
gernotbelger@9277:         final int num = gauges != null ? gauges.size() : 0;
ingo@399: 
ingo@399:         if (num == 0) {
teichmann@8202:             log.warn("Selected distance matches no gauges.");
ingo@399:             return null;
ingo@399:         }
ingo@399: 
gernotbelger@9277:         final List<Element> elements = new ArrayList<>();
ingo@399: 
sascha@636:         double rangeFrom = dist[0];
gernotbelger@9277:         double rangeTo = dist[1];
sascha@636: 
sascha@636:         if (rangeFrom < rangeTo) {
sascha@636:             Collections.sort(gauges, GAUGE_UP);
gernotbelger@9277:             for (final Gauge gauge : gauges) {
gernotbelger@9277:                 final Range range = gauge.getRange();
gernotbelger@9277:                 final double lower = range.getA().doubleValue();
gernotbelger@9277:                 final double upper = range.getB().doubleValue();
ingo@399: 
felix@3635:                 // If gauge out of range, skip it.
felix@3635:                 if (upper <= rangeFrom || lower >= rangeTo) {
felix@3635:                     continue;
felix@3635:                 }
felix@3635: 
gernotbelger@9277:                 final double from = lower < rangeFrom ? rangeFrom : lower;
gernotbelger@9277:                 final double to = upper > rangeTo ? rangeTo : upper;
ingo@681: 
gernotbelger@9277:                 final double[] mmQ = determineMinMaxQ(gauge, wst);
gernotbelger@9277:                 final double[] mmW = gauge.determineMinMaxW();
gernotbelger@9277: 
gernotbelger@9277:                 elements.add(createItem(cr, new String[] { from + ";" + to, gauge.getName() }, mmQ, mmW));
sascha@636:             }
gernotbelger@9277:         } else {
sascha@636:             Collections.sort(gauges, GAUGE_DOWN);
sascha@642:             rangeFrom = dist[1];
gernotbelger@9277:             rangeTo = dist[0];
gernotbelger@9277:             for (final Gauge gauge : gauges) {
gernotbelger@9277:                 final Range range = gauge.getRange();
gernotbelger@9277:                 final double lower = range.getA().doubleValue();
gernotbelger@9277:                 final double upper = range.getB().doubleValue();
ingo@399: 
gernotbelger@9277:                 final double from = lower < rangeFrom ? rangeFrom : lower;
gernotbelger@9277:                 final double to = upper > rangeTo ? rangeTo : upper;
sascha@636: 
felix@3635:                 // TODO probably need to continue out if oof range (see above).
felix@3635: 
gernotbelger@9277:                 final double[] mmQ = determineMinMaxQ(gauge, wst);
gernotbelger@9277:                 final double[] mmW = gauge.determineMinMaxW();
ingo@724: 
gernotbelger@9277:                 elements.add(createItem(cr, new String[] { to + ";" + from, gauge.getName() }, mmQ, mmW));
sascha@636:             }
ingo@399:         }
ingo@399: 
gernotbelger@9277:         final Element[] els = new Element[elements.size()];
felix@3635:         return elements.toArray(els);
ingo@399:     }
ingo@399: 
gernotbelger@9277:     // dead code!
gernotbelger@9277:     // protected Element createItem(XMLUtils.ElementCreator cr, Object obj) {
gernotbelger@9277:     // return createItem(cr, obj, null, null);
gernotbelger@9277:     // }
ingo@681: 
felix@5335:     /** In obj: 0 is label, 1 is value. */
gernotbelger@9277:     protected Element createItem(final XMLUtils.ElementCreator cr, final Object obj, final double[] q, final double[] w) {
gernotbelger@9277:         final Element item = ProtocolUtils.createArtNode(cr, "item", null, null);
gernotbelger@9277:         final Element label = ProtocolUtils.createArtNode(cr, "label", null, null);
gernotbelger@9277:         final Element value = ProtocolUtils.createArtNode(cr, "value", null, null);
ingo@399: 
gernotbelger@9277:         final String[] arr = (String[]) obj;
ingo@399: 
ingo@399:         label.setTextContent(arr[0]);
ingo@399:         value.setTextContent(arr[1]);
ingo@399: 
ingo@399:         item.appendChild(label);
ingo@399:         item.appendChild(value);
ingo@399: 
ingo@681:         if (q != null) {
gernotbelger@9277:             final Element qRange = createRangeElement(cr, q, "Q");
ingo@681:             item.appendChild(qRange);
ingo@681:         }
ingo@681: 
ingo@681:         if (w != null) {
gernotbelger@9277:             final Element wRange = createRangeElement(cr, w, "W");
ingo@681:             item.appendChild(wRange);
ingo@681:         }
ingo@681: 
ingo@399:         return item;
ingo@399:     }
ingo@399: 
gernotbelger@9277:     protected Element createRangeElement(final XMLUtils.ElementCreator cr, final double[] mm, final String type) {
gernotbelger@9277:         final Element range = ProtocolUtils.createArtNode(cr, "range", new String[] { "type" }, new String[] { type });
ingo@399: 
gernotbelger@9277:         final Element min = ProtocolUtils.createArtNode(cr, "min", null, null);
ingo@681:         min.setTextContent(String.valueOf(mm[0]));
ingo@681: 
gernotbelger@9277:         final Element max = ProtocolUtils.createArtNode(cr, "max", null, null);
ingo@681:         max.setTextContent(String.valueOf(mm[1]));
ingo@681: 
ingo@681:         range.appendChild(min);
ingo@681:         range.appendChild(max);
ingo@681: 
ingo@681:         return range;
ingo@681:     }
ingo@681: 
ingo@681:     /**
ingo@681:      * Determines the min and max Q value for the given gauge. If no min and
ingo@681:      * max values could be determined, this method will return
ingo@681:      * [Double.MIN_VALUE, Double.MAX_VALUE].
ingo@681:      *
ingo@681:      * @param gauge
ingo@681:      * @param wst
ingo@681:      *
ingo@681:      * @return the min and max Q values for the given gauge.
ingo@681:      */
gernotbelger@9277:     protected double[] determineMinMaxQ(final Gauge gauge, final Wst wst) {
teichmann@8202:         log.debug("WQAdapted.determineMinMaxQ");
ingo@681: 
gernotbelger@9277:         final double[] minmaxQ = gauge != null ? wst.determineMinMaxQ(gauge.getRange()) : null;
ingo@681: 
gernotbelger@9277:         final double minQ = minmaxQ != null ? minmaxQ[0] : Double.MIN_VALUE;
gernotbelger@9277:         final double maxQ = minmaxQ != null ? minmaxQ[1] : Double.MAX_VALUE;
ingo@681: 
ingo@681:         return new double[] { minQ, maxQ };
ingo@681:     }
ingo@681: 
felix@5638:     /** Indicate client which input elements to use. */
ingo@399:     @Override
ingo@399:     protected String getUIProvider() {
ingo@399:         return "wq_panel_adapted";
ingo@399:     }
ingo@417: 
sascha@660:     @Override
gernotbelger@9277:     public boolean validate(final Artifact artifact) throws IllegalArgumentException {
teichmann@8202:         log.debug("WQAdapted.validate");
ingo@417: 
gernotbelger@9277:         final D4EArtifact flys = (D4EArtifact) artifact;
gernotbelger@9277:         final StateData data = getData(flys, FIELD_WQ_MODE);
ingo@417: 
gernotbelger@9277:         final String mode = data != null ? (String) data.getValue() : null;
gernotbelger@9277:         final boolean isQ = mode != null ? Boolean.valueOf(mode) : false;
ingo@417: 
ingo@2422:         if (!isQ) {
sascha@1050:             return validateW(artifact);
gernotbelger@9277:         } else if (isQ) {
sascha@1050:             return validateQ(artifact);
gernotbelger@9277:         } else {
gernotbelger@9277:             throw new IllegalArgumentException("error_feed_no_wq_mode_selected");
ingo@417:         }
ingo@417:     }
ingo@417: 
gernotbelger@9277:     protected boolean validateW(final Artifact artifact) throws IllegalArgumentException {
gernotbelger@9277:         log.debug("WQAdapted.validateW");
gernotbelger@9277:         final D4EArtifact flys = (D4EArtifact) artifact;
ingo@417: 
gernotbelger@9277:         final RangeWithValues[] rwvs = extractInput(getData(flys, "wq_values"));
ingo@624: 
ingo@624:         if (rwvs == null) {
ingo@624:             throw new IllegalArgumentException("error_missing_wq_data");
ingo@624:         }
ingo@624: 
gernotbelger@9277:         final List<Gauge> gauges = RiverUtils.getGauges((D4EArtifact) artifact);
ingo@417: 
gernotbelger@9277:         for (final Gauge gauge : gauges) {
gernotbelger@9277:             final Range range = gauge.getRange();
gernotbelger@9277:             final double lower = range.getA().doubleValue();
gernotbelger@9277:             final double upper = range.getB().doubleValue();
ingo@417: 
gernotbelger@9277:             for (final RangeWithValues rwv : rwvs) {
sascha@3744:                 if (lower <= rwv.getStart() && upper >= rwv.getEnd()) {
ingo@417:                     compareWsWithGauge(gauge, rwv.getValues());
ingo@417:                 }
ingo@417:             }
ingo@417:         }
ingo@417: 
ingo@417:         return true;
ingo@417:     }
ingo@417: 
gernotbelger@9277:     protected boolean validateQ(final Artifact artifact) throws IllegalArgumentException {
gernotbelger@9277:         log.debug("WQAdapted.validateQ");
gernotbelger@9277:         final D4EArtifact flys = (D4EArtifact) artifact;
ingo@417: 
gernotbelger@9277:         final RangeWithValues[] rwvs = extractInput(getData(flys, "wq_values"));
ingo@624: 
ingo@624:         if (rwvs == null) {
ingo@624:             throw new IllegalArgumentException("error_missing_wq_data");
ingo@624:         }
ingo@624: 
gernotbelger@9277:         final List<Gauge> gauges = RiverUtils.getGauges(flys);
gernotbelger@9277:         final River river = RiverUtils.getRiver(flys);
gernotbelger@9277:         final Wst wst = WstFactory.getWst(river);
ingo@417: 
gernotbelger@9277:         for (final Gauge gauge : gauges) {
gernotbelger@9277:             final Range range = gauge.getRange();
gernotbelger@9277:             final double lower = range.getA().doubleValue();
gernotbelger@9277:             final double upper = range.getB().doubleValue();
ingo@417: 
gernotbelger@9277:             for (final RangeWithValues rwv : rwvs) {
sascha@3744:                 if (lower <= rwv.getStart() && upper >= rwv.getEnd()) {
ingo@417:                     compareQsWithGauge(wst, gauge, rwv.getValues());
ingo@417:                 }
ingo@417:             }
ingo@417:         }
ingo@417: 
ingo@417:         return true;
ingo@417:     }
ingo@417: 
gernotbelger@9277:     protected boolean compareQsWithGauge(final Wst wst, final Gauge gauge, final double[] qs) throws IllegalArgumentException {
gernotbelger@9277:         final double[] minmax = gauge != null ? wst.determineMinMaxQ(gauge.getRange()) : null;
ingo@417: 
ingo@417:         if (minmax == null) {
teichmann@8202:             log.warn("Could not determine min/max Q of gauge.");
ingo@417:             return true;
ingo@417:         }
ingo@417: 
teichmann@8202:         if (log.isDebugEnabled()) {
teichmann@8202:             log.debug("Validate Qs with:");
teichmann@8202:             log.debug("-- Gauge: " + gauge.getName());
teichmann@8202:             log.debug("-- Gauge min: " + minmax[0]);
teichmann@8202:             log.debug("-- Gauge max: " + minmax[1]);
ingo@417:         }
ingo@417: 
gernotbelger@9277:         for (final double q : qs) {
ingo@417:             if (q < minmax[0] || q > minmax[1]) {
gernotbelger@9277:                 throw new IllegalArgumentException("error_feed_q_values_invalid");
ingo@417:             }
ingo@417:         }
ingo@417: 
ingo@417:         return true;
ingo@417:     }
ingo@417: 
gernotbelger@9277:     protected boolean compareWsWithGauge(final Gauge gauge, final double[] ws) throws IllegalArgumentException {
gernotbelger@9277:         final double[] minmax = gauge != null ? gauge.determineMinMaxW() : null;
ingo@417: 
ingo@417:         if (minmax == null) {
teichmann@8202:             log.warn("Could not determine min/max W of gauge.");
ingo@417:             return true;
ingo@417:         }
ingo@417: 
teichmann@8202:         if (log.isDebugEnabled()) {
teichmann@8202:             log.debug("Validate Ws with:");
teichmann@8202:             log.debug("-- Gauge: " + gauge.getName());
teichmann@8202:             log.debug("-- Gauge min: " + minmax[0]);
teichmann@8202:             log.debug("-- Gauge max: " + minmax[1]);
ingo@417:         }
ingo@417: 
gernotbelger@9277:         for (final double w : ws) {
ingo@417:             if (w < minmax[0] || w > minmax[1]) {
gernotbelger@9277:                 throw new IllegalArgumentException("error_feed_w_values_invalid");
ingo@417:             }
ingo@417:         }
ingo@417: 
ingo@417:         return true;
ingo@417:     }
ingo@417: 
gernotbelger@9277:     protected RangeWithValues[] extractInput(final StateData data) {
ingo@624:         if (data == null) {
ingo@624:             return null;
ingo@624:         }
ingo@624: 
gernotbelger@9277:         final String dataString = (String) data.getValue();
gernotbelger@9277:         final String[] ranges = dataString.split(":");
ingo@417: 
gernotbelger@9277:         final List<RangeWithValues> rwv = new ArrayList<>();
ingo@417: 
gernotbelger@9277:         for (final String range : ranges) {
gernotbelger@9277:             final String[] parts = range.split(";");
ingo@417: 
gernotbelger@9277:             final double lower = Double.parseDouble(parts[0]);
gernotbelger@9277:             final double upper = Double.parseDouble(parts[1]);
ingo@417: 
gernotbelger@9277:             final String[] values = parts[3].split(",");
gernotbelger@9277: 
gernotbelger@9277:             final int num = values.length;
gernotbelger@9277:             final double[] res = new double[num];
ingo@417: 
ingo@417:             for (int i = 0; i < num; i++) {
ingo@417:                 try {
ingo@417:                     res[i] = Double.parseDouble(values[i]);
ingo@417:                 }
gernotbelger@9277:                 catch (final NumberFormatException nfe) {
teichmann@8202:                     log.warn(nfe, nfe);
ingo@417:                 }
ingo@417:             }
ingo@417: 
ingo@417:             rwv.add(new RangeWithValues(lower, upper, res));
ingo@417:         }
ingo@417: 
sascha@3452:         return rwv.toArray(new RangeWithValues[rwv.size()]);
ingo@417:     }
ingo@399: }
ingo@399: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :