gernotbelger@9313: /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@9313:  * Software engineering by
gernotbelger@9313:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@9313:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@9313:  *
gernotbelger@9313:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@9313:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@9313:  * documentation coming with Dive4Elements River for details.
gernotbelger@9313:  */
gernotbelger@9313: package org.dive4elements.river.artifacts.bundu.bezugswst;
gernotbelger@9313: 
gernotbelger@9313: import java.util.ArrayList;
gernotbelger@9313: import java.util.Collection;
mschaefer@9444: import java.util.List;
gernotbelger@9313: 
gernotbelger@9318: import org.dive4elements.river.artifacts.bundu.BunduResultType;
gernotbelger@9313: import org.dive4elements.river.artifacts.common.AbstractCalculationExportableResult;
gernotbelger@9313: import org.dive4elements.river.artifacts.common.ExportContextCSV;
gernotbelger@9313: import org.dive4elements.river.artifacts.common.ExportContextPDF;
gernotbelger@9313: import org.dive4elements.river.artifacts.common.GeneralResultType;
gernotbelger@9313: import org.dive4elements.river.artifacts.common.IExportContext;
gernotbelger@9313: import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource;
gernotbelger@9313: import org.dive4elements.river.artifacts.common.ResultRow;
mschaefer@9438: import org.dive4elements.river.artifacts.model.WQKms;
gernotbelger@9313: import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
gernotbelger@9313: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@9313: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@9313: 
mschaefer@9444: import gnu.trove.TDoubleArrayList;
mschaefer@9444: 
gernotbelger@9313: /**
gernotbelger@9313:  * Contains the results of a //TODO LINK{@link BezugswstCalculation}.
gernotbelger@9313:  *
gernotbelger@9313:  * @author Gernot Belger
gernotbelger@9313:  */
d@9708: public final class BezugswstMainCalculationResult extends AbstractCalculationExportableResult {
gernotbelger@9313: 
gernotbelger@9313:     private static final long serialVersionUID = 1L;
gernotbelger@9313: 
gernotbelger@9313:     private static final String JASPER_FILE = "/jasper/templates/bundu.bezugswst.jrxml";
gernotbelger@9313: 
gernotbelger@9323:     private final WstInfo wst;
gernotbelger@9323:     private final BedHeightInfo sounding;
gernotbelger@9323:     private final String function;
gernotbelger@9323:     private final boolean preprocessing;
gernotbelger@9323:     private final int startYear;
gernotbelger@9323:     private final int endYear;
gernotbelger@9323:     private final Double missingVolumeFrom;
gernotbelger@9323:     private final Double missingVolumeTo;
gernotbelger@9323:     private final Integer ud;
mschaefer@9432:     private final String qOfGauges;
gernotbelger@9313: 
mschaefer@9438:     private final WQKms wqkms;
mschaefer@9438: 
gernotbelger@9330:     public BezugswstMainCalculationResult(final String label, final Collection<ResultRow> rows, final BedHeightInfo sounding, final WstInfo wst,
mschaefer@9432:             final String function, final boolean preprocessing, final int startYear, final int endYear, final Integer ud, final String qOfGauges,
mschaefer@9438:             final WQKms wqkms, final Double missingVolumeFrom, final Double missingVolumeTo) {
gernotbelger@9313:         super(label, rows);
gernotbelger@9323:         this.wst = wst;
gernotbelger@9323:         this.sounding = sounding;
gernotbelger@9323:         this.function = function;
gernotbelger@9323:         this.preprocessing = preprocessing;
gernotbelger@9323:         this.startYear = startYear;
gernotbelger@9323:         this.endYear = endYear;
gernotbelger@9323:         this.missingVolumeTo = missingVolumeTo;
gernotbelger@9323:         this.missingVolumeFrom = missingVolumeFrom;
gernotbelger@9323:         this.ud = ud;
gernotbelger@9323:         this.qOfGauges = qOfGauges;
mschaefer@9438:         this.wqkms = wqkms;
mschaefer@9438:     }
mschaefer@9438: 
mschaefer@9438:     public WQKms getWQKms() {
mschaefer@9438:         return this.wqkms;
gernotbelger@9313:     }
gernotbelger@9313: 
mschaefer@9432:     public String getWstLabel() {
mschaefer@9432:         if (this.ud != null)
d@9708:             return Integer.toString(this.getEndYear()) + "; UD=" + Integer.toString(this.ud); // FIXME per WaterlevelDescriptionBuilder o.ä. zentralisieren
d@9708:         return Integer.toString(this.getEndYear()) + "; " + this.wst.getLabel();
mschaefer@9432:     }
mschaefer@9432: 
mschaefer@9432:     public String getBedHeightLabel() {
mschaefer@9432:         if (this.sounding != null)
mschaefer@9432:             return this.sounding.getDescription();
mschaefer@9432:         return "";
mschaefer@9432:     }
mschaefer@9432: 
mschaefer@9432:     public boolean getIsMissingVolume() {
mschaefer@9432:         return !Double.isNaN(this.missingVolumeFrom);
mschaefer@9432:     }
mschaefer@9432: 
gernotbelger@9313:     @Override
gernotbelger@9313:     protected void writeCSVResultMetadata(final ExportContextCSV exportContextCSV) {
gernotbelger@9313: 
mschaefer@9432:         exportContextCSV.writeCSVWaterlevelMetadata(this.wst);
mschaefer@9432:         exportContextCSV.writeBlankLine();
mschaefer@9480:         if (this.sounding != null)
mschaefer@9480:             exportContextCSV.writeCSVSoundingMetadata(this.sounding, "common.export.csv.meta.header.sounding");
gernotbelger@9323: 
gernotbelger@9323:         // Reihenfolge in der LV anders; ich finde sie aber so sinnvoller
gernotbelger@9323:         exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.function", this.function);
gernotbelger@9330:         exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.preprocessing", exportContextCSV.msg(String.valueOf(this.preprocessing)));
d@9708:         exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.q_period", String.valueOf(this.startYear), String.valueOf(this.getEndYear()));
gernotbelger@9323:         if (this.ud != null)
gernotbelger@9323:             exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.ud", this.ud);
gernotbelger@9323:         else if (this.qOfGauges != null)
mschaefer@9432:             exportContextCSV.writeCSVMetaEntry("common.export.waterlevel.csv.meta.q", this.qOfGauges);
gernotbelger@9323: 
gernotbelger@9337:         if (this.missingVolumeFrom != null && this.missingVolumeTo != null)
gernotbelger@9337:             exportContextCSV.writeCSVMetaEntry("bundu.export.bezugswst.csv.meta.missing_volume_range", this.missingVolumeFrom, this.missingVolumeTo);
gernotbelger@9323: 
gernotbelger@9323:         exportContextCSV.writeBlankLine();
gernotbelger@9313:     }
gernotbelger@9313: 
gernotbelger@9313:     @Override
gernotbelger@9313:     protected String getJasperFile() {
gernotbelger@9313:         return JASPER_FILE;
gernotbelger@9313:     }
gernotbelger@9313: 
gernotbelger@9313:     protected String[] formatRow(final IExportContext exportContext, final ResultRow row) {
gernotbelger@9313: 
gernotbelger@9313:         final Collection<String> lines = new ArrayList<>(10);
gernotbelger@9313: 
gernotbelger@9313:         lines.add(exportContext.formatRowValue(row, GeneralResultType.station));
gernotbelger@9318:         lines.add(exportContext.formatRowValue(row, BunduResultType.bezugswst));
gernotbelger@9313:         lines.add(exportContext.formatRowValue(row, GeneralResultType.dischargeQwithUnit));
gernotbelger@9313: 
gernotbelger@9318:         lines.add(exportContext.formatRowValue(row, GeneralResultType.waterlevelLabel));
gernotbelger@9318:         lines.add(exportContext.formatRowValue(row, GeneralResultType.gaugeLabel));
gernotbelger@9313:         lines.add(exportContext.formatRowValue(row, GeneralResultType.location));
gernotbelger@9313: 
gernotbelger@9313:         return lines.toArray(new String[lines.size()]);
gernotbelger@9313:     }
gernotbelger@9313: 
gernotbelger@9313:     @Override
gernotbelger@9313:     public void writeCSVHeader(final ExportContextCSV exportContextCSV, final RiverInfo river) {
gernotbelger@9330:         final int colSize = 6;
gernotbelger@9330:         exportContextCSV.writeTitleForTabs("bundu.export.csv.title.bezugswst.overview", colSize); // Voraussetzung für Tabs ist, dass der Titel vor den Headern
gernotbelger@9330:         final Collection<String> header = new ArrayList<>(colSize);
gernotbelger@9313: 
gernotbelger@9313:         header.add(exportContextCSV.formatCsvHeader(GeneralResultType.station));
gernotbelger@9330:         header.add(exportContextCSV.formatCsvHeader(BunduResultType.bezugswst) + " [" + river.getWstUnit() + "]");
gernotbelger@9313:         header.add(exportContextCSV.formatCsvHeader(GeneralResultType.dischargeQwithUnit));
gernotbelger@9318:         header.add(exportContextCSV.formatCsvHeader(GeneralResultType.waterlevelLabel));
gernotbelger@9318:         header.add(exportContextCSV.formatCsvHeader(GeneralResultType.gaugeLabel));
gernotbelger@9313:         header.add(exportContextCSV.formatCsvHeader(GeneralResultType.location));
gernotbelger@9313: 
gernotbelger@9313:         exportContextCSV.writeCSVLine(header.toArray(new String[header.size()]));
gernotbelger@9313: 
gernotbelger@9313:     }
gernotbelger@9313: 
gernotbelger@9313:     @Override
gernotbelger@9313:     protected String[] formatCSVRow(final ExportContextCSV exportContextCSV, final ResultRow row) {
gernotbelger@9313: 
gernotbelger@9313:         return this.formatRow(exportContextCSV, row);
gernotbelger@9313:     }
gernotbelger@9313: 
gernotbelger@9313:     @Override
gernotbelger@9313:     protected String[] formatPDFRow(final ExportContextPDF exportContextPDF, final ResultRow row) {
gernotbelger@9313: 
gernotbelger@9313:         return this.formatRow(exportContextPDF, row);
gernotbelger@9313:     }
gernotbelger@9313: 
gernotbelger@9313:     @Override
gernotbelger@9313:     protected void addJRTableHeader(final ExportContextPDF exportContextPDF, final MetaAndTableJRDataSource source) {
gernotbelger@9313:         /* column headings */
gernotbelger@9313:         exportContextPDF.addJRMetadata(source, "station_header", GeneralResultType.station);
gernotbelger@9318:         exportContextPDF.addJRMetadata(source, "bezugswst_header", BunduResultType.bezugswst);
gernotbelger@9331:         // exportContextPDF.addJRMetadata(source, " [" + river.getWstUnit() + "]");
gernotbelger@9318:         exportContextPDF.addJRMetadata(source, "discharge_header", GeneralResultType.dischargeQwithUnit);
gernotbelger@9318:         exportContextPDF.addJRMetadata(source, "waterlevel_name_header", GeneralResultType.waterlevelLabel);
gernotbelger@9318:         exportContextPDF.addJRMetadata(source, "gauge_header", GeneralResultType.gaugeLabel);
gernotbelger@9313:         exportContextPDF.addJRMetadata(source, "location_header", GeneralResultType.location);
gernotbelger@9313: 
gernotbelger@9313:     }
mschaefer@9444: 
mschaefer@9444:     /**
mschaefer@9444:      * Gets a longitudinal section of a result type value of a cross section field
mschaefer@9444:      *
mschaefer@9444:      * @param fieldIndex
mschaefer@9444:      *            1-based field index
mschaefer@9444:      * @param type
mschaefer@9444:      *            result type like bedHeightField
mschaefer@9444:      */
mschaefer@9444:     public final double[][] getFieldValuePoints(final int fieldIndex, final BunduResultType type) {
mschaefer@9444: 
mschaefer@9444:         final TDoubleArrayList x = new TDoubleArrayList(this.getRows().size());
mschaefer@9444:         final TDoubleArrayList y = new TDoubleArrayList(this.getRows().size());
mschaefer@9444: 
mschaefer@9444:         for (final ResultRow row : this.getRows()) {
mschaefer@9444:             x.add(row.getDoubleValue(GeneralResultType.station));
mschaefer@9444:             @SuppressWarnings("unchecked")
mschaefer@9444:             final List<Double> fieldHeights = (List<Double>) row.getValue(type);
mschaefer@9444:             y.add(fieldHeights.get(fieldIndex - 1));
mschaefer@9444:         }
mschaefer@9444: 
mschaefer@9444:         return new double[][] { x.toNativeArray(), y.toNativeArray() };
mschaefer@9444:     }
d@9708: 
d@9708: 	public int getEndYear() {
d@9708: 		return endYear;
d@9708: 	}
gernotbelger@9313: }