delfos.io.xml.parameterowner.parameter.DoubleParameterXML.java Source code

Introduction

Here is the source code for delfos.io.xml.parameterowner.parameter.DoubleParameterXML.java

Source

/*
 * Copyright (C) 2016 jcastro
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package delfos.io.xml.parameterowner.parameter;

import delfos.common.Global;
import delfos.common.parameters.Parameter;
import delfos.common.parameters.ParameterOwner;
import delfos.common.parameters.restriction.DoubleParameter;
import org.jdom2.Element;

/**
 * Clase para realizar la entrada/salida a XML para parmetros reales de
 * {@link ParameterOwner}
 *
 * @version 1.0 (06/12/2012)
 *
 * @author jcastro-inf ( https://github.com/jcastro-inf )
 */
public class DoubleParameterXML {

    /**
     * Nombre de la caracterstica en que se guarda el valor mnimo del
     * parmetro
     */
    public static String MIN_VALUE_ATTRIBUTE = "minValue";
    /**
     * Nombre de la caracterstica en que se guarda el valor mximo del
     * parmetro
     */
    public static String MAX_VALUE_ATTRIBUTE = "maxValue";
    /**
     * Nombre de la caracterstica en que se almacena el valor del parmetro
     */
    public static String VALUE_ATTRIBUTE = "parameterValue";

    /**
     * Genera el elemento XML que describe el parmetro y el valor que tiene.
     *
     * @param parameterOwner Parameter owner al que pertenece al parmetro. Se
     * debe consultar a este objeto para conocer el valor actual del mismo
     * @param p Parmetro a almacenar
     * @return
     */
    public static Element getDoubleParameterElement(ParameterOwner parameterOwner, Parameter p) {
        Element doubleParameter = new Element(ParameterXML.PARAMETER_ELEMENT_NAME);
        doubleParameter.setAttribute(ParameterXML.PARAMETER_NAME, p.getName());

        DoubleParameter fp = (DoubleParameter) p.getRestriction();
        doubleParameter.setAttribute(ParameterXML.PARAMETER_TYPE, fp.getName());
        if (Global.isVerboseAnnoying()) {
            doubleParameter.setAttribute(MIN_VALUE_ATTRIBUTE, Double.toString(fp.getMin()));
            doubleParameter.setAttribute(MAX_VALUE_ATTRIBUTE, Double.toString(fp.getMax()));
        }

        doubleParameter.setAttribute(VALUE_ATTRIBUTE, parameterOwner.getParameterValue(p).toString());

        return doubleParameter;
    }

    /**
     * Asigna el valor del parmetro especificado en el objeto XML al
     * {@link ParameterOwner} especificado
     *
     * @param parameterOwner Objeto al que asignar el parmetro
     * @param parameterElement Elemento que describe el parmetro y su valor
     * @return Valor del parmetro. Si ha habido algun error, devuelve null
     */
    public static Object getParameterValue(ParameterOwner parameterOwner, Element parameterElement) {
        String parameterName = parameterElement.getAttributeValue(ParameterXML.PARAMETER_NAME);

        Parameter parameter = parameterOwner.getParameterByName(parameterName);
        if (parameter == null) {
            Global.showWarning(parameterOwner.getName() + " doesn't have the parameter '" + parameterName + "'\n");
        }

        Object value;
        value = parameterElement.getAttribute(VALUE_ATTRIBUTE).getValue();
        parameterOwner.setParameterValue(parameter, value);
        return value;
    }
}