/**
 * Copyright © CENRA (2016)
 *
 * remi.clement@espaces-naturels.fr
 * 
 * This software is a multi-platform and portable application based on 
 * the scientifical toolbox to monitor wetlands. With this toolbox it’s 
 * possible to calculate indicators «RhoMéO» to monitor quality, 
 * fonctionalities and urban and agricultural pressures of wetlands. 
 * Indicators are calculated using naturalist data entered and/or imported,
 * and geographic data downloaded from a geographic server.
 * 
 * This software is governed by the CeCILL license under French law and
 * abiding by the rules of distribution of free software.  You can  use, 
 * modify and/ or redistribute the software under the terms of the CeCILL
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info". 
 * 
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability. 
 * 
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or 
 * data to be ensured and,  more generally, to use and operate it in the 
 * same conditions as regards security. 
 * 
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL license and that you accept its terms.
*/
package fr.cenra.rhomeo.protocol.p03;

import fr.cenra.rhomeo.api.data.AbstractProtocol;
import fr.cenra.rhomeo.api.data.Dataset;
import fr.cenra.rhomeo.api.data.Statement;
import fr.cenra.rhomeo.api.data.TrackingPoint;
import fr.cenra.rhomeo.protocol.p03.validation.DataCoverage;
import fr.cenra.rhomeo.protocol.p03.validation.SinglePoint;
import java.time.LocalDate;
import java.time.Month;
import java.time.MonthDay;
import java.time.temporal.ChronoUnit;
import java.util.HashSet;
import java.util.List;
import org.springframework.stereotype.Component;

/**
 * Piezometry protocol.
 *
 * @author Samuel Andrés (Geomatys)
 */
@SinglePoint
@DataCoverage
@Component(P03.NAME)
public class P03 extends AbstractProtocol {

    public static final String NAME = "P03";
    public static final String REMARKS = "Piézométrie";

    static final MonthDay YEAR_START = MonthDay.of(Month.SEPTEMBER, 1);
    static final MonthDay YEAR_END = MonthDay.of(Month.AUGUST, 31);

    public P03(){
        super(NAME, REMARKS, P03Statement.class);
    }

    @Override
    public TrackingPoint createTrackingPoint(String name, int year) {
        return new TrackingPoint(name, year, YEAR_START.atYear(year -1), YEAR_END.atYear(year));
    }

    @Override
    public TrackingPoint createTrackingPoint(String name, LocalDate statementDate) {
        final int year;
        if (statementDate.getMonthValue() < Month.SEPTEMBER.getValue()) {
            year = statementDate.getYear();
        } else {
            year = statementDate.getYear() + 1;
        }
        return createTrackingPoint(name, year);
    }

    /**
     * Compute data coverage for the given tracking point over input dataset.
     * @param target
     * @param dataset
     * @return Percent of days in the given tracking point in which at least one
     * statement can be found.
     */
    public static float computeDataCoverage(final TrackingPoint target, final List<Statement> dataset) {
        if (target == null || dataset == null || dataset.isEmpty()) {
            return 0f;
        } else {
            // To get numbered of covered days in the year, we get all distinct
            // dates present in the tracking point, which accept only data over one year.
            final HashSet<LocalDate> dates = new HashSet<>(Math.min(dataset.size(), 365));
            for (final Statement st : dataset) {
                if (Dataset.belongToPoint(target, st))
                    dates.add(st.getDate());
            }
            return (float) dates.size() / target.getYearStart().until(target.getYearEnd().plusDays(1), ChronoUnit.DAYS) * 100; // Convert to %
        }
    }
}
