gernotbelger@8854: /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@8854:  * Software engineering by 
gernotbelger@8854:  *  Björnsen Beratende Ingenieure GmbH 
gernotbelger@8854:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8854:  *
gernotbelger@8854:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8854:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8854:  * documentation coming with Dive4Elements River for details.
gernotbelger@8854:  */
gernotbelger@8854: package org.dive4elements.river.artifacts.sinfo.flowdepth;
gernotbelger@8854: 
gernotbelger@8854: import java.util.Collection;
gernotbelger@8854: import java.util.List;
gernotbelger@8854: 
gernotbelger@8854: import org.dive4elements.artifacts.CallContext;
gernotbelger@8854: import org.dive4elements.river.artifacts.BedHeightsArtifact;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.Calculation;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.CalculationResult;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.LocationProvider;
gernotbelger@8854: import org.dive4elements.river.artifacts.model.WKms;
gernotbelger@8854: import org.dive4elements.river.artifacts.resources.Resources;
gernotbelger@8854: import org.dive4elements.river.artifacts.sinfo.SINFOArtifact;
gernotbelger@8854: import org.dive4elements.river.artifacts.sinfo.flowdepth.FlowDepthAccess.DifferencesPair;
gernotbelger@8854: import org.dive4elements.river.artifacts.states.WDifferencesState;
gernotbelger@8854: import org.dive4elements.river.model.BedHeight;
gernotbelger@8854: import org.dive4elements.river.model.Gauge;
gernotbelger@8854: import org.dive4elements.river.model.River;
gernotbelger@8854: import org.dive4elements.river.utils.GaugeIndex;
gernotbelger@8854: import org.dive4elements.river.utils.RiverUtils;
gernotbelger@8854: 
gernotbelger@8854: class FlowDepthCalculation {
gernotbelger@8854: 
gernotbelger@8854:     private static final String CSV_NOT_IN_GAUGE_RANGE = "export.waterlevel.csv.not.in.gauge.range";
gernotbelger@8854: 
gernotbelger@8854: 	private CallContext context;
gernotbelger@8854: 
gernotbelger@8854: 	public FlowDepthCalculation( final CallContext context ) {
gernotbelger@8854: 		this.context = context;
gernotbelger@8854: 	}
gernotbelger@8854: 	
gernotbelger@8854:     public CalculationResult calculate(final SINFOArtifact sinfo) {
gernotbelger@8854:     	
gernotbelger@8863:         // FIXME: find user of this artifact; probably only possible by selecting the collection that contains this artifact...
gernotbelger@8863:         final String user = "unbekannt";
gernotbelger@8863:         
gernotbelger@8854:     	/* access input data */
gernotbelger@8854:     	final FlowDepthAccess access = new FlowDepthAccess(sinfo);
gernotbelger@8854:     	final River river = access.getRiver();
gernotbelger@8854:     	
gernotbelger@8854:     	final Collection<DifferencesPair> diffPairs = access.getDifferencePairs();
gernotbelger@8854:     	
gernotbelger@8854: 		final double from = access.getFrom();
gernotbelger@8854: 		final double to = access.getTo();
gernotbelger@8854: 
gernotbelger@8854:     	final boolean useTkh = access.isUseTransportBodies();
gernotbelger@8854: 
gernotbelger@8854:     	/* calculate results for each diff pair */
gernotbelger@8854:     	final Calculation problems = new Calculation();
gernotbelger@8854: 
gernotbelger@8854:     	final List<Gauge> gauges = river.determineGauges(from, to);
gernotbelger@8854:     	final GaugeIndex gaugeIndex = new GaugeIndex(gauges);
gernotbelger@8854: 
gernotbelger@8863:     	final String calcModeLabel = Resources.getMsg(context.getMeta(),sinfo.getCalculationMode().name() );
gernotbelger@8863:     	
gernotbelger@8863:     	
gernotbelger@8863:         final FlowDepthCalculationResults results = new FlowDepthCalculationResults(calcModeLabel, user, river, from, to, useTkh);
gernotbelger@8854: 
gernotbelger@8854:     	for (final DifferencesPair diffPair : diffPairs) {
gernotbelger@8854:     		final FlowDepthCalculationResult result = calculateResult( river, from, to, diffPair, problems, gaugeIndex );
gernotbelger@8854:     		if( result != null )
gernotbelger@8854:     			results.addResult(result);
gernotbelger@8854: 		}
gernotbelger@8854:     	
gernotbelger@8854: 		return new CalculationResult(results,problems);
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8854: 	private FlowDepthCalculationResult calculateResult(final River river, final double from, final double to, final DifferencesPair diffPair, final Calculation problems, final GaugeIndex gaugeIndex) {
gernotbelger@8854: 
gernotbelger@8854: 		/* access real input data from database */
gernotbelger@8854:     	final String soundingId = diffPair.getSoundingId();
gernotbelger@8854:     	final String wstId = diffPair.getWstId();
gernotbelger@8854: 
gernotbelger@8854:     	final BedHeight bedHeight = loadBedHeight( soundingId, from, to );
gernotbelger@8854: 		final WKms wstKms = new WDifferencesState().getWKms(wstId, context, from, to);
gernotbelger@8854: 		if( bedHeight == null || wstKms == null )
gernotbelger@8854: 			return null;
gernotbelger@8854: 
gernotbelger@8854:     	final FlowDepthCalculationResult resultData = new FlowDepthCalculationResult(wstKms.getName(), bedHeight.getDescription());
gernotbelger@8854: 
gernotbelger@8854:         final String notinrange = Resources.getMsg(context.getMeta(), CSV_NOT_IN_GAUGE_RANGE, CSV_NOT_IN_GAUGE_RANGE);
gernotbelger@8854: 
gernotbelger@8854:     	// TODO: unklarheiten
gernotbelger@8854:     	// 'idealerweise alle 100m' was heisst das? kann doch nur durch datenverfügbarkeit bestimmt werden
gernotbelger@8854:     	// wie mit unterschiedlichen Ranges umgehen? Schnitt bilden? Fehlermeldung? ...?
gernotbelger@8854:     	// wie interpolieren? wst interpolieren? peilung interpolieren?
gernotbelger@8854: 
gernotbelger@8854: 		// FIXME: für die Berechnung der TKH sind weitere 'in FLYS vorliegende' Daten notwendig.
gernotbelger@8854: 		// aktuell unklar ob das durch andere Barten berechnete Werte oder Basisdaten sind
gernotbelger@8854: 		// TODO: check Vergleiche BArt 'Transportkörperhöhen'
gernotbelger@8854:         
gernotbelger@8854:     	// TODO: Berechnung der Transportkörperhöhen
gernotbelger@8854:     	// - woher kommen die zusätzlichen eingangsdaten? sind das fixe daten pro gewässer? --> falls ja, warum nicht einmal berechnen und in db ablegen?
gernotbelger@8854: 
gernotbelger@8854:     	final String bedHeightLabel = bedHeight.getDescription();
gernotbelger@8854:     	final String wstLabel = wstKms.getName();
gernotbelger@8854: 
gernotbelger@8854: 		for (int i = 0; i < wstKms.size(); i++) {
gernotbelger@8854: 
gernotbelger@8854: 			final double km = wstKms.getKm(i);
gernotbelger@8854:     		final double wst = wstKms.getW(i);
gernotbelger@8854:     		// FIXME: interpolate from bedheights?
gernotbelger@8854:     		final double meanBedHeight = 79.32;
gernotbelger@8854: 
gernotbelger@8854:     		final double flowDepth = wst - meanBedHeight;
gernotbelger@8854:     		
gernotbelger@8854:     		final double tkh = 0;
gernotbelger@8854:     		final double flowDepthTkh = flowDepth - tkh;
gernotbelger@8854:     		
gernotbelger@8854:     		// FIXME: discharge not available for all wst? or any?
gernotbelger@8854:     		final double discharge = 0.0;
gernotbelger@8854: 
gernotbelger@8854:     		// REMARK: access the location once only during calculation 
gernotbelger@8854:     		final String location = LocationProvider.getLocation(river.getName(), km);
gernotbelger@8854:     		
gernotbelger@8854:     		// REMARK: access the gauge once only during calculation 
gernotbelger@8854:     		final Gauge gauge = gaugeIndex.findGauge(km);
gernotbelger@8854:     		final String gaugeLabel = gauge == null ? notinrange : gauge.getName();
gernotbelger@8854:     		
gernotbelger@8854: 			resultData.addRow( km, flowDepth, flowDepthTkh, tkh, wst, discharge, wstLabel, gaugeLabel, meanBedHeight, bedHeightLabel, location );
gernotbelger@8854: 		}
gernotbelger@8854: 		
gernotbelger@8854: 		return resultData;
gernotbelger@8854: 	}
gernotbelger@8854: 
gernotbelger@8854: 	private BedHeight loadBedHeight(final String soundingId, final double from, final double to) {
gernotbelger@8854: 		
gernotbelger@8854: 		// FIXME: absolutely unbelievable....
gernotbelger@8854: 		// The way how bed-heights (and other data too) is accessed is different for nearly ever calculation-type throughout flys.
gernotbelger@8854: 		// The knowledge on how to parse the datacage-ids is spread thorugh the complete code-base...
gernotbelger@8854: 
gernotbelger@8854: 		// We use here the way on how bed-heights are accessed by the BedDifferenceAccess/BedDifferenceCalculation, but this is plain random
gernotbelger@8854: 	    final String[] parts = soundingId.split(";");
gernotbelger@8854: 
gernotbelger@8854: 	    final BedHeightsArtifact artifact = (BedHeightsArtifact) RiverUtils.getArtifact(parts[0], context);
gernotbelger@8854: 
gernotbelger@8854: 	    final Integer bedheightId = artifact.getDataAsInteger("height_id");
gernotbelger@8854: 	    // FIXME: this only works with type 'single'; unclear on how to distinguish from epoch data (or whatever the other type means)
gernotbelger@8854: 	    // Luckily, the requirement is to only access 'single' data here.
gernotbelger@8854: 	    // final String bedheightType = artifact.getDataAsString("type");
gernotbelger@8854: 	    
gernotbelger@8854: 	    // FIXME: BedDifferences uses this, but we also need the metadata of the BedHeight
gernotbelger@8854: 	    // FIXME: second absolutely awful thing: BedHeight is a hibernate binding class, accessing the database via hibernate stuff
gernotbelger@8854: 	    // BedHeightFactory uses its own (direct) way of accessing the data, with its own implemented data classes.
gernotbelger@8854: 	    //return BedHeightFactory.getHeight(bedheightType, bedheightId, from, to);
gernotbelger@8854: 	     
gernotbelger@8854: 	    return BedHeight.getBedHeightById(bedheightId);
gernotbelger@8854: 	}
gernotbelger@8854: }