/**
 * 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.api.data;

import fr.cenra.rhomeo.api.IdentifiedObject;
import fr.cenra.rhomeo.api.process.Indicator;
import java.time.LocalDate;
import java.util.Set;
import javax.validation.constraints.NotNull;

/**
 * Defines a scientific protocol designed to hold a specific set of measures.
 *
 * @author Alexis Manin (Geomatys)
 */
public interface Protocol extends IdentifiedObject, Comparable<Protocol> {

    /**
     *
     * @return {@link Statement} class defining measure content. Must not be null.
     */
    @NotNull
    Class<? extends Statement> getDataType();

    /**
     *
     * @return Set of reference types needed to complete seizure / processing of
     * the protocol measures. Should never be null, but can be empty.
     */
    @NotNull
    Set<ReferenceDescription> getReferenceTypes();

    /**
     *
     * @param site A site to analyze.
     * @return True if we can process {@link Indicator}s associated to the current
     * protocol with given site. False otherwise.
     */
    boolean isCompatible(Site site);

    /**
     * Create a tracking point with the provided name, whose year contains the
     * given date. This method is useful when you've got a {@link Statement},
     * and want to know which stating year owns it.
     *
     * @param name The name of the tracking point.
     * @param statementDate A date to get matching year for.
     * @return A new tracking point. Never null.
     */
    default TrackingPoint createTrackingPoint(final String name, final LocalDate statementDate) {
        return new TrackingPoint(name, statementDate.getYear());
    }

    /**
     * Create a new tracking point named as specified, on the given year. A year
     * is not always a calendar year. It can go between two chosen dates.
     *
     * Ex : You can specify that year 2015 goes from September, 1st of 2014 to
     * August, 31th of 2015
     *
     * @param name The name to set on the new tracking point.
     * @param year The year to affect to the tracking point.
     * @return A new tracking point. Never null.
     */
    default TrackingPoint createTrackingPoint(final String name, final int year) {
        return new TrackingPoint(name, year);
    }
}
