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

import java.io.IOException;
import java.nio.file.Path;
import java.util.Set;

/**
 * A service whose aim is to serialize / deserialize {@link AdditionalValue }
 * from file-system.
 *
 * @author Alexis Manin (Geomatys)
 */
public interface AdditionalValueMapper {

    /**
     * Read additional data contained in given folder, if any.
     *
     * @param folder The directory containing data to read.
     * @return Set of read values. Can be empty, but should not be null.
     * @throws java.io.IOException If values have been found, but an error
     * occurred while reading them.
     */
    Set<AdditionalValue> readValues(final Path folder) throws IOException;

    /**
     * Write a given set of {@link AdditionalValue} in a specific folder, if the
     * current service is designed to treat input data type. Do nothing
     * otherwise.
     *
     * @param folder To put data into.
     * @param toWrite Set of values to serialise.
     * @return True if current service is able to write input values (and has
     * succeeded in doing so). False otherwise.
     * @throws java.io.IOException If an error occurs while writing given
     * values.
     */
    boolean writeValues(final Path folder, final Set<AdditionalValue> toWrite) throws IOException;
}
