teichmann@5863: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5863:  * Software engineering by Intevation GmbH
teichmann@5863:  *
teichmann@5994:  * This file is Free Software under the GNU AGPL (>=v3)
teichmann@5863:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5994:  * documentation coming with Dive4Elements River for details.
teichmann@5863:  */
teichmann@5863: 
teichmann@5831: package org.dive4elements.river.exports;
ingo@2714: 
ingo@2714: import java.io.OutputStream;
ingo@2714: import java.text.NumberFormat;
ingo@2714: import java.util.ArrayList;
ingo@2714: import java.util.List;
aheinecke@7693: import java.util.Collections;
aheinecke@7693: import java.util.SortedMap;
aheinecke@7693: import java.util.TreeMap;
ingo@2714: 
ingo@2714: import org.apache.log4j.Logger;
ingo@2714: 
ingo@2714: import au.com.bytecode.opencsv.CSVWriter;
ingo@2714: 
teichmann@5867: import org.dive4elements.river.artifacts.D4EArtifact;
teichmann@5831: import org.dive4elements.river.artifacts.model.CalculationResult;
rrenkert@7983: import org.dive4elements.river.artifacts.model.minfo.MiddleBedHeightData;
felix@7600: 
felix@7600: import org.dive4elements.river.model.River;
felix@7600: 
felix@7600: import org.dive4elements.river.utils.Formatter;
teichmann@5865: import org.dive4elements.river.utils.RiverUtils;
ingo@2714: 
ingo@2714: 
ingo@2714: /**
ingo@2714:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@2714:  */
ingo@2714: public class MiddleBedHeightExporter extends AbstractExporter {
ingo@2714: 
teichmann@8202:     /** Private log. */
teichmann@8202:     private static final Logger log =
ingo@2714:         Logger.getLogger(MiddleBedHeightExporter.class);
ingo@2714: 
ingo@2714:     public static final String CSV_KM =
ingo@2714:         "export.bedheight_middle.csv.header.km";
ingo@2714: 
ingo@2714:     public static final String CSV_SOUNDING =
ingo@2714:         "export.bedheight_middle.csv.header.sounding";
ingo@2714: 
ingo@2714:     public static final String CSV_HEIGHT =
ingo@2714:         "export.bedheight_middle.csv.header.height";
ingo@2714: 
ingo@2714:     public static final String CSV_UNCERTAINTY =
ingo@2714:         "export.bedheight_middle.csv.header.uncertainty";
ingo@2714: 
ingo@2714:     public static final String CSV_DATA_GAP =
ingo@2714:         "export.bedheight_middle.csv.header.datagap";
ingo@2714: 
ingo@2714:     public static final String CSV_SOUNDING_WIDTH =
ingo@2714:         "export.bedheight_middle.csv.header.soundingwidth";
ingo@2714: 
ingo@2714:     public static final String CSV_WIDTH =
ingo@2714:         "export.bedheight_middle.csv.header.width";
ingo@2714: 
ingo@2714:     public static final String CSV_LOCATIONS =
ingo@2714:         "export.bedheight_middle.csv.header.locations";
ingo@2714: 
rrenkert@7994:     public static final String CSV_META_YEAR =
tom@8267:         "meta.bedheight.year";
rrenkert@7994: 
rrenkert@7994:     public static final String CSV_META_TYPE =
tom@8267:         "meta.bedheight.type";
rrenkert@7994: 
rrenkert@7994:     public static final String CSV_META_CUR_ELEV_MODEL =
tom@8267:         "meta.bedheight.cur.elevation";
rrenkert@7994: 
rrenkert@7994:     public static final String CSV_META_OLD_ELEV_MODEL =
tom@8267:         "meta.bedheight.old.elevation";
rrenkert@7994: 
rrenkert@7999:     public static final String CSV_META_RIVER_ELEV_MODEL =
tom@8267:         "meta.bedheight.river.elevation";
rrenkert@7999: 
rrenkert@7994:     public static final String CSV_META_SOUNDING_WIDTH =
tom@8267:         "meta.bedheight.sounding.width";
rrenkert@7994: 
rrenkert@7994:     public static final String CSV_META_RANGE =
tom@8267:         "meta.bedheight.range";
rrenkert@7994: 
rrenkert@7994:     public static final String CSV_META_LOC_SYSTEM =
tom@8267:         "meta.bedheight.location.system";
rrenkert@7994: 
rrenkert@7994:     public static final String CSV_META_EVAL_BY =
tom@8267:         "meta.bedheight.evalby";
ingo@2714: 
aheinecke@7693:     protected List<MiddleBedHeightData> data;
ingo@2714: 
teichmann@7077:     public MiddleBedHeightExporter() {
aheinecke@7693:         data = new ArrayList<MiddleBedHeightData>();
ingo@2714:     }
ingo@2714: 
ingo@2714:     @Override
ingo@2714:     protected void addData(Object d) {
ingo@2714:         if (d instanceof CalculationResult) {
ingo@2714:             d = ((CalculationResult) d).getData();
ingo@2714: 
ingo@2714:             if (d instanceof MiddleBedHeightData[]) {
teichmann@8202:                 log.debug("Add new data of type MiddleBedHeightData");
aheinecke@7693:                 for (MiddleBedHeightData mD :(MiddleBedHeightData[]) d) {
aheinecke@7693:                     data.add(mD);
aheinecke@7693:                 }
ingo@2714:             }
ingo@2714:         }
ingo@2714:     }
ingo@2714: 
ingo@2714: 
ingo@2714:     @Override
ingo@2714:     protected void writeCSVData(CSVWriter writer) {
teichmann@8202:         log.info("MiddleBedHeightExporter.writeCSVData");
teichmann@8202:         log.debug("CSV gets " + data.size() + " MiddleBedHeightData objects.");
ingo@2714: 
ingo@2714: 
aheinecke@7693:         Collections.sort(data);
aheinecke@7693: 
tom@8249:         writeCSVHeader(writer);
tom@8249: 
aheinecke@7693:         for (MiddleBedHeightData d: data) {
ingo@2714:             data2CSV(writer, d);
ingo@2714:         }
ingo@2714:     }
ingo@2714: 
ingo@2714: 
ingo@2714:     protected void writeCSVHeader(CSVWriter writer) {
felix@7600:         River river = RiverUtils.getRiver((D4EArtifact) master);
felix@7600:         String riverUnit = river.getWstUnit().getName();
ingo@2714:         writer.writeNext(new String[] {
ingo@2714:             msg(CSV_KM, CSV_KM),
ingo@2714:             msg(CSV_SOUNDING, CSV_SOUNDING),
felix@7600:             msg(CSV_HEIGHT, CSV_HEIGHT, new Object[] {riverUnit}),
ingo@2714:             msg(CSV_UNCERTAINTY, CSV_UNCERTAINTY),
ingo@2714:             msg(CSV_DATA_GAP, CSV_DATA_GAP),
ingo@2714:             msg(CSV_SOUNDING_WIDTH, CSV_SOUNDING_WIDTH),
ingo@2714:             msg(CSV_WIDTH, CSV_WIDTH),
ingo@2714:             msg(CSV_LOCATIONS, CSV_LOCATIONS)
ingo@2714:         });
ingo@2714:     }
ingo@2714: 
ingo@2714: 
aheinecke@7693:     protected void data2CSV(CSVWriter writer, MiddleBedHeightData data) {
teichmann@8202:         log.debug("Add next MiddleBedHeightData to CSV");
ingo@2714: 
teichmann@5867:         D4EArtifact flys = (D4EArtifact) master;
ingo@2714: 
rrenkert@7994:         writeMetaData(writer, data);
rrenkert@7994: 
ingo@2714:         NumberFormat kmF     = Formatter.getMiddleBedHeightKM(context);
ingo@2714:         NumberFormat heightF = Formatter.getMiddleBedHeightHeight(context);
ingo@2714:         NumberFormat uncertF = Formatter.getMiddleBedHeightUncert(context);
ingo@2714:         NumberFormat gapF    = Formatter.getMiddleBedHeightDataGap(context);
ingo@2714:         NumberFormat soundF  = Formatter.getMiddleBedHeightSounding(context);
ingo@2714:         NumberFormat widthF  = Formatter.getMiddleBedHeightWidth(context);
ingo@2714: 
rrenkert@4929:         heightF.setMaximumFractionDigits(1);
rrenkert@4929:         soundF.setMaximumFractionDigits(1);
ingo@2714: 
aheinecke@7693:         SortedMap <Double, Integer> kmIndexMap = new TreeMap<Double, Integer>();
ingo@2714: 
aheinecke@7693:         for (int i = 0, n = data.size(); i < n; i++) {
aheinecke@7693:             kmIndexMap.put(data.getKM(i), i);
aheinecke@7693:         }
aheinecke@7693: 
aheinecke@7693:         for (int i: kmIndexMap.values()) {
tom@8295:             String uncert = !Double.isNaN(data.getUncertainty(i)) ?
tom@8295:                 uncertF.format(data.getUncertainty(i)) : "";
tom@8295:             String gap = !Double.isNaN(data.getDataGap(i)) ?
tom@8295:                 gapF.format(data.getDataGap(i)) + "%" : "";
tom@8295:             String sound = !Double.isNaN(data.getSoundingWidth(i)) ?
tom@8295:                 soundF.format(data.getSoundingWidth(i)) : "";
tom@8295:             writer.writeNext(new String[] {
aheinecke@7693:                     kmF.format(data.getKM(i)),
aheinecke@7693:                     data.getDescription(),
aheinecke@7693:                     heightF.format(data.getMiddleHeight(i)),
aheinecke@7693:                     uncert,
aheinecke@7693:                     gap,
aheinecke@7693:                     sound,
aheinecke@7693:                     widthF.format(data.getWidth(i)),
aheinecke@7693:                     RiverUtils.getLocationDescription(flys, data.getKM(i)),
aheinecke@7693:                 });
ingo@2714:         }
ingo@2714:     }
ingo@2714: 
ingo@2714: 
rrenkert@7994:     private void writeMetaData(CSVWriter writer, MiddleBedHeightData data) {
rrenkert@8011:          String year = "";
tom@8295:          if (data.getYear() != 0) {
tom@8295:              year = String.valueOf(data.getYear());
rrenkert@8011:          }
tom@8296:          writeCSVInfo(writer, new String[] {
tom@8296:                  "", // blank meta-line to separate datasets in CSV
tom@8296:                  msg(CSV_META_YEAR) + ": " + year,
tom@8296:                  msg(CSV_META_TYPE) + ": " + data.getType(),
tom@8296:                  msg(CSV_META_LOC_SYSTEM) + ": " + data.getLocationSystem(),
tom@8296:                  msg(CSV_META_CUR_ELEV_MODEL) + ": " +
tom@8296:                      data.getCurElevationModel(),
tom@8296:                  msg(CSV_META_OLD_ELEV_MODEL) + ": " +
tom@8296:                      data.getOldElevationModel(),
tom@8296:                  msg(CSV_META_RIVER_ELEV_MODEL) + ": " +
tom@8296:                      data.getRiverElevationModel(),
tom@8296:                  msg(CSV_META_SOUNDING_WIDTH) + ": " + data.getSoundingWidth(),
tom@8296:                  msg(CSV_META_RANGE) + ": " + data.getStations().min() +
tom@8296:                      " - " + data.getStations().max(),
tom@8296:                  msg(CSV_META_EVAL_BY) + ": " + data.getEvaluatedBy()
tom@8296:              });
rrenkert@7994:     }
rrenkert@7994: 
ingo@2714:     @Override
ingo@2714:     protected void writePDF(OutputStream out) {
teichmann@8202:         log.error("TODO: Implement FlowVelocityExporter.writePDF");
ingo@2714:     }
ingo@2714: }
ingo@2714: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :