mschaefer@8971: /* Copyright (C) 2017 by Bundesanstalt für Gewässerkunde
mschaefer@8971:  * Software engineering by
mschaefer@8971:  *  Björnsen Beratende Ingenieure GmbH
mschaefer@8971:  *  Dr. Schumacher Ingenieurbüro für Wasser und Umwelt
mschaefer@8971:  *
mschaefer@8971:  * This file is Free Software under the GNU AGPL (>=v3)
mschaefer@8971:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
mschaefer@8971:  * documentation coming with Dive4Elements River for details.
mschaefer@8971:  */
mschaefer@8971: 
mschaefer@8971: package org.dive4elements.river.importer.sinfo;
mschaefer@8971: 
mschaefer@8971: import java.io.File;
mschaefer@8971: import java.util.ArrayList;
mschaefer@8971: import java.util.List;
mschaefer@8971: 
mschaefer@8971: import org.apache.log4j.Logger;
mschaefer@8971: import org.dive4elements.river.importer.ImportRiver;
mschaefer@8971: import org.dive4elements.river.importer.common.ImportParser;
mschaefer@8971: import org.dive4elements.river.importer.sinfo.parsers.BedMobilityParser;
mschaefer@8971: import org.dive4elements.river.importer.sinfo.parsers.ChannelParser;
mschaefer@8971: import org.dive4elements.river.importer.sinfo.parsers.CollisionParser;
mschaefer@8971: import org.dive4elements.river.importer.sinfo.parsers.DailyDischargeParser;
mschaefer@8971: import org.dive4elements.river.importer.sinfo.parsers.DepthEvolutionParser;
mschaefer@8971: import org.dive4elements.river.importer.sinfo.parsers.FlowDepthParser;
mschaefer@8971: import org.dive4elements.river.importer.sinfo.parsers.InfrastructureParser;
mschaefer@8971: import org.dive4elements.river.importer.sinfo.parsers.SelectedAdditionalParser;
mschaefer@8971: import org.dive4elements.river.importer.sinfo.parsers.TkhParser;
mschaefer@8971: 
mschaefer@8971: /**
mschaefer@8971:  * Import all S-INFO files of a river from its import directory and subdirectories<br />
mschaefer@8971:  * <br />
mschaefer@8971:  * Requires river and its gauges to exist in the database already
mschaefer@8971:  *
mschaefer@8971:  * @author Matthias Schäfer
mschaefer@8971:  *
mschaefer@8971:  */
mschaefer@8971: public class SInfoImporter
mschaefer@8971: {
mschaefer@8971:     /***** FIELDS *****/
mschaefer@8971: 
mschaefer@8971:     private static final Logger log = Logger.getLogger(SInfoImporter.class);
mschaefer@8971: 
mschaefer@8971:     private static final String SINFO_DIR = "Schifffahrt";
mschaefer@8971: 
mschaefer@8971:     private enum SInfoDirName {
mschaefer@8971:         BASICS("Basisdaten"), //
mschaefer@8971:         SELECTED_ADDITIONAL("Selektierte_Zusaetzliche_Laengsschnitte"), //
mschaefer@8971:         INFRASTRUCTURE("Infrastrukturen_BWaStr"), //
mschaefer@8992:         CHANNEL("Zu_gewaehrleistende_Fahrrinnenverhaeltnisse"), //
mschaefer@8971:         COLLISION_EINZEL("Grundberuehrungen" + File.separator + "Einzeljahre"), //
mschaefer@9636:         TKH_NATUR("Transportkoerperhoehen" + File.separator + TkhParser.GroupDirectory.MEASUREMENT.getDirName()), //
mschaefer@9636:         TKH_BERECHNUNG("Transportkoerperhoehen" + File.separator + TkhParser.GroupDirectory.CALCULATION.getDirName()), //
mschaefer@8971:         FLOW_DEPTH("Modellierte_Datensaetze" + File.separator + "Fliesstiefen"), //
mschaefer@9636:         DEPTH_EVOLUTION_AKTUELL("Fliesstiefenentwicklung" + File.separator + DepthEvolutionParser.GroupDirectory.AKTUELL.getDirName()), //
mschaefer@9636:         DEPTH_EVOLUTION_ETAPPEN("Fliesstiefenentwicklung" + File.separator + DepthEvolutionParser.GroupDirectory.ETAPPE.getDirName());
mschaefer@8971: 
mschaefer@8971:         private final String dirname;
mschaefer@8971: 
mschaefer@8971:         SInfoDirName(final String dirname) {
mschaefer@8971:             this.dirname = dirname;
mschaefer@8971:         }
mschaefer@8971: 
mschaefer@8971:         public String getDir() {
mschaefer@8971:             return this.dirname;
mschaefer@8971:         }
mschaefer@8971:         public File getFile() {
mschaefer@8971:             return new File(getDir());
mschaefer@8971:         }
mschaefer@8971: 
mschaefer@8971:         public File buildPath(final File rootDir) {
mschaefer@8971:             return new File(rootDir, getDir());
mschaefer@8971:         }
mschaefer@8971:     }
mschaefer@8971: 
mschaefer@8971:     /**
mschaefer@8971:      * Series of river's stations with bed mobility flag.
mschaefer@8971:      */
mschaefer@8971:     private final List<ImportParser> parsers;
mschaefer@8971: 
mschaefer@8971:     /**
mschaefer@8971:      * Path of the S-INFO data directory of the importing river.
mschaefer@8971:      */
mschaefer@8971:     private File rootDir;
mschaefer@8971: 
mschaefer@8971: 
mschaefer@8971:     /***** CONSTRUCTOR *****/
mschaefer@8971: 
mschaefer@8971:     public SInfoImporter() {
mschaefer@8971:         this.parsers = new ArrayList<>();
mschaefer@8971:     }
mschaefer@8971: 
mschaefer@8971:     /***** METHODS *****/
mschaefer@8971: 
mschaefer@8971:     /**
mschaefer@8971:      * Inits the parser list regarding the skip flags.
mschaefer@8971:      */
mschaefer@8971:     public void setup(final File riverDir, final ImportRiver river) {
mschaefer@8971:         this.rootDir = new File(riverDir, SINFO_DIR);
mschaefer@8971:         log.info("Parse S-INFO files from " + this.rootDir);
mschaefer@8971:         this.parsers.clear();
mschaefer@8971:         if (!BedMobilityParser.shallSkip()) {
mschaefer@8971:             if (!this.parsers.addAll(BedMobilityParser.createParsers(SInfoDirName.BASICS.buildPath(this.rootDir), SInfoDirName.BASICS.getFile(), river)))
mschaefer@8971:                 log.info("Bed mobility: no files found");
mschaefer@8971:         }
mschaefer@8971:         else {
mschaefer@8971:             log.info("Bed mobility: skipped");
mschaefer@8971:         }
mschaefer@8971:         if (!SelectedAdditionalParser.shallSkip()) {
mschaefer@8971:             if (!this.parsers.addAll(SelectedAdditionalParser.createParsers(SInfoDirName.SELECTED_ADDITIONAL.buildPath(this.rootDir),
mschaefer@8971:                     SInfoDirName.SELECTED_ADDITIONAL.getFile(), river)))
mschaefer@8971:                 log.info("Selected additionals: no files found");
mschaefer@8971:         }
mschaefer@8971:         else {
mschaefer@8971:             log.info("Selected additionals: skipped");
mschaefer@8971:         }
mschaefer@8971:         if (!InfrastructureParser.shallSkip()) {
mschaefer@8971:             if (!this.parsers.addAll(InfrastructureParser.createParsers(SInfoDirName.INFRASTRUCTURE.buildPath(this.rootDir),
mschaefer@8971:                     SInfoDirName.INFRASTRUCTURE.getFile(), river)))
mschaefer@8971:                 log.info("Infrastructure: no files found");
mschaefer@8971:         }
mschaefer@8971:         else {
mschaefer@8971:             log.info("Infrastructure: skipped");
mschaefer@8971:         }
mschaefer@8971:         if (!ChannelParser.shallSkip()) {
mschaefer@8971:             if (!this.parsers.addAll(ChannelParser.createParsers(SInfoDirName.CHANNEL.buildPath(this.rootDir), SInfoDirName.CHANNEL.getFile(), river)))
mschaefer@8971:                 log.info("Channel: no files found");
mschaefer@8971:         }
mschaefer@8971:         else {
mschaefer@8971:             log.info("Channel: skipped");
mschaefer@8971:         }
mschaefer@8971:         if (!CollisionParser.shallSkip()) {
mschaefer@8971:             boolean added = false;
mschaefer@8971:             added = this.parsers.addAll(CollisionParser.createParsers(SInfoDirName.COLLISION_EINZEL.buildPath(this.rootDir),
mschaefer@8971:                     SInfoDirName.COLLISION_EINZEL.getFile(), river));
mschaefer@8971:             if (!added)
mschaefer@8971:                 log.info("Collision: no files found");
mschaefer@8971:         }
mschaefer@8971:         else {
mschaefer@8971:             log.info("Collision: skipped");
mschaefer@8971:         }
mschaefer@8971:         if (!DailyDischargeParser.shallSkip()) {
mschaefer@8971:             if (!this.parsers.addAll(DailyDischargeParser.createParsers(SInfoDirName.BASICS.buildPath(this.rootDir), SInfoDirName.BASICS.getFile(), river)))
mschaefer@8971:                 log.info("Daily discharge: no files found");
mschaefer@8971:         }
mschaefer@8971:         else {
mschaefer@8971:             log.info("Daily discharge: skipped");
mschaefer@8971:         }
mschaefer@8971:         if (!TkhParser.shallSkip()) {
mschaefer@8971:             boolean added = false;
mschaefer@9011:             added = this.parsers.addAll(TkhParser.createParsers(SInfoDirName.TKH_NATUR.buildPath(this.rootDir),
mschaefer@9011:                     SInfoDirName.TKH_NATUR.getFile(), river));
mschaefer@9011:             added |= this.parsers.addAll(TkhParser.createParsers(SInfoDirName.TKH_BERECHNUNG.buildPath(this.rootDir),
mschaefer@9011:                     SInfoDirName.TKH_BERECHNUNG.getFile(), river));
mschaefer@8971:             if (!added)
mschaefer@8971:                 log.info("Tkh: no files found");
mschaefer@8971:         }
mschaefer@8971:         else {
mschaefer@8971:             log.info("Tkh: skipped");
mschaefer@8971:         }
mschaefer@8971:         if (!FlowDepthParser.shallSkip()) {
mschaefer@8971:             if (!this.parsers.addAll(FlowDepthParser.createParsers(SInfoDirName.FLOW_DEPTH.buildPath(this.rootDir), SInfoDirName.FLOW_DEPTH.getFile(), river)))
mschaefer@8971:                 log.info("FlowDepth: no files found");
mschaefer@8971:         }
mschaefer@8971:         else {
mschaefer@8971:             log.info("FlowDepth: skipped");
mschaefer@8971:         }
mschaefer@8971:         if (!DepthEvolutionParser.shallSkip()) {
mschaefer@8971:             boolean added = false;
mschaefer@8971:             added = this.parsers.addAll(DepthEvolutionParser.createParsers(SInfoDirName.DEPTH_EVOLUTION_AKTUELL.buildPath(this.rootDir),
mschaefer@8971:                     SInfoDirName.DEPTH_EVOLUTION_AKTUELL.getFile(), river));
mschaefer@8971:             added |= this.parsers.addAll(DepthEvolutionParser.createParsers(SInfoDirName.DEPTH_EVOLUTION_ETAPPEN.buildPath(this.rootDir),
mschaefer@8971:                     SInfoDirName.DEPTH_EVOLUTION_ETAPPEN.getFile(), river));
mschaefer@8971:             if (!added)
mschaefer@8971:                 log.info("Depth evolution: no files found");
mschaefer@8971:         }
mschaefer@8971:         else {
mschaefer@8971:             log.info("Depth evolution: skipped");
mschaefer@8971:         }
mschaefer@8971:     }
mschaefer@8971: 
mschaefer@8971:     /**
mschaefer@8971:      * Imports the files according to the active parser list
mschaefer@8971:      */
mschaefer@9651:     public void parse() throws Exception {
mschaefer@8971:         for (final ImportParser parser : this.parsers)
mschaefer@8971:             parser.parse();
mschaefer@8971:     }
mschaefer@8971: 
mschaefer@8971:     /**
mschaefer@8971:      * Stores all pending import objects
mschaefer@8971:      */
mschaefer@8971:     public void store() {
mschaefer@8971:         for (final ImportParser parser : this.parsers)
mschaefer@8971:             parser.store();
mschaefer@8971:     }
mschaefer@8971: 
mschaefer@8971: }