com.farao_community.farao.cse.data.CseReferenceExchanges Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gridcapa-cse-data Show documentation
Module that manages specific data format for CSE processes
There is a newer version: 1.38.0
/*
 * Copyright (c) 2021, 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/.
 */
package com.farao_community.farao.cse.data;

import com.powsybl.openrao.commons.EICode;
import com.farao_community.farao.cse.runner.api.resource.ProcessType;
import com.powsybl.iidm.network.Country;
import org.apache.poi.hssf.usermodel.HSSFRow;
import org.apache.poi.hssf.usermodel.HSSFSheet;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;

import java.io.IOException;
import java.io.InputStream;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.time.format.DateTimeFormatter;
import java.util.HashMap;
import java.util.Map;

import static com.farao_community.farao.cse.data.DateTimeUtil.*;

/**
 * @author Belgacem Najjari {@literal }
 */
public final class CseReferenceExchanges {
    private static final String IDCC_REFERENCE_SHEET = "Sheet 31";
    private static final String D2CC_REFERENCE_SHEET = "Sheet 7";
    private static final String POSTFIX_VULCANUS_FILE_NAME_WITH_MINUTES_STEP = "_96.xls";
    private static final int DATE_ROW = 3;
    private static final int DATE_COL = 1;
    private static final int LABEL_ROW = 5;
    private static final int TIME_COL = 0;

    private final Map exchanges;

    private CseReferenceExchanges(Map exchanges) {
        this.exchanges = exchanges;
    }

    public static CseReferenceExchanges fromVulcanusFile(OffsetDateTime targetDateTime, InputStream vulcanusFile, String vulcanusName, ProcessType processType) throws IOException {
        HSSFWorkbook workbook = new HSSFWorkbook(vulcanusFile);

        HSSFSheet worksheet;
        if (processType.equals(ProcessType.IDCC)) {
            worksheet = workbook.getSheet(IDCC_REFERENCE_SHEET);
        } else if (processType.equals(ProcessType.D2CC)) {
            worksheet = workbook.getSheet(D2CC_REFERENCE_SHEET);
        } else {
            throw new CseDataException("Cannot read reference exchanges from vulcanus file, unknown process type: " + processType);
        }
        String vulcanusTime = vulcanusName.toLowerCase().contains(POSTFIX_VULCANUS_FILE_NAME_WITH_MINUTES_STEP) ? getVulcanusTimeFromVulcanusFileWithMinutesStep(targetDateTime) : getVulcanusTimeFromVulcanusFileWithHourStep(targetDateTime);
        LocalDate vulcanusDate = LocalDate.parse(
            worksheet.getRow(DATE_ROW).getCell(DATE_COL).getStringCellValue(),
            DateTimeFormatter.ofPattern("dd.MM.yyyy")
        );
        checkDate(vulcanusDate, targetDateTime);
        HSSFRow targetRow = getRow(worksheet, vulcanusTime);
        return new CseReferenceExchanges(getExchangesFromRow(worksheet, targetRow));
    }

    public Map getExchanges() {
        return new HashMap<>(exchanges);
    }

    double getExchange(Country country) {
        return exchanges.get(new EICode(country).getAreaCode());
    }

    private static HSSFRow getRow(HSSFSheet worksheet, String vulcanusTime) {
        for (int rowIndex = 0; rowIndex < worksheet.getPhysicalNumberOfRows(); rowIndex++) {
            if (worksheet.getRow(rowIndex) != null && worksheet.getRow(rowIndex).getCell(TIME_COL) != null && worksheet.getRow(rowIndex).getCell(TIME_COL).getStringCellValue().equals(vulcanusTime)) {
                return worksheet.getRow(rowIndex);
            }
        }
        throw new IllegalStateException(String.format("Impossible to find the following time in the file : %s. Format error.", vulcanusTime));
    }

    private static Map getExchangesFromRow(HSSFSheet worksheet, HSSFRow row) {
        Map exchanges = new HashMap<>();
        for (int colIndex = 0; colIndex < row.getPhysicalNumberOfCells(); colIndex++) {
            String exchangeStr = worksheet.getRow(LABEL_ROW).getCell(colIndex) != null ? worksheet.getRow(LABEL_ROW).getCell(colIndex).getStringCellValue() : "";
            switch (exchangeStr) {
                case "CH > IT":
                    exchanges.put(new EICode(Country.CH).getAreaCode(), row.getCell(colIndex).getNumericCellValue());
                    break;
                case "FR > IT":
                    exchanges.put(new EICode(Country.FR).getAreaCode(), row.getCell(colIndex).getNumericCellValue());
                    break;
                case "IT > APG":
                    exchanges.put(new EICode(Country.AT).getAreaCode(), -row.getCell(colIndex).getNumericCellValue());
                    break;
                case "IT > SHB":
                    exchanges.put(new EICode(Country.SI).getAreaCode(), -row.getCell(colIndex).getNumericCellValue());
                    break;
                default:
                    break;
            }
        }
        return exchanges;
    }

}