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

import fr.cenra.rhomeo.api.Version;
import fr.cenra.rhomeo.api.data.DataContext;
import fr.cenra.rhomeo.api.data.Reference;
import fr.cenra.rhomeo.api.data.ReferenceDescription;
import fr.cenra.rhomeo.core.Session;
import fr.cenra.rhomeo.core.data.ReferenceManager;
import fr.cenra.rhomeo.core.list.HumidZoneType;
import java.beans.IntrospectionException;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/**
 *
 * @author Samuel Andrés (Geomatys)
 */
public abstract class AbstractIndicator implements Indicator {
    
    private final String name;
    private final String remarks;
    
    public AbstractIndicator(final String name, final String remarks){
        this.name = name;
        this.remarks = remarks;
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public Collection<String> getAlias() {
        return Collections.singleton(name);
    }

    @Override
    public String getRemarks() {
        return remarks;
    }

    /**
     * Default implementation. If some {@link Indicator} subclass is not compatible
     * with all {@link HumidZoneType}, this method MUST be overriden.
     * 
     * @return a set containing all environment codes because this indicator is
     * compatible with all of them.
     */
    @Override
    public Set<String> getZoneTypeCodes() {
        final Set<String> result = new HashSet<>();
        for(final HumidZoneType type : HumidZoneType.values()){
            result.add(type.getCode());
        }
        return result;
    }
    
    @Override
    public int compareTo(final Indicator i){
        return this.getName().compareTo(i.getName());
    }

    @Override
    public String toString() {
        return "AbstractIndicator{" + "name=" + name + ", remarks=" + remarks + '}';
    }
    
    

    /**
     * Get the references relative to the reference description parameter.
     * 
     * => DEPLACER VERS ReferenceManager ?
     * 
     * @param <T>
     * @param description
     * @return
     * @throws IntrospectionException 
     */
    public static <T extends Reference> List<T> getReferences(final ReferenceDescription<T> description) throws IntrospectionException {
        final ReferenceManager<T> referenceManager = ReferenceManager.getOrCreate(description);
        final DataContext dc = Session.getInstance().getDataContext();
        final Version versionSel = dc.getReferences().get(description.getReferenceType());
        return referenceManager.getValues(versionSel != null ? versionSel : referenceManager.getInstalledVersions().iterator().next());
    }
}
