com.farao_community.farao.cse.data.DateTimeUtil 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 java.time.*;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeParseException;

public final class DateTimeUtil {
    private static final int MINUTES_STEP = 15;

    private DateTimeUtil() {
        // Should not be instantiated
    }

    public static boolean isDayMatching(OffsetDateTime offsetDateTime, String day) {
        LocalDate utcDate = offsetDateTime.atZoneSameInstant(ZoneOffset.UTC).toLocalDate();
        LocalDate dayDate = LocalDate.parse(day, DateTimeFormatter.ofPattern("yyyy-MM-dd'Z'"));
        return utcDate.equals(dayDate);
    }

    public static boolean isTargetDateInInterval(OffsetDateTime targetDate, String startingTime, String endingTime) {
        try {
            OffsetDateTime startTime = OffsetDateTime.parse(startingTime);
            OffsetDateTime endTime = OffsetDateTime.parse(endingTime);
            return targetDate.isEqual(startTime) || targetDate.isAfter(startTime) && targetDate.isBefore(endTime);
        } catch (DateTimeParseException e) {
            double utcHour = targetDate.atZoneSameInstant(ZoneOffset.UTC).toLocalDateTime().getHour();
            double startHour = LocalTime.parse(startingTime, DateTimeFormatter.ofPattern("'T'HH:mm'Z'")).getHour();
            double endHour = LocalTime.parse(endingTime, DateTimeFormatter.ofPattern("'T'HH:mm'Z'")).getHour();
            // Patch to model that an end time of 00 is midnight, so we set it to 24 so that condition works
            if (endHour == 0) {
                endHour = 24;
            }
            return utcHour >= startHour && utcHour < endHour;
        }
    }

    static String getVulcanusTimeFromVulcanusFileWithMinutesStep(OffsetDateTime offsetDateTime) {
        if (offsetDateTime.getMinute() % MINUTES_STEP != 0) {
            throw new CseDataException(String.format("Process datetime minutes must be a multiple of %d.", MINUTES_STEP));
        }
        LocalDateTime localDateTimeStart = offsetDateTime.atZoneSameInstant(ZoneId.of("CET")).toLocalDateTime();
        LocalDateTime localDateTimeEnd = localDateTimeStart.plusMinutes(MINUTES_STEP);
        return localDateTimeStart.format(DateTimeFormatter.ofPattern("HH.mm")) + "-" + localDateTimeEnd.format(DateTimeFormatter.ofPattern("HH.mm"));
    }

    static String getVulcanusTimeFromVulcanusFileWithHourStep(OffsetDateTime offsetDateTime) {
        LocalDateTime localDateTimeStart = offsetDateTime.atZoneSameInstant(ZoneId.of("CET")).toLocalDateTime();
        LocalDateTime localDateTimeEnd = localDateTimeStart.plusHours(1);
        return localDateTimeStart.format(DateTimeFormatter.ofPattern("HH")) + "-" + localDateTimeEnd.format(DateTimeFormatter.ofPattern("HH"));
    }

    static void checkDate(LocalDate localDate, OffsetDateTime offsetDateTime) {
        LocalDate targetLocalDate = offsetDateTime.atZoneSameInstant(ZoneId.of("CET")).toLocalDate();
        if (!localDate.isEqual(targetLocalDate)) {
            throw new CseDataException("file is out of range for the target date");
        }
    }
}