/**
 * 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.Version;
import java.time.ZonedDateTime;
import java.util.HashMap;
import javafx.beans.property.SimpleObjectProperty;
import javafx.collections.FXCollections;
import javafx.collections.ObservableMap;
import javax.validation.constraints.NotNull;
import org.apache.sis.util.ArgumentChecks;

/**
 * Contains all data from the seizure context :
 * - Target Site
 * - Input protocol
 * - References versions
 * - Additional user data
 *
 * @author Alexis Manin (Geomatys)
 */
public class DataContext {

    private final Site site;
    private final Protocol protocol;

    private final SimpleObjectProperty<ZonedDateTime> dateProperty;

    private final ObservableMap<Class<Reference>, Version> references;

    private final ObservableMap<String, Object> userData;

    public DataContext(Site site, Protocol protocol) {
        ArgumentChecks.ensureNonNull("Input site", site);
        ArgumentChecks.ensureNonNull("Source protocol", protocol);
        this.site = site;
        this.protocol = protocol;
        dateProperty = new SimpleObjectProperty<>(ZonedDateTime.now());
        references = FXCollections.observableMap(new HashMap<>());
        userData = FXCollections.observableMap(new HashMap<>());
    }

    /**
     *
     * @return Protocol currently used for seizure.
     */
    @NotNull
    public Protocol getProtocol() {
        return protocol;
    }

    /**
     *
     * @return Site chosen for current session.
     */
    @NotNull
    public Site getSite() {
        return site;
    }

    /**
     *
     * @return References used for this seizure, along with the chosen version for
     * each of them.
     */
    @NotNull
    public ObservableMap<Class<Reference>, Version> getReferences() {
        return references;
    }

    /**
     *
     * @return References used for this seizure, along with the chosen version for
     * each of them.
     */
    @NotNull
    public ObservableMap<String, Object> getUserData() {
        return userData;
    }
    /**
     *
     * @return Creation date of this dataset.
     */
    public ZonedDateTime getDate() {
        return dateProperty.get();
    }

    /**
     * Set given date as creation date of this dataset.
     * @param date The date to use as new creation date.
     */
    public void setDate(final ZonedDateTime date) {
        dateProperty.set(date);
    }
}
