delfos.group.io.xml.evaluationmeasures.PRSpaceGroupsXML.java Source code

Introduction

Here is the source code for delfos.group.io.xml.evaluationmeasures.PRSpaceGroupsXML.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.group.io.xml.evaluationmeasures;

import org.jdom2.Element;
import delfos.io.xml.evaluationmeasures.confusionmatricescurve.ConfusionMatricesCurveXML;
import delfos.io.xml.UnrecognizedElementException;
import delfos.results.evaluationmeasures.confusionmatrix.ConfusionMatricesCurve;
import delfos.group.results.groupevaluationmeasures.GroupEvaluationMeasure;
import delfos.group.results.groupevaluationmeasures.precisionrecall.PRSpaceGroups;

/**
 *
 * @author jcastro-inf ( https://github.com/jcastro-inf )
 * @version 1.0 22-Jan-2013
 */
public class PRSpaceGroupsXML {

    /**
     * Nombre del elemento de la medida.
     */
    public final static String MEASURE_ELEMENT = PRSpaceGroups.class.getSimpleName();
    /**
     * Nombre del elemento que contienen los puntos de la curva de
     * precisin-recall.
     */
    public final static String DETAILED_RESULT_ELEMENT = "PRCurve";
    /**
     * Nombre del elemento que describe un punto de la curva precision-recall.
     */
    public final static String CURVE_POINT_ELEMENT = "Pair";
    /**
     * Atributo del punto de la curva que tiene el k, es decir, el nmero de
     * recomendaciones.
     */
    public final static String K_ATTRIBUTE = "k";
    /**
     * Atributo del punto de la curva que tiene la precisin para el nmero de
     * recomendaciones especificado en el punto.
     */
    public final static String PRECISION_ATTRIBUTE = "precision";
    /**
     * Atributo del punto de la curva que tiene el recall para el nmero de
     * recomendaciones especificado en el punto.
     */
    public final static String RECALL_ATTRIBUTE = "recall";

    public static Element getElement(ConfusionMatricesCurve curve) {
        Element measureElement = new Element(MEASURE_ELEMENT);
        measureElement.setAttribute(GroupEvaluationMeasure.VALUE, Double.toString(curve.getAreaPRSpace()));

        Element detailedResultElement = new Element(DETAILED_RESULT_ELEMENT);

        for (int i = 1; i < curve.size(); i++) {

            String precision = Double.toString(curve.getPrecisionAt(i));
            String recall = Double.toString(curve.getRecallAt(i));

            Element curvePointElement = new Element(CURVE_POINT_ELEMENT);
            curvePointElement.setAttribute(K_ATTRIBUTE, Integer.toString(i));
            curvePointElement.setAttribute(PRECISION_ATTRIBUTE, precision);
            curvePointElement.setAttribute(RECALL_ATTRIBUTE, recall);
            detailedResultElement.addContent(curvePointElement);
        }

        measureElement.addContent(detailedResultElement);

        Element confusionMatricesCurveElement = ConfusionMatricesCurveXML.getElement(curve);
        measureElement.addContent(confusionMatricesCurveElement);
        return measureElement;
    }

    public static ConfusionMatricesCurve getConfusionMatricesCurve(Element e) throws UnrecognizedElementException {
        if (!e.getName().equals(MEASURE_ELEMENT)) {
            throw new UnrecognizedElementException(
                    "Element name is '" + e.getName() + "', expected value '" + MEASURE_ELEMENT + "'");
        }
        Element curveElement = e.getChild(ConfusionMatricesCurveXML.CURVE_ELEMENT);
        if (e == null) {
            throw new UnrecognizedElementException(
                    PRSpaceGroupsXML.class.getSimpleName() + ": Curve element not found");
        }
        return ConfusionMatricesCurveXML.getConfusionMatricesCurve(curveElement);

    }
}