mschaefer@9176: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
mschaefer@9176:  * Software engineering by
mschaefer@9176:  *  Björnsen Beratende Ingenieure GmbH
mschaefer@9176:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
mschaefer@9176:  *
mschaefer@9176:  * This file is Free Software under the GNU AGPL (>=v3)
mschaefer@9176:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
mschaefer@9176:  * documentation coming with Dive4Elements River for details.
mschaefer@9176:  */
mschaefer@9176: package org.dive4elements.river.artifacts.sinfo.common;
mschaefer@9176: 
mschaefer@9176: import java.util.Map.Entry;
mschaefer@9176: import java.util.NavigableMap;
mschaefer@9176: import java.util.TreeMap;
mschaefer@9176: 
mschaefer@9176: import org.dive4elements.river.artifacts.model.Calculation;
mschaefer@9176: import org.dive4elements.river.model.Gauge;
mschaefer@9176: import org.dive4elements.river.model.MainValue;
mschaefer@9176: import org.dive4elements.river.model.MainValueType.MainValueTypeKey;
mschaefer@9176: 
mschaefer@9176: /**
mschaefer@9176:  * Loading and search the main values of a gauge to find and build a name
mschaefer@9176:  *
mschaefer@9176:  * @author Matthias Schäfer
mschaefer@9176:  *
mschaefer@9176:  */
mschaefer@9176: public final class GaugeMainValueNameFinder {
mschaefer@9176: 
mschaefer@9176:     /***** FIELDS *****/
mschaefer@9176: 
mschaefer@9176:     // private static Logger log = Logger.getLogger(GaugeMainValueNameFinder.class);
mschaefer@9176: 
mschaefer@9176:     private final Gauge gauge;
mschaefer@9176: 
mschaefer@9176:     private Calculation problems;
mschaefer@9176: 
mschaefer@9176:     private final NavigableMap<Double, MainValue> mainValues;
mschaefer@9176: 
gernotbelger@9195:     private final String approxPrefix = "\u2248";// "ca.";
mschaefer@9176: 
mschaefer@9176:     /***** CONSTRUCTORS *****/
mschaefer@9176: 
mschaefer@9176:     private GaugeMainValueNameFinder(final MainValueTypeKey type, final Gauge gauge, final Calculation problems) {
mschaefer@9176:         this.gauge = gauge;
mschaefer@9176:         this.problems = problems;
mschaefer@9176:         this.mainValues = new TreeMap<>();
mschaefer@9176:         for (final MainValue mainValue : MainValue.getValuesOfGaugeAndType(gauge, type))
mschaefer@9176:             this.mainValues.put(Double.valueOf(mainValue.getValue().doubleValue()), mainValue);
mschaefer@9176:         if (this.mainValues.isEmpty() && (this.problems != null)) {
mschaefer@9176:             this.problems.addProblem("gauge_main_values.missing", gauge.getName());
mschaefer@9176:             // Report only once
mschaefer@9176:             this.problems = null;
mschaefer@9176:         }
mschaefer@9176:     }
mschaefer@9176: 
mschaefer@9176:     /***** METHODS *****/
mschaefer@9176: 
mschaefer@9176:     /**
mschaefer@9176:      * Loads the the main values table of a type and a gauge (GAUGE.glt)
mschaefer@9176:      *
mschaefer@9176:      * @return The main values finder of a type and a gauge, or null
mschaefer@9176:      */
mschaefer@9176:     public static GaugeMainValueNameFinder loadValues(final MainValueTypeKey type, final Gauge gauge, final Calculation problems) {
mschaefer@9176:         return new GaugeMainValueNameFinder(type, gauge, problems);
mschaefer@9176:     }
mschaefer@9176: 
mschaefer@9176:     /**
mschaefer@9176:      * If this provider may return valid data at all.
mschaefer@9176:      */
mschaefer@9176:     public boolean isValid() {
mschaefer@9176:         return (this.mainValues != null);
mschaefer@9176:     }
mschaefer@9176: 
mschaefer@9176:     /**
mschaefer@9176:      * Main value zone for a value.
mschaefer@9176:      */
mschaefer@9176:     public String getZoneName(final double value) {
mschaefer@9176:         if (!this.isValid())
mschaefer@9176:             return "";
mschaefer@9176:         if (Double.isNaN(value))
mschaefer@9176:             return "";
mschaefer@9176: 
mschaefer@9176:         // Exact match
mschaefer@9176:         if (this.mainValues.containsKey(Double.valueOf(value)))
mschaefer@9176:             return this.mainValues.get(Double.valueOf(value)).getMainValue().getName();
mschaefer@9176: 
mschaefer@9176:         // Clearly below or just (max. 10%) below lowest named value
mschaefer@9176:         final Entry<Double, MainValue> lowerZone = this.mainValues.floorEntry(Double.valueOf(value));
mschaefer@9176:         if (lowerZone == null) {
mschaefer@9176:             if (value >= this.mainValues.firstKey().doubleValue() * 0.9)
mschaefer@9176:                 return this.approxPrefix + this.mainValues.firstEntry().getValue().getMainValue().getName();
mschaefer@9176:             else
mschaefer@9176:                 return "<" + this.mainValues.firstEntry().getValue().getMainValue().getName();
mschaefer@9176:         }
mschaefer@9176: 
mschaefer@9176:         // Clearly above or just (max. 10%) above highest named value
mschaefer@9176:         final Entry<Double, MainValue> higherZone = this.mainValues.ceilingEntry(Double.valueOf(value));
mschaefer@9176:         if (higherZone == null) {
mschaefer@9176:             if (value <= this.mainValues.lastKey().doubleValue() * 1.1)
mschaefer@9176:                 return this.approxPrefix + this.mainValues.lastEntry().getValue().getMainValue().getName();
mschaefer@9176:             else
mschaefer@9176:                 return ">" + this.mainValues.lastEntry().getValue().getMainValue().getName();
mschaefer@9176:         }
mschaefer@9176: 
mschaefer@9176:         // Near (10%) one of the borders of a zone interval, or clearly within a zone
mschaefer@9176:         if (value <= lowerZone.getKey().doubleValue() * 1.1)
mschaefer@9176:             return this.approxPrefix + lowerZone.getValue().getMainValue().getName();
mschaefer@9176:         else if (value >= higherZone.getKey().doubleValue() * 0.9)
mschaefer@9176:             return this.approxPrefix + higherZone.getValue().getMainValue().getName();
mschaefer@9176:         else
mschaefer@9176:             return lowerZone.getValue().getMainValue().getName() + "-" + higherZone.getValue().getMainValue().getName();
mschaefer@9176:     }
mschaefer@9176: }