gernotbelger@8942: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8942:  * Software engineering by
gernotbelger@8942:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8942:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8942:  *
gernotbelger@8942:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8942:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8942:  * documentation coming with Dive4Elements River for details.
gernotbelger@8942:  */
gernotbelger@8942: package org.dive4elements.river.artifacts.sinfo.tkhstate;
gernotbelger@8942: 
gernotbelger@8942: import java.util.ArrayList;
gernotbelger@8942: import java.util.Collection;
gernotbelger@8942: import java.util.Collections;
gernotbelger@8942: import java.util.List;
gernotbelger@8942: 
gernotbelger@8942: import org.apache.commons.lang.math.NumberRange;
gernotbelger@8942: import org.dive4elements.river.artifacts.model.Calculation;
gernotbelger@9211: import org.dive4elements.river.artifacts.sinfo.tkhstate.DefaultBedHeightsConfig.DefaultBedHeight;
gernotbelger@8942: import org.dive4elements.river.model.BedHeight;
gernotbelger@8942: import org.dive4elements.river.model.Range;
gernotbelger@8942: import org.dive4elements.river.model.River;
gernotbelger@8942: 
gernotbelger@8942: /**
mschaefer@9394:  * This class knows how to find the default bed heights defined for tkh and other calculations
gernotbelger@8942:  *
gernotbelger@8942:  * @author Gernot Belger
gernotbelger@8942:  */
mschaefer@9394: public final class DefaultBedHeights {
gernotbelger@9211: 
gernotbelger@8942:     private final River river;
gernotbelger@8942: 
gernotbelger@8942:     public DefaultBedHeights(final River river) {
gernotbelger@8942:         this.river = river;
gernotbelger@8942:     }
gernotbelger@8942: 
gernotbelger@8942:     public List<BedHeight> getBedHeights(final Calculation problems) {
gernotbelger@9211:         final Collection<DefaultBedHeight> defaults = DefaultBedHeightsConfig.getDefaults(this.river, problems);
gernotbelger@8942: 
gernotbelger@9211:         final List<BedHeight> defaultBedHeights = loadBedHeightsByName(this.river, defaults, problems);
gernotbelger@9129:         if (defaultBedHeights.isEmpty()) {
gernotbelger@9129:             problems.addProblem("sinfo.bedheightsfinder.nobedheightsforriver", this.river.getName());
gernotbelger@9129:             return Collections.emptyList();
gernotbelger@9129:         }
gernotbelger@9129: 
gernotbelger@9129:         /* check for overlapping ranges, N2-search, but we expect only have small numbers of bed heights */
gernotbelger@9129:         final List<BedHeight> result = new ArrayList<>(defaultBedHeights.size());
gernotbelger@9129: 
gernotbelger@9129:         for (int i = 0; i < defaultBedHeights.size(); i++) {
gernotbelger@9129:             final BedHeight bedHeight = defaultBedHeights.get(i);
gernotbelger@9129: 
gernotbelger@9129:             final Range range = bedHeight.getRange();
gernotbelger@9129:             final NumberRange bedRange = new NumberRange(range.getA(), range.getB());
gernotbelger@9129: 
gernotbelger@9211:             if (overlapsRange(bedRange, defaultBedHeights, i + 1))
gernotbelger@9129:                 problems.addProblem("sinfo.bedheightsfinder.overlappingrange", bedHeight.getDescription());
gernotbelger@9211:             else
gernotbelger@9129:                 result.add(bedHeight);
gernotbelger@9129:         }
gernotbelger@8942: 
gernotbelger@8942:         final List<BedHeight> validBedHeights = new ArrayList<>(defaultBedHeights.size());
gernotbelger@8942: 
gernotbelger@8942:         // REMARK: check for bad ranges because db schema allow for incomplete ranges, and ignore if this is the case
gernotbelger@8942:         for (final BedHeight bedHeight : defaultBedHeights) {
gernotbelger@8942: 
gernotbelger@8942:             final Range range = bedHeight.getRange();
gernotbelger@8942: 
gernotbelger@8942:             if (range.getA() == null || range.getB() == null)
gernotbelger@8942:                 problems.addProblem("sinfo.bedheightsfinder.badrange", bedHeight.getDescription());
gernotbelger@8942:             else
gernotbelger@8942:                 validBedHeights.add(bedHeight);
gernotbelger@8942:         }
gernotbelger@8942: 
gernotbelger@8942:         return result;
gernotbelger@8942:     }
gernotbelger@8942: 
gernotbelger@8942: 
gernotbelger@9211:     private static List<BedHeight> loadBedHeightsByName(final River river, final Collection<DefaultBedHeight> defaults, final Calculation problems) {
gernotbelger@8942: 
gernotbelger@9211:         final List<BedHeight> bedHeights = new ArrayList<>(defaults.size());
gernotbelger@8942: 
gernotbelger@9211:         for (final DefaultBedHeight heightDefault : defaults) {
gernotbelger@9211: 
gernotbelger@9211:             final String description = heightDefault.description;
gernotbelger@8942:             try {
gernotbelger@9211: 
gernotbelger@9211:                 final BedHeight bedHeight = BedHeight.getBedHeightByDescription(river, description, heightDefault.startKm, heightDefault.endKm);
gernotbelger@8942:                 if (bedHeight == null)
gernotbelger@9211:                     problems.addProblem("sinfo.bedheightsfinder.missingdescription", river.getName(), description);
gernotbelger@9087:                 else
gernotbelger@9087:                     bedHeights.add(bedHeight);
gernotbelger@8942:             }
gernotbelger@8942:             catch (final Exception e) {
gernotbelger@8942:                 e.printStackTrace();
gernotbelger@9211:                 problems.addProblem("sinfo.bedheightsfinder.missingdescription", river.getName(), description);
gernotbelger@8942:             }
gernotbelger@8942:         }
gernotbelger@8942: 
gernotbelger@8942:         return bedHeights;
gernotbelger@8942:     }
gernotbelger@8942: 
gernotbelger@8942:     private static boolean overlapsRange(final NumberRange bedRange, final List<BedHeight> result, final int startIndex) {
gernotbelger@8942: 
gernotbelger@8942:         for (int i = startIndex; i < result.size(); i++) {
gernotbelger@8942: 
gernotbelger@8942:             final BedHeight compareBed = result.get(i);
gernotbelger@8942:             final Range range = compareBed.getRange();
gernotbelger@8942:             final NumberRange compareRange = new NumberRange(range.getA(), range.getB());
gernotbelger@8942: 
gernotbelger@8942:             if (compareRange.overlapsRange(bedRange))
gernotbelger@8942:                 return true;
gernotbelger@8942:         }
gernotbelger@8942: 
gernotbelger@8942:         return false;
gernotbelger@8942:     }
gernotbelger@8942: }