gernotbelger@8854: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
gernotbelger@8854:  * Software engineering by Intevation GmbH
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: 
gernotbelger@8854: package org.dive4elements.river.artifacts.sinfo.flowdepth;
gernotbelger@8854: 
gernotbelger@9006: import java.io.OutputStream;
gernotbelger@8854: import java.util.ArrayList;
gernotbelger@8854: import java.util.Collection;
gernotbelger@8854: 
gernotbelger@8854: import org.apache.log4j.Logger;
gernotbelger@8997: import org.dive4elements.river.artifacts.common.GeneralResultType;
gernotbelger@9006: import org.dive4elements.river.artifacts.common.JasperDesigner;
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@8928: import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter;
gernotbelger@8948: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
gernotbelger@8894: import org.dive4elements.river.artifacts.sinfo.util.BedHeightInfo;
gernotbelger@8894: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8894: import org.dive4elements.river.artifacts.sinfo.util.WstInfo;
gernotbelger@8854: 
gernotbelger@8854: import au.com.bytecode.opencsv.CSVWriter;
gernotbelger@9006: import net.sf.jasperreports.engine.JRException;
gernotbelger@8854: 
gernotbelger@8854: /**
gernotbelger@8946:  * Generates different output formats (csv, pdf) of data that resulted from a flow depths min/max computation.
gernotbelger@8854:  *
gernotbelger@8854:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
gernotbelger@8854:  * @author Gernot Belger
gernotbelger@8854:  */
gernotbelger@8854: // REMARK: must be public because its registered in generators.xml
gernotbelger@8948: public class FlowDepthExporter extends AbstractSInfoExporter<FlowDepthCalculationResult, FlowDepthCalculationResults> {
gernotbelger@8854: 
gernotbelger@8877:     /** The log used in this exporter. */
gernotbelger@8854:     private static Logger log = Logger.getLogger(FlowDepthExporter.class);
gernotbelger@8854: 
gernotbelger@8997:     private static final String JASPER_FILE = "/jasper/templates/sinfo.flowdepth.jrxml"; // TODO use jrxml-path all over the project
gernotbelger@8863: 
gernotbelger@8928:     @Override
gernotbelger@8928:     protected Logger getLog() {
gernotbelger@8928:         return log;
gernotbelger@8863:     }
gernotbelger@8877: 
gernotbelger@8854:     @Override
gernotbelger@8946:     protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthCalculationResults results) {
gernotbelger@8946:         log.info("FlowDepthExporter.writeCSVMeta");
gernotbelger@8946:         super.writeCSVGlobalMetadataDefaults(writer, results);
gernotbelger@8877:     }
gernotbelger@8854: 
gernotbelger@8928:     @Override
gernotbelger@8946:     protected void writeCSVResultMetadata(final CSVWriter writer, final FlowDepthCalculationResults results, final FlowDepthCalculationResult result) {
gernotbelger@8854: 
gernotbelger@8946:         final BedHeightInfo sounding = result.getSounding();
gernotbelger@8946:         super.writeCSVSoundingMetadata(writer, sounding);
gernotbelger@8854: 
gernotbelger@8997:         writer.writeNext(new String[] { "" }); // break line
gernotbelger@8997: 
gernotbelger@8946:         final WstInfo wst = result.getWst();
gernotbelger@8946:         super.writeCSVWaterlevelMetadata(writer, wst);
gernotbelger@8997: 
gernotbelger@9006:         writer.writeNext(new String[] { "" }); // break line
gernotbelger@9006: 
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8877:     /**
gernotbelger@8854:      * Write the header, with different headings depending on whether at a
gernotbelger@8854:      * gauge or at a location.
gernotbelger@8877:      *
gernotbelger@8877:      * @param river
gernotbelger@8877:      * @param useTkh
gernotbelger@8854:      */
gernotbelger@8928:     @Override
gernotbelger@8938:     protected void writeCSVHeader(final CSVWriter writer, final FlowDepthCalculationResults results, final RiverInfo river) {
gernotbelger@8854:         log.info("FlowDepthExporter.writeCSVHeader");
gernotbelger@8854: 
gernotbelger@8854:         final Collection<String> header = new ArrayList<>(11);
gernotbelger@8877: 
gernotbelger@8997:         header.add(msg(GeneralResultType.station.getCsvHeader()));
gernotbelger@8948:         header.add(msgUnit(SInfoResultType.flowdepth.getCsvHeader(), SInfoResultType.flowdepth.getUnit()));
gernotbelger@8948: 
gernotbelger@8948:         if (results.isUseTkh()) {
gernotbelger@8948:             header.add(msgUnit(SInfoResultType.flowdepthtkh.getCsvHeader(), SInfoResultType.flowdepthtkh.getUnit()));
gernotbelger@8948:             header.add(msgUnit(SInfoResultType.tkh.getCsvHeader(), SInfoResultType.tkh.getUnit()));
gernotbelger@8854:         }
gernotbelger@8863: 
gernotbelger@8948:         header.add(msgUnit(SInfoResultType.waterlevel.getCsvHeader(), river.getWstUnit()));
gernotbelger@8948:         header.add(msgUnit(SInfoResultType.discharge.getCsvHeader(), SInfoResultType.discharge.getUnit()));
gernotbelger@8948:         header.add(msg(SInfoResultType.waterlevelLabel.getCsvHeader()));
gernotbelger@8948:         header.add(msg(SInfoResultType.gaugeLabel.getCsvHeader()));
gernotbelger@8948:         header.add(msgUnit(SInfoResultType.meanBedHeight.getCsvHeader(), river.getWstUnit()));
gernotbelger@8948:         header.add(msg(SInfoResultType.soundingLabel.getCsvHeader()));
gernotbelger@8948:         header.add(msg(SInfoResultType.location.getCsvHeader()));
gernotbelger@8854: 
gernotbelger@8877:         writer.writeNext(header.toArray(new String[header.size()]));
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8854:     /**
gernotbelger@8854:      * Format a row of a flow depth result into an array of string, both used by csv and pdf
gernotbelger@8877:      *
gernotbelger@8954:      * @param pdf
gernotbelger@8954:      *
gernotbelger@8877:      * @param useTkh
gernotbelger@8854:      */
gernotbelger@8997:     @Override
gernotbelger@8997:     protected String[] formatRow(final FlowDepthCalculationResults results, final ResultRow row, final ExportMode mode) {
gernotbelger@8854: 
gernotbelger@8877:         final Collection<String> lines = new ArrayList<>(11);
gernotbelger@8854: 
gernotbelger@8997:         lines.add(row.exportValue(this.context, GeneralResultType.station));
gernotbelger@8948:         lines.add(row.exportValue(this.context, SInfoResultType.flowdepth));
gernotbelger@8877: 
gernotbelger@8954:         if (mode == ExportMode.pdf || getData().isUseTkh()) {
gernotbelger@8948:             lines.add(row.exportValue(this.context, SInfoResultType.flowdepthtkh));
gernotbelger@8948:             lines.add(row.exportValue(this.context, SInfoResultType.tkh));
gernotbelger@8877:         }
gernotbelger@8877: 
gernotbelger@8948:         lines.add(row.exportValue(this.context, SInfoResultType.waterlevel));
gernotbelger@8948:         lines.add(row.exportValue(this.context, SInfoResultType.discharge));
gernotbelger@8948:         lines.add(row.exportValue(this.context, SInfoResultType.waterlevelLabel));
gernotbelger@8948:         lines.add(row.exportValue(this.context, SInfoResultType.gaugeLabel));
gernotbelger@8948:         lines.add(row.exportValue(this.context, SInfoResultType.meanBedHeight));
gernotbelger@8948:         lines.add(row.exportValue(this.context, SInfoResultType.soundingLabel));
gernotbelger@8948:         lines.add(row.exportValue(this.context, SInfoResultType.location));
gernotbelger@8877: 
gernotbelger@8877:         return lines.toArray(new String[lines.size()]);
gernotbelger@8854:     }
gernotbelger@8877: 
gernotbelger@8928:     @Override
gernotbelger@9006:     protected void writePDF(final OutputStream out) {
gernotbelger@9006: 
gernotbelger@9006:         try {
gernotbelger@9006:             final MetaAndTableJRDataSource source = createJRData(this.data);
gernotbelger@9006:             final JasperReporter reporter = new JasperReporter();
gernotbelger@9006:             final JasperDesigner design = reporter.addReport(JASPER_FILE, source);
gernotbelger@9006: 
gernotbelger@9006:             if (!getData().isUseTkh()) {
gernotbelger@9006:                 design.removeColumn("tkh");
gernotbelger@9006:                 design.removeColumn("flowdepthtkh");
gernotbelger@9006:             }
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@8854:     }
gernotbelger@8854: 
gernotbelger@8877:     @Override
gernotbelger@8928:     protected final void addJRMetaData(final MetaAndTableJRDataSource source, final FlowDepthCalculationResults results) {
gernotbelger@8854: 
gernotbelger@8877:         /* general metadata */
gernotbelger@8997:         super.addJRMetaData(source, results);
gernotbelger@8854: 
gernotbelger@8863:         /* column headings */
gernotbelger@8997:         source.addMetaData("station_header", GeneralResultType.station.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("flowdepth_header", SInfoResultType.flowdepth.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("flowdepth_tkh_header", SInfoResultType.flowdepthtkh.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("tkh_header", SInfoResultType.tkh.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("waterlevel_header", SInfoResultType.waterlevel.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("discharge_header", SInfoResultType.discharge.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("waterlevel_name_header", SInfoResultType.waterlevelLabel.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("gauge_header", SInfoResultType.gaugeLabel.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("bedheight_header", SInfoResultType.meanBedHeight.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("sounding_name_header", SInfoResultType.soundingLabel.getPdfHeader(this.context.getMeta()));
gernotbelger@8949:         source.addMetaData("location_header", SInfoResultType.location.getPdfHeader(this.context.getMeta()));
gernotbelger@8854:     }
gernotbelger@8854: 
gernotbelger@8928: }