teichmann@5844: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5844:  * Software engineering by Intevation GmbH
teichmann@5844:  *
teichmann@5992:  * This file is Free Software under the GNU AGPL (>=v3)
teichmann@5844:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5992:  * documentation coming with Dive4Elements River for details.
teichmann@5844:  */
teichmann@5844: 
teichmann@5829: package org.dive4elements.river.importer.parsers;
ingo@2850: 
ingo@2850: import java.io.File;
ingo@2850: import java.io.IOException;
felix@5229: import java.math.BigDecimal;
ingo@2850: import java.text.NumberFormat;
ingo@2850: import java.text.ParseException;
ingo@2850: import java.util.ArrayList;
ingo@2850: import java.util.List;
ingo@2850: import java.util.regex.Matcher;
ingo@2850: import java.util.regex.Pattern;
ingo@2850: 
ingo@2850: import org.apache.log4j.Logger;
ingo@2850: 
felix@6291: import org.dive4elements.river.importer.ImportTimeInterval;
teichmann@5829: import org.dive4elements.river.importer.ImportUnit;
ingo@2850: 
teichmann@5829: import org.dive4elements.river.importer.ImportWst;
felix@6320: import org.dive4elements.river.importer.ImportWstQRange;
teichmann@5829: import org.dive4elements.river.importer.ImportWstColumn;
felix@6320: import org.dive4elements.river.importer.ImportWstColumnValue;
teichmann@8187: import org.dive4elements.river.backend.utils.DateUtil;
ingo@2850: 
felix@5229: 
felix@5229: /**
felix@5229:  * Parse WaterlevelDifferences CSV file.
felix@5229:  */
ingo@2850: public class WaterlevelDifferencesParser extends LineParser {
ingo@2850: 
ingo@2850:     private static final Logger log =
ingo@2850:         Logger.getLogger(WaterlevelDifferencesParser.class);
ingo@2850: 
ingo@2850:     private static final NumberFormat nf =
ingo@2850:         NumberFormat.getInstance(DEFAULT_LOCALE);
ingo@2850: 
ingo@2850:     public static final Pattern META_UNIT =
ingo@2850:         Pattern.compile("^Einheit: \\[(.*)\\].*");
ingo@2850: 
felix@6287:     public static final Pattern YEARS_IN_COLUMN =
felix@6287:         Pattern.compile(".*(\\d{4})-(\\d{4})$");
felix@6287: 
tom@7377:     public static final double INTERVAL_GAP = 0.00001d;
tom@7377: 
felix@5233:     /** List of parsed differences as ImportWst s. */
felix@5233:     private List<ImportWst> differences;
ingo@2850: 
felix@5233:     private ImportWstColumn[] columns;
ingo@2850: 
felix@5233:     /** The currently processed dataset. */
felix@5233:     private ImportWst current;
ingo@2850: 
ingo@2850: 
ingo@2850:     public WaterlevelDifferencesParser() {
felix@5233:         differences = new ArrayList<ImportWst>();
ingo@2850:     }
ingo@2850: 
ingo@2850: 
felix@5233:     /** Get the differences as wst parsed so far. */
felix@5233:     public List<ImportWst> getDifferences() {
ingo@2850:         return differences;
ingo@2850:     }
ingo@2850: 
felix@5234: 
felix@5234:     /**
felix@5234:      * Parse a csv waterleveldifferenceparser and create a ImportWst object
felix@5234:      * from it.
felix@5234:      */
ingo@2850:     @Override
ingo@2850:     public void parse(File file) throws IOException {
felix@5233:         current = new ImportWst(file.getName());
felix@6282:         current.setKind(6);
ingo@2850: 
ingo@2850:         super.parse(file);
ingo@2850:     }
ingo@2850: 
ingo@2850: 
felix@5234:     /** No rewind implemented. */
ingo@2850:     @Override
ingo@2850:     protected void reset() {
ingo@2850:     }
ingo@2850: 
ingo@2850: 
ingo@2850:     @Override
ingo@2850:     protected void finish() {
ingo@2850:         if (columns != null && current != null) {
felix@5233:             // TODO figure out if its needed, as the columns
felix@5233:             //      are registered at their construction time.
felix@5233:             for (ImportWstColumn col: columns) {
felix@5233:                 // TODO place a current.addColumn(col); here?
ingo@2850:             }
ingo@2850: 
ingo@2850:             differences.add(current);
ingo@2850:         }
ingo@2850: 
felix@6320:         // For all differences columns, add a single Q-Range with
tom@7377:         // -1.
tom@7377:         // Expand range to minimal length in case it would be 0
teichmann@7883:         // TODO: should otherwise be extended to
teichmann@7883:         // (first station of next range - INTERVAL_GAP),
tom@7377:         // assuming always ascending stations
felix@6320:         for (ImportWstColumn column: columns) {
felix@6320:             List<ImportWstColumnValue> cValues = column.getColumnValues();
tom@7377:             BigDecimal a = cValues.get(0).getPosition();
tom@7377:             BigDecimal b = cValues.get(cValues.size() - 1).getPosition();
tom@7377:             if (a.compareTo(b) == 0) {
tom@7377:                 b = new BigDecimal(b.doubleValue() + INTERVAL_GAP);
tom@7377:             }
felix@6320:             column.addColumnQRange(
felix@6320:                 new ImportWstQRange(
tom@7377:                     a,
tom@7377:                     b,
tom@7377:                     new BigDecimal(-1d))
felix@6320:                 );
felix@6320:         }
ingo@2850:         current = null;
ingo@2850:         columns = null;
ingo@2850:     }
ingo@2850: 
felix@5234: 
ingo@2850:     @Override
ingo@4193:     protected void handleLine(int lineNum, String line) {
ingo@2850:         if (line.startsWith(START_META_CHAR)) {
ingo@2850:             handleMetaLine(stripMetaLine(line));
ingo@2850:         }
ingo@2850:         else {
ingo@2850:             handleDataLine(line);
ingo@2850:         }
ingo@2850:     }
ingo@2850: 
ingo@2850: 
ingo@2850:     private void handleMetaLine(String meta) {
ingo@2850:         if (handleMetaUnit(meta)) {
ingo@2850:             return;
ingo@2850:         }
ingo@2850:         else {
ingo@2850:             handleMetaColumnNames(meta);
ingo@2850:         }
ingo@2850:     }
ingo@2850: 
ingo@2850: 
ingo@2850:     private boolean handleMetaUnit(String meta) {
ingo@2850:         Matcher m = META_UNIT.matcher(meta);
ingo@2850: 
ingo@2850:         if (m.matches()) {
ingo@2850:             String unit = m.group(1);
ingo@2850:             log.debug("Found unit: '" + unit + "'");
ingo@2850: 
ingo@2850:             current.setUnit(new ImportUnit(unit));
ingo@2850: 
ingo@2850:             return true;
ingo@2850:         }
ingo@2850: 
ingo@2850:         return false;
ingo@2850:     }
ingo@2850: 
ingo@2850: 
ingo@2850:     private boolean handleMetaColumnNames(String meta) {
ingo@2850:         Pattern META_COLUMN_NAMES = Pattern.compile("Fluss-km;(.*)");
ingo@2850:         Matcher m = META_COLUMN_NAMES.matcher(meta);
ingo@2850: 
ingo@2850:         if (m.matches()) {
ingo@2850:             String colStr = m.group(1);
ingo@2850:             String[] cols = colStr.split(SEPERATOR_CHAR);
ingo@2850: 
ingo@2850:             log.debug("Found " + cols.length + " columns.");
ingo@2850: 
ingo@2850:             initColumns(cols);
ingo@2850: 
ingo@2850:             return true;
ingo@2850:         }
ingo@2850: 
ingo@2850:         return false;
ingo@2850:     }
ingo@2850: 
ingo@2850: 
felix@6286:     /** Setup column structures with name, description and time interval. */
ingo@2850:     private void initColumns(String[] cols) {
felix@5264:         current.setNumberColumns(cols.length);
tom@8856:         columns = current.getColumns().toArray(
tom@8856:             new ImportWstColumn[cols.length]);
ingo@2850: 
ingo@2850:         for (int i = 0; i < cols.length; i++) {
ingo@2850:             String name = cols[i].replace("\"", "");
ingo@2850: 
ingo@2850:             log.debug("Create new column '" + name + "'");
felix@6290:             ImportWstColumn column = current.getColumn(i);
felix@6290:             column.setName(name);
felix@6290:             column.setDescription(name);
felix@6287: 
felix@6287:             Matcher m = YEARS_IN_COLUMN.matcher(name);
felix@6287: 
felix@6287:             if (m.matches()) {
felix@6291:                 int startYear = Integer.parseInt(m.group(1));
felix@6291:                 int endYear   = Integer.parseInt(m.group(2));
felix@6291:                 ImportTimeInterval time = new ImportTimeInterval(
tom@7927:                     DateUtil.getStartDateFromYear(startYear),
tom@7927:                     DateUtil.getEndDateFromYear(endYear)
felix@6291:                 );
felix@6291:                 column.setTimeInterval(time);
felix@6287:             } else {
felix@6287:                 log.debug("No time interval in column header found: " + name);
felix@6287:             }
ingo@2850:         }
ingo@2850:     }
ingo@2850: 
ingo@2850: 
felix@6752:     /** Handle one line of data, add one value for all columns.
felix@6752:      * @param line the line to parse
felix@6752:      */
ingo@2850:     private void handleDataLine(String line) {
felix@6753:         // Split by separator, do not exclude trailing empty string.
felix@6753:         String[] cols = line.split(SEPERATOR_CHAR, -1);
ingo@2850: 
ingo@2850:         if (cols == null || cols.length < 2) {
felix@5230:             log.warn("skip invalid waterlevel-diff line: '" + line + "'");
ingo@2850:             return;
ingo@2850:         }
ingo@2850: 
ingo@2850:         try {
tom@8856:             // The first value in a line like 12,9;4,3;4,5 is the station,
tom@8856:             // later real values.
ingo@2850:             Double station = nf.parse(cols[0]).doubleValue();
ingo@2850: 
ingo@2850:             for (int i = 0; i < columns.length; i++) {
ingo@3940:                 int idx = i+1;
ingo@3940: 
ingo@3940:                 if (idx >= cols.length) {
ingo@3940:                     log.warn("Insufficient column numbers: " + line);
ingo@3940:                     continue;
ingo@3940:                 }
ingo@3940: 
ingo@3940:                 String value = cols[idx];
ingo@2850: 
felix@6752:                 if (value != null && !value.equals("")) {
felix@6752:                     try {
felix@6752:                         columns[i].addColumnValue(
felix@6752:                             new BigDecimal(station),
felix@6752:                             new BigDecimal(nf.parse(value).doubleValue()));
felix@6752:                     }
felix@6752:                     catch (ParseException pe) {
felix@6752:                         log.warn("Could not parse value: '" + value + "'");
felix@6752:                     }
ingo@2850:                 }
ingo@2850:             }
ingo@2850:         }
ingo@2850:         catch (ParseException pe) {
tom@5490:             log.warn("Could not parse station: '" + line + "'");
ingo@2850:         }
ingo@2850:     }
ingo@2850: }
ingo@2850: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :