delfos.rs.output.RecommendationsOutputFileXML.java Source code

Introduction

Here is the source code for delfos.rs.output.RecommendationsOutputFileXML.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.rs.output;

import delfos.Constants;
import delfos.ERROR_CODES;
import delfos.common.FileUtilities;
import delfos.common.Global;
import delfos.common.parameters.Parameter;
import delfos.common.parameters.restriction.StringParameter;
import delfos.io.xml.recommendations.RecommendationsToXML;
import delfos.rs.recommendation.Recommendations;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import org.jdom2.Document;
import org.jdom2.Element;
import org.jdom2.JDOMException;
import org.jdom2.input.SAXBuilder;
import org.jdom2.output.XMLOutputter;

/**
 * Escribe las recomendaciones a un fichero XML. El parmetro
 * {@link XMLFile#FILE_NAME} indica el principio del nombre del fichero, por lo
 * que si su valor es 'userUserRecommendation', el nombre del fichero de
 * recomendaciones para el usuario 54 es 'userUserRecommendation.user_54.xml'.
 *
 * @author jcastro-inf ( https://github.com/jcastro-inf )
 *
 * @version 28-oct-2013
 */
public class RecommendationsOutputFileXML extends RecommendationsOutputMethod {

    private static final long serialVersionUID = 1L;
    public static final Parameter FILE_NAME = new Parameter("FILE_NAME", new StringParameter("recommendations"));

    /**
     * Constructor por defecto, que aade los parmetros de este mtodo de
     * salida de recomendaciones.
     */
    public RecommendationsOutputFileXML() {
        super();
        addParameter(FILE_NAME);
    }

    /**
     * Constructor que establece el nombre del archivo de salida.
     *
     * @param filePartialName
     */
    public RecommendationsOutputFileXML(String filePartialName) {
        this();
        setParameterValue(FILE_NAME, filePartialName);
    }

    /**
     * Constructor que establece el nombre del archivo de salida.
     *
     * @param filePartialName
     * @param numberOfRecommendations
     */
    public RecommendationsOutputFileXML(String filePartialName, int numberOfRecommendations) {
        this();
        setParameterValue(FILE_NAME, filePartialName);
        setParameterValue(NUMBER_OF_RECOMMENDATIONS, numberOfRecommendations);
    }

    @Override
    public void writeRecommendations(Recommendations recommendationsToUser) {

        Element recommendationsElement = RecommendationsToXML.getRecommendationsElement(recommendationsToUser);

        String idTarget = recommendationsToUser.getTargetIdentifier();

        Document doc = new Document(recommendationsElement);
        XMLOutputter outputter = new XMLOutputter(Constants.getXMLFormat());

        File file = getCompleteFile(idTarget);

        FileUtilities.createDirectoriesForFile(file);

        try (FileWriter fileWriter = new FileWriter(file)) {
            outputter.output(doc, fileWriter);
        } catch (IOException ex) {
            ERROR_CODES.CANNOT_WRITE_RECOMMENDATIONS.exit(ex);
        }
    }

    public Recommendations readRecommendations(String idTarget) throws JDOMException {

        SAXBuilder builder = new SAXBuilder();
        Document doc = null;

        try {
            doc = builder.build(getCompleteFile(idTarget));
        } catch (IOException ex) {
            Global.showError(ex);
            ERROR_CODES.CANNOT_LOAD_CONFIG_FILE.exit(ex);
            throw new IllegalStateException(ex);
        }

        Element recommendationsElement = doc.getRootElement();
        Recommendations recommendations = RecommendationsToXML.getRecommendations(recommendationsElement);
        return recommendations;
    }

    /**
     * Devuelve la parte inicial del nombre del fichero en que se escriben las
     * recomendaciones.
     *
     * @return Parte inicial del nombre del fichero en que se escriben las
     * recomendaciones.
     */
    public String getFileName() {
        return (String) getParameterValue(FILE_NAME);
    }

    /**
     * Nombre completo del fichero en que se escriben las recomendaciones.
     *
     * @param idTarget para el que se almacenan sus recomendaciones.
     * @return
     */
    public File getCompleteFile(String idTarget) {
        String fileName = getFileName() + "_target_" + idTarget + ".xml";
        return new File(fileName);
    }
}