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@8951: import java.util.ArrayList;
gernotbelger@8951: import java.util.Collection;
gernotbelger@8951: 
gernotbelger@8951: import org.apache.log4j.Logger;
gernotbelger@8951: import org.dive4elements.river.artifacts.sinfo.common.AbstractSInfoExporter;
gernotbelger@8951: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultRow;
gernotbelger@8951: import org.dive4elements.river.artifacts.sinfo.common.SInfoResultType;
gernotbelger@8951: import org.dive4elements.river.artifacts.sinfo.util.MetaAndTableJRDataSource;
gernotbelger@8951: import org.dive4elements.river.artifacts.sinfo.util.RiverInfo;
gernotbelger@8951: 
gernotbelger@8951: import au.com.bytecode.opencsv.CSVWriter;
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@8951:     /** The log used in this exporter. */
gernotbelger@8951:     private static Logger log = Logger.getLogger(FlowDepthDevelopmentExporter.class);
gernotbelger@8951: 
gernotbelger@8951:     private static final String JASPER_FILE = "/jasper/sinfo.flowdepthminmax.jasper";
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@8951:         // FIXME: distinguish header labels
gernotbelger@8951:         writeCSVSoundingMetadata(writer, result.getCurrentSounding());
gernotbelger@8951:         writeCSVWaterlevelMetadata(writer, result.getCurrentWst());
gernotbelger@8951: 
gernotbelger@8951:         // FIXME: distinguish header labels
gernotbelger@8951:         writeCSVSoundingMetadata(writer, result.getHistoricalSounding());
gernotbelger@8951:         writeCSVWaterlevelMetadata(writer, result.getHistoricalWst());
gernotbelger@8951:     }
gernotbelger@8951: 
gernotbelger@8951:     @Override
gernotbelger@8951:     protected void writeCSVGlobalMetadata(final CSVWriter writer, final FlowDepthDevelopmentCalculationResults results) {
gernotbelger@8951: 
gernotbelger@8951:         super.writeCSVGlobalMetadataDefaults(writer, results);
gernotbelger@8951: 
gernotbelger@8951:         writer.writeNext(new String[] { "" });
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@8951:         final Collection<String> header = new ArrayList<>(11);
gernotbelger@8951: 
gernotbelger@8951:         header.add(msg(SInfoResultType.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@8951: 
gernotbelger@8951:         // FIXME: add data-labels in header
gernotbelger@8951:         header.add(msgUnit(SInfoResultType.waterlevelDifference.getCsvHeader(), SInfoResultType.waterlevelDifference.getUnit()));
gernotbelger@8951:         header.add(msgUnit(SInfoResultType.bedHeightDifference.getCsvHeader(), SInfoResultType.bedHeightDifference.getUnit()));
gernotbelger@8951: 
gernotbelger@8951:         header.add(msgUnit(SInfoResultType.flowdepthCurrent.getCsvHeader(), SInfoResultType.flowdepthCurrent.getUnit()));
gernotbelger@8951:         header.add(msgUnit(SInfoResultType.flowdepthHistorical.getCsvHeader(), SInfoResultType.flowdepthHistorical.getUnit()));
gernotbelger@8951: 
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:     @Override
gernotbelger@8951:     protected String[] formatCSVRow(final FlowDepthDevelopmentCalculationResults results, final FlowDepthDevelopmentCalculationResult result,
gernotbelger@8951:             final SInfoResultRow row) {
gernotbelger@8951:         return formatRow(result, row);
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@8951:     private String[] formatRow(final FlowDepthDevelopmentCalculationResult result, final SInfoResultRow row) {
gernotbelger@8951: 
gernotbelger@8951:         final Collection<String> lines = new ArrayList<>(10);
gernotbelger@8951: 
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.station));
gernotbelger@8951: 
gernotbelger@8951:         // FIXME
gernotbelger@8951: 
gernotbelger@8951:         // REMARK: null check as pdf will call this with null and in that case we show all columns (to avoid multiple jasper
gernotbelger@8951:         // FIXME: does not work like this: we may have several pairs of min/max; so we need to look at all of them?
gernotbelger@8951:         // templates)
gernotbelger@8951:         // if (result == null || result.getMinSounding() != null)
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.flowdepthmin));
gernotbelger@8951:         // if (result == null || result.getMaxSounding() != null)
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.flowdepthmax));
gernotbelger@8951: 
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.waterlevel));
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.discharge));
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.waterlevelLabel));
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.gaugeLabel));
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.meanBedHeight));
gernotbelger@8951:         lines.add(row.exportValue(this.context, SInfoResultType.soundingLabel));
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 String getJasperFile() {
gernotbelger@8951:         return JASPER_FILE;
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@8951:         super.addJRMetaDataDefaults(source, results);
gernotbelger@8951: 
gernotbelger@8951:         /* column headings */
gernotbelger@8951:         // FIXME
gernotbelger@8951:         source.addMetaData("station_header", SInfoResultType.station.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:         source.addMetaData("flowdepthmin_header", SInfoResultType.flowdepthmin.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:         source.addMetaData("flowdepthmax_header", SInfoResultType.flowdepthmax.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:         source.addMetaData("waterlevel_header", SInfoResultType.waterlevel.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:         source.addMetaData("discharge_header", SInfoResultType.discharge.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:         source.addMetaData("waterlevel_name_header", SInfoResultType.waterlevelLabel.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:         source.addMetaData("gauge_header", SInfoResultType.gaugeLabel.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:         source.addMetaData("bedheight_header", SInfoResultType.meanBedHeight.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:         source.addMetaData("sounding_name_header", SInfoResultType.soundingLabel.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:         source.addMetaData("location_header", SInfoResultType.location.getPdfHeader(this.context.getMeta()));
gernotbelger@8951:     }
gernotbelger@8951: 
gernotbelger@8951:     @Override
gernotbelger@8951:     protected String[] formatPDFRow(final FlowDepthDevelopmentCalculationResults results, final SInfoResultRow row) {
gernotbelger@8951:         return formatRow(null, row);
gernotbelger@8951:     }
gernotbelger@8951: }