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

import fr.cenra.rhomeo.core.RhomeoCore;
import java.util.Locale;
import java.util.ResourceBundle;
import java.util.logging.Level;

/**
 * An object able to provide some title and description for given (or default) locales.
 *
 * This interface provides a default implementation based on the class {@link ResourceBundle}.
 *
 * According to the default implementation, the title and the description are the values
 * of the keys {@link InternationalDescription#LABEL_KEY} and {@link InternationalDescription#DESCRIPTION_KEY} respectively.
 *
 * @author Samuel Andrés (Geomatys)
 */
public interface InternationalDescription {

    /**
     * The bundle key of the title value provided by the default implementation.
     */
    String LABEL_KEY = "_label";

    /**
     * The bundle key of the description value provided by the default implementation.
     */
    String DESCRIPTION_KEY = "_description";

    /**
     * Gets a title for the object.
     *
     * Default implementation returns the value of the {@link InternationalDescription#LABEL_KEY}
     * key stored into the class {@link ResourceBundle} for the given {@link Locale}.
     *
     * @param locale
     * @return
     */
    default String getLabel(final Locale locale) {
        try {
            final ResourceBundle bundle = ResourceBundle.getBundle(getClass().getName(), locale);
            return bundle.getString(LABEL_KEY);
        } catch (Exception e) {
            RhomeoCore.LOGGER.log(Level.WARNING, "Cannot find any title for this object.", e);
            return "No title available";
        }
    }

    /**
     * Gets a description for the object.
     *
     * Default implementation returns the value of the {@link InternationalDescription#DESCRIPTION_KEY}
     * key stored into the class {@link ResourceBundle} for the given {@link Locale}.
     *
     * @param locale
     * @return
     */
    default String getDescription(final Locale locale){
        try {
            final ResourceBundle bundle = ResourceBundle.getBundle(getClass().getName(), locale);
            return bundle.getString(DESCRIPTION_KEY);
        } catch (Exception e) {
            RhomeoCore.LOGGER.log(Level.WARNING, "Cannot find any title for this object.", e);
            return "No title available";
        }
    }

    /**
     * Shortcut method to avoid to specify locale parameter.
     *
     * Default implementation maps the {@link Locale#getDefault() } {@link Locale}.
     *
     * @return
     */
    default String getLabel(){return getLabel(Locale.getDefault());}

    /**
     * Shortcut method to avoid to specify locale parameter.
     *
     * Default implementation maps the {@link Locale#getDefault() } {@link Locale}.
     *
     * @return
     */
    default String getDescription(){return getDescription(Locale.getDefault());}
}
