gernotbelger@8951: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
gernotbelger@8951:  * Software engineering by Intevation GmbH
gernotbelger@8951:  *
gernotbelger@8951:  * This file is Free Software under the GNU AGPL (>=v3)
gernotbelger@8951:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
gernotbelger@8951:  * documentation coming with Dive4Elements River for details.
gernotbelger@8951:  */
gernotbelger@8951: 
gernotbelger@8951: package org.dive4elements.river.artifacts.sinfo.flowdepthdev;
gernotbelger@8951: 
gernotbelger@9006: import java.io.OutputStream;
gernotbelger@8951: import java.util.ArrayList;
gernotbelger@8951: import java.util.Collection;
gernotbelger@8951: 
gernotbelger@8951: import org.apache.log4j.Logger;
gernotbelger@8997: import org.dive4elements.river.artifacts.common.GeneralResultType;
gernotbelger@9006: import org.dive4elements.river.artifacts.common.JasperReporter;
gernotbelger@9006: import org.dive4elements.river.artifacts.common.MetaAndTableJRDataSource;
gernotbelger@8997: import org.dive4elements.river.artifacts.common.ResultRow;
gernotbelger@8951: import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter;
gernotbelger@8951: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
gernotbelger@8951: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8951: 
gernotbelger@8951: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@9006: import net.sf.jasperreports.engine.JRException;
gernotbelger@8951: 
gernotbelger@8951: /**
gernotbelger@8951:  * Generates different output formats (csv, pdf) of data that resulted from a flow depths computation.
gernotbelger@8951:  *
gernotbelger@8951:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
gernotbelger@8951:  * @author Gernot Belger
gernotbelger@8951:  */
gernotbelger@8951: // REMARK: must be public because its registered in generators.xml
gernotbelger@8951: public class FlowDepthDevelopmentExporter extends AbstractSInfoExporter<FlowDepthDevelopmentCalculationResult, FlowDepthDevelopmentCalculationResults> {
gernotbelger@8951: 
gernotbelger@8953:     private static final String CSV_META_HEADER_SOUNDING_CURRENT = "sinfo.export.csv.meta.header.sounding.current";
gernotbelger@8953: 
gernotbelger@8953:     private static final String CSV_META_HEADER_SOUNDING_HISTORICAL = "sinfo.export.csv.meta.header.sounding.historical";
gernotbelger@8953: 
gernotbelger@8953:     private static final String CSV_META_HEADER_WATERLEVEL_CURRENT = "sinfo.export.csv.meta.header.waterlevel.current";
gernotbelger@8953: 
gernotbelger@8953:     private static final String CSV_META_HEADER_WATERLEVEL_HISTORICAL = "sinfo.export.csv.meta.header.waterlevel.historical";
gernotbelger@8953: 
gernotbelger@8951:     /** The log used in this exporter. */
gernotbelger@8951:     private static Logger log = Logger.getLogger(FlowDepthDevelopmentExporter.class);
gernotbelger@8951: 
gernotbelger@9006:     private static final String JASPER_FILE = "/jasper/templates/sinfo.flowdepthdevelopment.jrxml";
gernotbelger@8951: 
gernotbelger@8951:     @Override
gernotbelger@8951:     protected Logger getLog() {
gernotbelger@8951:         return log;
gernotbelger@8951:     }
gernotbelger@8951: 
gernotbelger@8951:     @Override
gernotbelger@8951:     protected void writeCSVResultMetadata(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results,
gernotbelger@8951:             final FlowDepthDevelopmentCalculationResult result) {
gernotbelger@8951: 
gernotbelger@8953:         writeCSVSoundingMetadata(writer, result.getCurrentSounding(), CSV_META_HEADER_SOUNDING_CURRENT);
gernotbelger@8997:         writer.writeNext(new String[] { "" }); // break line
gernotbelger@8953:         writeCSVWaterlevelMetadata(writer, result.getCurrentWst(), CSV_META_HEADER_WATERLEVEL_CURRENT);
gernotbelger@8997:         writer.writeNext(new String[] { "" }); // break line
gernotbelger@8953:         writeCSVSoundingMetadata(writer, result.getHistoricalSounding(), CSV_META_HEADER_SOUNDING_HISTORICAL);
gernotbelger@8997:         writer.writeNext(new String[] { "" }); // break line
gernotbelger@8953:         writeCSVWaterlevelMetadata(writer, result.getHistoricalWst(), CSV_META_HEADER_WATERLEVEL_HISTORICAL);
gernotbelger@9006:         writer.writeNext(new String[] { "" }); // break line
gernotbelger@8951:     }
gernotbelger@8951: 
gernotbelger@8951:     @Override
gernotbelger@8951:     protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results) {
gernotbelger@8951:         super.writeCSVGlobalMetadataDefaults(writer, results);
gernotbelger@8951:     }
gernotbelger@8951: 
gernotbelger@8951:     /**
gernotbelger@8951:      * Write the header, with different headings depending on whether at a
gernotbelger@8951:      * gauge or at a location.
gernotbelger@8951:      *
gernotbelger@8951:      * @param river
gernotbelger@8951:      * @param useTkh
gernotbelger@8951:      */
gernotbelger@8951:     @Override
gernotbelger@8951:     protected void writeCSVHeader(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results, final RiverInfo river) {
gernotbelger@8951:         log.info("FlowDepthExporter.writeCSVHeader");
gernotbelger@8951: 
gernotbelger@8953:         final FlowDepthDevelopmentCalculationResult result = results.getResult();
gernotbelger@8953: 
gernotbelger@8951:         final Collection<String> header = new ArrayList<>(11);
gernotbelger@8951: 
gernotbelger@8997:         header.add(msg(GeneralResultType.station.getCsvHeader()));
gernotbelger@8951:         header.add(msgUnit(SInfoResultType.flowdepthDevelopment.getCsvHeader(), SInfoResultType.flowdepthDevelopment.getUnit()));
gernotbelger@8951:         header.add(msgUnit(SInfoResultType.flowdepthDevelopmentPerYear.getCsvHeader(), SInfoResultType.flowdepthDevelopmentPerYear.getUnit()));
gernotbelger@8953:         header.add(msgUnitLabel(SInfoResultType.waterlevelDifference.getCsvHeader(), SInfoResultType.waterlevelDifference.getUnit(),
gernotbelger@8953:                 result.getWaterlevelDifferenceLabel()));
gernotbelger@8953:         header.add(msgUnitLabel(SInfoResultType.bedHeightDifference.getCsvHeader(), SInfoResultType.bedHeightDifference.getUnit(),
gernotbelger@8953:                 result.getBedHeightDifferenceLabel()));
gernotbelger@8953:         header.add(
gernotbelger@8953:                 msgUnitLabel(SInfoResultType.flowdepthCurrent.getCsvHeader(), SInfoResultType.flowdepthCurrent.getUnit(), result.getFlowDepthCurrentLabel()));
gernotbelger@8953:         header.add(msgUnitLabel(SInfoResultType.flowdepthHistorical.getCsvHeader(), SInfoResultType.flowdepthHistorical.getUnit(),
gernotbelger@8953:                 result.getFlowDepthHistoricalLabel()));
gernotbelger@8951:         header.add(msg(SInfoResultType.location.getCsvHeader()));
gernotbelger@8951: 
gernotbelger@8951:         writer.writeNext(header.toArray(new String[header.size()]));
gernotbelger@8951:     }
gernotbelger@8951: 
gernotbelger@8951:     /**
gernotbelger@8951:      * Format a row of a flow depth result into an array of string, both used by csv and pdf
gernotbelger@8951:      *
gernotbelger@8951:      * @param result
gernotbelger@8951:      *
gernotbelger@8951:      * @param useTkh
gernotbelger@8951:      */
gernotbelger@8997:     @Override
gernotbelger@8997:     protected String[] formatRow(final FlowDepthDevelopmentCalculationResults results, final ResultRow row, final ExportMode mode) {
gernotbelger@8951: 
gernotbelger@8951:         final Collection<String> lines = new ArrayList<>(10);
gernotbelger@8951: 
gernotbelger@8997:         lines.add(row.exportValue(this.context, GeneralResultType.station));
gernotbelger@8953:         lines.add(row.exportValue(this.context, SInfoResultType.flowdepthDevelopment));
gernotbelger@8953:         lines.add(row.exportValue(this.context, SInfoResultType.flowdepthDevelopmentPerYear));
gernotbelger@8953:         lines.add(row.exportValue(this.context, SInfoResultType.waterlevelDifference));
gernotbelger@8953:         lines.add(row.exportValue(this.context, SInfoResultType.bedHeightDifference));
gernotbelger@8953:         lines.add(row.exportValue(this.context, SInfoResultType.flowdepthCurrent));
gernotbelger@8953:         lines.add(row.exportValue(this.context, SInfoResultType.flowdepthHistorical));
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.location));
gernotbelger@8951: 
gernotbelger@8951:         return lines.toArray(new String[lines.size()]);
gernotbelger@8951:     }
gernotbelger@8951: 
gernotbelger@8951:     @Override
gernotbelger@8951:     protected final void addJRMetaData(final MetaAndTableJRDataSource source, final FlowDepthDevelopmentCalculationResults results) {
gernotbelger@8951: 
gernotbelger@8951:         /* general metadata */
gernotbelger@8997:         super.addJRMetaData(source, results);
gernotbelger@8951: 
gernotbelger@8953:         final FlowDepthDevelopmentCalculationResult result = results.getResult();
gernotbelger@8984:         source.addMetaData("flowdepthdevelopment", result.getLabel());
gernotbelger@8997:         source.addMetaData("flowdepthdevelopment_header_label", SInfoResultType.flowdepthDevelopment.getCsvHeader(this.context.getMeta()));// (this.context.getMeta()));
gernotbelger@8953: 
gernotbelger@8951:         /* column headings */
gernotbelger@8997:         source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta()));
gernotbelger@8984:         source.addMetaData("flowdepthdevelopment_header", SInfoResultType.flowdepthDevelopment.getPdfHeader(this.context.getMeta()));
gernotbelger@8984:         source.addMetaData("flowdepthdevelopmentperyear_header", SInfoResultType.flowdepthDevelopmentPerYear.getPdfHeader(this.context.getMeta()));
gernotbelger@8953: 
gernotbelger@8953:         source.addMetaData("waterleveldifference_header", SInfoResultType.waterlevelDifference.getPdfHeader(this.context.getMeta()));
gernotbelger@8984:         source.addMetaData("waterleveldifference_header2", result.getWaterlevelDifferenceLabel());
gernotbelger@8953: 
gernotbelger@8953:         source.addMetaData("bedheightdifference_header", SInfoResultType.bedHeightDifference.getPdfHeader(this.context.getMeta()));
gernotbelger@8984:         source.addMetaData("bedheightdifference_header2", result.getBedHeightDifferenceLabel());
gernotbelger@8953: 
gernotbelger@8953:         source.addMetaData("flowdepthcurrent_header", SInfoResultType.flowdepthCurrent.getPdfHeader(this.context.getMeta()));
gernotbelger@8984:         source.addMetaData("flowdepthcurrent_header2", result.getFlowDepthCurrentLabel());
gernotbelger@8953: 
gernotbelger@8953:         source.addMetaData("flowdepthhistorical_header", SInfoResultType.flowdepthHistorical.getPdfHeader(this.context.getMeta()));
gernotbelger@8984:         source.addMetaData("flowdepthhistorical_header2", result.getFlowDepthHistoricalLabel());
gernotbelger@8953: 
gernotbelger@8951:         source.addMetaData("location_header", SInfoResultType.location.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:     }
gernotbelger@8951: 
gernotbelger@9006:     @Override
gernotbelger@9006:     protected void writePDF(final OutputStream out) {
gernotbelger@9006:         try {
gernotbelger@9006:             final MetaAndTableJRDataSource source = createJRData(this.data);
gernotbelger@9006: 
gernotbelger@9006:             final JasperReporter reporter = new JasperReporter();
gernotbelger@9006:             reporter.addReport(JASPER_FILE, source);
gernotbelger@9006:             reporter.exportPDF(out);
gernotbelger@9006:         }
gernotbelger@9006:         catch (final JRException je) {
gernotbelger@9006:             getLog().warn("Error generating PDF Report!", je);
gernotbelger@9006:         }
gernotbelger@9006:     }
gernotbelger@9006: 
gernotbelger@8951: }