gernotbelger@8996: /** Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
gernotbelger@9150:  * Software engineering by
gernotbelger@9150:  *  Björnsen Beratende Ingenieure GmbH
gernotbelger@8996:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
gernotbelger@8996:  *
gernotbelger@8996:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8996:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8996:  * documentation coming with Dive4Elements River for details.
gernotbelger@8996:  */
gernotbelger@8996: package org.dive4elements.river.artifacts.uinfo.salix;
gernotbelger@8996: 
gernotbelger@9150: import java.util.ArrayList;
gernotbelger@8996: import java.util.Collection;
gernotbelger@8996: 
gernotbelger@9150: import org.dive4elements.river.artifacts.common.AbstractCalculationExportableResult;
gernotbelger@9150: import org.dive4elements.river.artifacts.common.ExportContextCSV;
gernotbelger@9195: import org.dive4elements.river.artifacts.common.ExportContextPDF;
gernotbelger@9150: import org.dive4elements.river.artifacts.common.GeneralResultType;
gernotbelger@9195: import org.dive4elements.river.artifacts.common.IExportContext;
gernotbelger@9150: import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource;
gernotbelger@8996: import org.dive4elements.river.artifacts.common.ResultRow;
gernotbelger@9150: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8996: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@9150: import org.dive4elements.river.artifacts.uinfo.commons.UInfoResultType;
gernotbelger@8996: 
gernotbelger@8996: /**
gernotbelger@8996:  * @author Domenico Nardi Tironi
gernotbelger@8996:  */
gernotbelger@9195: final class SalixLineCalculationResult extends AbstractCalculationExportableResult {
gernotbelger@8996: 
gernotbelger@8996:     private static final long serialVersionUID = 1L;
gernotbelger@9150:     private static final String JASPER_FILE = "/jasper/templates/uinfo.salixline.jrxml";
gernotbelger@8996: 
gernotbelger@9150:     public SalixLineCalculationResult(final String label, final WstInfo wst, final Collection<ResultRow> rows) {
gernotbelger@9150:         super(label, rows);
gernotbelger@8996:     }
gernotbelger@9150: 
gernotbelger@9150:     @Override
gernotbelger@9195:     public void writeCSVHeader(final ExportContextCSV exportContextCSV, final RiverInfo river) {
gernotbelger@9150: 
gernotbelger@9150:         final Collection<String> header = new ArrayList<>(4);
gernotbelger@9150: 
gernotbelger@9150:         header.add(exportContextCSV.formatCsvHeader(GeneralResultType.station));
gernotbelger@9150:         // header.add(msgUnit(SInfoResultType.flowdepth, SInfoResultType.flowdepth.getUnit()));
gernotbelger@9150: 
gernotbelger@9150:         header.add(exportContextCSV.formatCsvHeader(UInfoResultType.salixline));
gernotbelger@9150:         // wenn "historisch" gewählt wurde, nur "historisch" anzeigen; sonst für jeden scen-wert ne neue Spalte und "hist"
gernotbelger@9150:         // ausblenden!...!..!!
gernotbelger@9150:         header.add(exportContextCSV.formatCsvHeader(UInfoResultType.salixlinehist));
gernotbelger@9150:         header.add(exportContextCSV.formatCsvHeader(UInfoResultType.salixlinescen));
gernotbelger@9150:         exportContextCSV.writeCSVLine(header.toArray(new String[header.size()]));
gernotbelger@9150: 
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     @Override
gernotbelger@9195:     protected void writeCSVResultMetadata(final ExportContextCSV exportContextCSV) {
gernotbelger@9150:         writeRegionalEffectsCSVMetadata(exportContextCSV);
gernotbelger@9195:         exportContextCSV.writeBlankLine();
gernotbelger@9150:         writeExtendedRegionalEffectsCSVMetadata(exportContextCSV);
gernotbelger@9150:         exportContextCSV.writeBlankLine();
gernotbelger@9150:         writeHistoricalViewCSVMetadata(exportContextCSV);
gernotbelger@9150:         exportContextCSV.writeBlankLine();
gernotbelger@9150: 
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     @Override
gernotbelger@9195:     protected String[] formatCSVRow(final ExportContextCSV exportContextCSV, final ResultRow row) {
gernotbelger@9150: 
gernotbelger@9195:         return formatRow(exportContextCSV, row);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     @Override
gernotbelger@9195:     protected String[] formatPDFRow(final ExportContextPDF exportContextPDF, final ResultRow row) {
gernotbelger@9150: 
gernotbelger@9195:         return formatRow(exportContextPDF, row);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     @Override
gernotbelger@9150:     protected String getJasperFile() {
gernotbelger@9150: 
gernotbelger@9150:         return this.JASPER_FILE;
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     @Override
gernotbelger@9195:     protected void addJRTableHeader(final ExportContextPDF exportContextPDF, final MetaAndTableJRDataSource source) {
gernotbelger@9150: 
gernotbelger@9150:         /* additional column headings */
gernotbelger@9150:         exportContextPDF.addJRMetadata(source, "station_header", GeneralResultType.station);
gernotbelger@9150: 
gernotbelger@9150:         exportContextPDF.addJRMetadata(source, "salix_line", UInfoResultType.salixline);
gernotbelger@9150:         // wenn "historisch" gewählt wurde, nur "historisch" anzeigen; sonst für jeden scen-wert ne neue Spalte und "hist"
gernotbelger@9150:         // ausblenden!...!..!!
gernotbelger@9150:         exportContextPDF.addJRMetadata(source, "salix_line_hist", UInfoResultType.salixlinehist);
gernotbelger@9150:         exportContextPDF.addJRMetadata(source, "salix_line_scen", UInfoResultType.salixlinescen);
gernotbelger@9150: 
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9195:     private String[] formatRow(final IExportContext context, final ResultRow row) {
gernotbelger@9150: 
gernotbelger@9150:         final Collection<String> lines = new ArrayList<>(3);
gernotbelger@9150: 
gernotbelger@9150:         lines.add(context.formatRowValue(row, GeneralResultType.station));
gernotbelger@9150:         lines.add(context.formatRowValue(row, UInfoResultType.salixline));
gernotbelger@9150: 
gernotbelger@9150:         // wenn "historisch" gewählt wurde, nur "historisch" anzeigen; sonst für jeden scen-wert ne neue Spalte und "hist"
gernotbelger@9150:         // ausblenden!...!..!!
gernotbelger@9150:         lines.add(context.formatRowValue(row, UInfoResultType.salixlinehist));
gernotbelger@9150:         lines.add(context.formatRowValue(row, UInfoResultType.salixlinescen));
gernotbelger@9150:         return lines.toArray(new String[lines.size()]);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     private void writeRegionalEffectsCSVMetadata(final ExportContextCSV exportContextCSV) {
gernotbelger@9150:         final String main = "uinfo.export.csv.meta.header.salix.regional";
gernotbelger@9150:         // "##Regional wirkende Eingriffe"
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(main);
gernotbelger@9150:         writeRegionalCommonCSVMeta(exportContextCSV);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     private void writeRegionalCommonCSVMeta(final ExportContextCSV exportContextCSV) {
gernotbelger@9150:         final String main = "uinfo.export.csv.meta.header.salix";
gernotbelger@9150:         // "# Szenariotyp: "
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(main + ".szenariotyp");
gernotbelger@9150:         // "# Teilabschnitt: "
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(main + ".teilabschnitt");
gernotbelger@9150:         // "# Mittelwasserspiegellagenänderung: "
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(main + ".mwspiegellaenderung");
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     private void writeExtendedRegionalEffectsCSVMetadata(final ExportContextCSV exportContextCSV) {
gernotbelger@9150:         final String main = "uinfo.export.csv.meta.header.salix.regionalextended";
gernotbelger@9150:         // "##Überregional wirkende Eingriffe"
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(main);
gernotbelger@9150: 
gernotbelger@9150:         writeRegionalCommonCSVMeta(exportContextCSV);
gernotbelger@9150:     }
gernotbelger@9150: 
gernotbelger@9150:     private void writeHistoricalViewCSVMetadata(final ExportContextCSV exportContextCSV) {
gernotbelger@9150:         final String main = "uinfo.export.csv.meta.header.salix.historical";
gernotbelger@9150:         // "##Historische Betrachtung"
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(main);
gernotbelger@9150: 
gernotbelger@9150:         final String mainSub = "uinfo.export.csv.meta.header.salix";
gernotbelger@9150:         // "# Szenariotyp: "
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(mainSub + ".szenariotyp");
gernotbelger@9150:         // "# Teilabschnitt: "
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(mainSub + ".teilabschnitt");
gernotbelger@9150: 
gernotbelger@9150:         // "# Art des Zeitraums: "
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(main + ".zeitart");
gernotbelger@9150:         // "# Historischer Zeitpunkt: "
gernotbelger@9150:         exportContextCSV.writeCSVMetaEntry(main + ".zeitpunkt");
gernotbelger@9150:     }
gernotbelger@8996: }