com.powsybl.iidm.geodata.odre.OdreGeoDataAdderPostProcessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powsybl-iidm-geodata Show documentation
The IIDM module to load geographical data on a network
The newest version!
/**
 * Copyright (c) 2024, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 * SPDX-License-Identifier: MPL-2.0
 */
package com.powsybl.iidm.geodata.odre;

import com.google.auto.service.AutoService;
import com.powsybl.commons.PowsyblException;
import com.powsybl.commons.config.PlatformConfig;
import com.powsybl.computation.ComputationManager;
import com.powsybl.iidm.network.ImportPostProcessor;
import com.powsybl.iidm.network.Network;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Map;
import java.util.Objects;

/**
 * @author Hugo Kulesza {@literal }
 */
@AutoService(ImportPostProcessor.class)
public class OdreGeoDataAdderPostProcessor implements ImportPostProcessor {

    public static final String NAME = "odreGeoDataImporter";
    public static final Map DEFAULT_FILE_NAMES = Map.of("substations", "substations.csv",
            "aerial-lines", "aerial-lines.csv",
            "underground-lines", "underground-lines.csv");

    private static final Logger LOGGER = LoggerFactory.getLogger(OdreGeoDataAdderPostProcessor.class);
    private final Path substationsFilePath;
    private final Path aerialLinesFilePath;
    private final Path undergroundLinesFilePath;

    private final OdreConfig odreConfig;

    public OdreGeoDataAdderPostProcessor() {
        this(PlatformConfig.defaultConfig(), OdreConfig.getDefaultOdreConfig());
    }

    public OdreGeoDataAdderPostProcessor(PlatformConfig config) {
        this(config, OdreConfig.getDefaultOdreConfig());
    }

    public OdreGeoDataAdderPostProcessor(PlatformConfig config, OdreConfig odreConfig) {
        this(getEquipmentFileFromConfig(config, "substations"),
                getEquipmentFileFromConfig(config, "aerial-lines"),
                getEquipmentFileFromConfig(config, "underground-lines"),
                odreConfig);
    }

    public OdreGeoDataAdderPostProcessor(Path substationsFilePath, Path aerialLinesFilePath,
                                         Path undergroundLinesFilePath, OdreConfig odreConfig) {
        this.substationsFilePath = substationsFilePath;
        this.aerialLinesFilePath = aerialLinesFilePath;
        this.undergroundLinesFilePath = undergroundLinesFilePath;
        this.odreConfig = odreConfig;
    }

    private static Path getEquipmentFileFromConfig(PlatformConfig platformConfig, String type) {
        Objects.requireNonNull(platformConfig);
        return platformConfig.getOptionalModuleConfig("odre-geo-data-importer-post-processor")
                .flatMap(config -> config.getOptionalPathProperty(type))
                .or(() -> platformConfig.getConfigDir().map(dir -> dir.resolve(DEFAULT_FILE_NAMES.get(type))))
                .orElseThrow(() -> new PowsyblException("No file path nor configuration directory defined in platform config for " + type));
    }

    @Override
    public String getName() {
        return NAME;
    }

    @Override
    public void process(Network network, ComputationManager computationManager) throws IOException {
        if (Files.exists(substationsFilePath)) {
            OdreGeoDataAdder.fillNetworkSubstationsGeoDataFromFile(network, substationsFilePath, odreConfig);
            boolean aerialLinesPresent = Files.exists(aerialLinesFilePath);
            boolean undergroundLinesPresent = Files.exists(undergroundLinesFilePath);
            if (aerialLinesPresent && undergroundLinesPresent) {
                OdreGeoDataAdder.fillNetworkLinesGeoDataFromFiles(network, aerialLinesFilePath, undergroundLinesFilePath, odreConfig);
            } else {
                String missingAerialFiles = aerialLinesPresent ? "" : aerialLinesFilePath + " ";
                String missingFiles = missingAerialFiles.concat(undergroundLinesPresent ? "" : undergroundLinesFilePath.toString());
                LOGGER.warn("Could not load lines geographical data, file(s) not found : {}", missingFiles);
            }
        } else {
            LOGGER.warn("Could not load substations geographical data, file not found : {}", substationsFilePath);
        }
    }
}