delfos.io.xml.dataset.RelevanceCriteriaXML.java Source code

Introduction

Here is the source code for delfos.io.xml.dataset.RelevanceCriteriaXML.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.dataset;

import org.jdom2.DataConversionException;
import org.jdom2.Element;
import delfos.dataset.basic.rating.RelevanceCriteria;
import delfos.common.Global;

/**
 * Clase para realizar la entrada/salida a XML para el criterio de relevancia
 *
 * @version 1.0 (06/12/2012)
 *
 * @author jcastro-inf ( https://github.com/jcastro-inf )
 */
public class RelevanceCriteriaXML {

    /**
     * Nombre del elemento que tiene el criterio de relevancia
     */
    public static final String ELEMENT_NAME = "RelevanceCriteria";
    /**
     * Nombre de la caracterstica en que se guarda el valor de umbral del
     * criterio de relevancia
     */
    private static final String TRESHOLD_ATTRIBUTE = "threshold";

    /**
     * Genera el elemento XML que describe el criterio de relevancia
     *
     * @param relevanceCriteria Criterio de relevancia a almacenar
     * @return Elemento con la informacin necesaria para reconstruir el
     * criterio de relevancia
     */
    public static Element getElement(RelevanceCriteria relevanceCriteria) {
        Element relevanceCriteriaElement = new Element(ELEMENT_NAME);
        relevanceCriteriaElement.setAttribute(TRESHOLD_ATTRIBUTE, relevanceCriteria.getThreshold().toString());
        return relevanceCriteriaElement;
    }

    /**
     * Recupera el criterio de relevancia a partir del elemento XML que contiene
     * la informacin del mismo.
     *
     * @param relevanceCriteriaElement Elemento que describe el criterio de
     * relevancia
     *
     * @return Criterio de relevancia descrito por el elemento XML
     */
    public static RelevanceCriteria getRelevanceCriteria(Element relevanceCriteriaElement) {
        Number threshold = 4;
        try {
            threshold = relevanceCriteriaElement.getAttribute(TRESHOLD_ATTRIBUTE).getDoubleValue();
        } catch (DataConversionException ex) {
            Global.showError(ex);
        }
        return new RelevanceCriteria(threshold);
    }
}