PiecewiseConstantSpecificDays.java

/* ========================================================================
 * PlantUML : a free UML diagram generator
 * ========================================================================
 *
 * (C) Copyright 2009-2025, Arnaud Roques
 *
 * Project Info:  https://plantuml.com
 * 
 * If you like this project or if you find it useful, you can support us at:
 * 
 * https://plantuml.com/patreon (only 1$ per month!)
 * https://plantuml.com/paypal
 * 
 * This file is part of PlantUML.
 *
 * PlantUML is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PlantUML distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 *
 *
 * Original Author:  Arnaud Roques, Mario Kušek
 * 
 *
 */
package net.sourceforge.plantuml.project.ngm.math;

import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

/**
 * Immutable implementation of {@link PiecewiseConstant} that models a workload
 * pattern defined by specific dates.
 *
 * <p>
 * Each specific {@link LocalDate} value is associated with a constant
 * {@link Fraction} representing the workload for that day (for example 3/10 for
 * 30%). A zero value is meaningful and represents no allocation on that day.
 * </p>
 *
 * <p>
 * For any date not explicitly mapped, a default value is returned.
 * </p>
 */
public final class PiecewiseConstantSpecificDays extends AbstractPiecewiseConstant {

	/**
	 * Mapping of specific dates to their corresponding workload fractions.
	 */
	private final Map<LocalDate, Fraction> dayToFraction;

	/**
	 * Default workload fraction for dates not explicitly mapped.
	 */
	private final Fraction defaultValue;

	/**
	 * Constructs a PiecewiseConstantSpecificDays with the given default value.
	 * 
	 * @param value The default workload fraction.
	 */
	private PiecewiseConstantSpecificDays(Fraction value) {
		this(value, Collections.emptyMap());
	}

	/**
	 * Constructs a PiecewiseConstantSpecificDays with the given default value and
	 * specific day-to-fraction mapping.
	 * 
	 * @param value         The default workload fraction.
	 * @param dayToFraction Mapping of specific dates to their workload fractions.
	 */
	private PiecewiseConstantSpecificDays(Fraction value, Map<LocalDate, Fraction> dayToFraction) {
		defaultValue = value;
		this.dayToFraction = dayToFraction;
	}

	private Fraction getValue(LocalDate localDate) {
		if (dayToFraction.containsKey(localDate))
			return dayToFraction.get(localDate);

		return defaultValue;
	}

	/**
	 * Creates a PiecewiseConstantSpecificDays with the given default value.
	 * 
	 * @param value The default workload fraction.
	 * @return A new PiecewiseConstantSpecificDays instance.
	 */
	public static PiecewiseConstantSpecificDays of(Fraction value) {
		return new PiecewiseConstantSpecificDays(value);
	}

	/**
	 * Returns a new PiecewiseConstantSpecificDays with the specified day associated
	 * with the given fraction.
	 * 
	 * @param day   The specific date to associate.
	 * @param value The workload fraction for the specified date.
	 * @return A new PiecewiseConstantSpecificDays instance with the updated
	 *         mapping.
	 */
	public PiecewiseConstantSpecificDays withDay(LocalDate day, Fraction value) {
		final Map<LocalDate, Fraction> newDayToFraction = new HashMap<>(dayToFraction);
		newDayToFraction.put(day, value);
		return new PiecewiseConstantSpecificDays(defaultValue, newDayToFraction);
	}

	/**
	 * (non-Javadoc)
	 * 
	 * @see net.sourceforge.plantuml.project.ngm.math.AbstractPiecewiseConstant#segmentAt(java.time.LocalDateTime)
	 */
	@Override
	public Segment segmentAt(LocalDateTime instant, TimeDirection direction) {
		if (direction == TimeDirection.FORWARD) {
			final LocalDate day = instant.toLocalDate();
			final LocalDateTime start = day.atStartOfDay();
			final Fraction value = getValue(day);
			return Segment.forward(start, start.plusDays(1), value);
		}

		// BACKWARD: determine which day contains the instant
		final LocalDate day;
		if (instant.toLocalTime().equals(LocalTime.MIDNIGHT))
			day = instant.toLocalDate().minusDays(1);
		else
			day = instant.toLocalDate();

		final LocalDateTime end = day.atStartOfDay();
		final Fraction value = getValue(day);

		return Segment.backward(end.plusDays(1), end, value);

	}

}