delfos.Constants.java Source code

Introduction

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

import delfos.common.Global;
import delfos.configuration.ConfigurationManager;
import delfos.view.InitialFrame;
import delfos.view.SwingGUI;
import delfos.view.recommendation.RecommendationWindow;
import java.io.File;
import java.nio.file.FileAlreadyExistsException;
import java.util.Locale;
import org.jdom2.output.Format;

/**
 * Proporciona los mtodos para lanzar distintas interfaces, segn el uso que se quiera dar a la biblioteca de
 * recomendacin
 *
 * 15/11/2012 Aadida la funcionalidad para controlar si se muestran los resultados en bruto de las medidas basadas en
 * curvas
 *
 * @author jcastro-inf ( https://github.com/jcastro-inf )
 *
 * @version 1.1 15/11/2012
 */
public class Constants {

    private static File tempDirectory = new File("." + File.separator + "temp");
    public static int COMPARE_NUM_DECIMALS = 4;

    public static void getLibraryGeneralParameters(ConsoleParameters consoleParameters) {
        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
    }

    public static class EnvironmentVariables {

        public static final String HOME = "HOME";
    }

    /**
     * Parameter to specify the location of the directory that contains the configurations xml files.
     */
    public static final String LIBRARY_CONFIGURATION_DIRECTORY = "-config";
    /**
     * Flag para indicar que se escriban los datos en bruto en el fichero de resultados de las ejecuciones.
     */
    public static final String RAW_DATA = "--raw-data";

    /**
     * Flag para indicar que se escriban los XML detallados de las ejecuciones.
     */
    public static final String PRINT_FULL_XML = "--full-results";

    /**
     * States the temporal directory used by the library.
     */
    public static final String TEMP_DIRECTORY = "-temp-directory";

    private static boolean printFullXML;
    /**
     * Nombre de esta biblioteca.
     */
    public static final String LIBRARY_NAME = "delfos";

    /**
     * Lanza la interfaz de recomendacin, que permite ver qu recomendaciones da un algoritmo a un usuario de un
     * dataset.
     */
    public static void initRecommendationGUI() {
        RecommendationWindow frame = new RecommendationWindow();
        frame.setVisible(true);
    }

    /**
     * Lanza la interfaz de evaluacin, que permite realizar experimentaciones sobre un algoritmo de recomendacin con
     * un dataset.
     */
    public static void initEvaluationGUI() {
        InitialFrame frame = new InitialFrame();
        frame.setVisible(true);
    }

    /**
     * Caracterstica que almacena si se debe escribir en la salida el resultado en bruto de las medidas que generan
     * curvas (como PRSpace y AUROC). Este resultado en bruto representa los puntos de la curva.
     */
    private static boolean rawResult = false;

    /**
     * Devuelve true si se deben escribir resultados en bruto en los XML de resultados
     *
     * @return true si se deben escribir resultados en bruto en los XML de resultados. false si no se deben incluir
     */
    public static boolean isRawResultDefined() {
        return rawResult;
    }

    /**
     * Establece si se deben escribir en la salida XML los resultados en bruto de las medidas de precisin y recall y
     * auroc
     *
     * @param rawResult true para escribir los resultados, false para omitirlos
     *
     */
    public static void setRawResult(boolean rawResult) {
        Constants.rawResult = rawResult;
    }

    /**
     * Returns the current time in milliseconds. Note that while the unit of time of the return value is a millisecond,
     * the granularity of the value depends on the underlying operating system and may be larger. For example, many
     * operating systems measure time in units of tens of milliseconds. See the description of the class Date for a
     * discussion of slight discrepancies that may arise between "computer time" and coordinated universal time (UTC).
     *
     * @return The difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
     */
    public static long getCurrentTimeMillis() {
        return System.currentTimeMillis();
    }

    /**
     * Inicializa los parmetros bsicos de la interaccin con la biblioteca, comprobando los argumentos de la linea de
     * comandos.
     *
     * <p>
     * <p>
     * Actualmente comprueba si existen los flags para mostrar mensajes u ocultar warnings o errores.
     *
     * @param consoleParameters
     */
    public static void initLibraryGeneralParameters(ConsoleParameters consoleParameters) {

        Locale.setDefault(Locale.ENGLISH);

        if (consoleParameters.isParameterDefined(LIBRARY_CONFIGURATION_DIRECTORY)) {
            String configDirectory = consoleParameters.getValue(LIBRARY_CONFIGURATION_DIRECTORY);
            ConfigurationManager.setConfigurationDirectory(new File(configDirectory + File.separator));
        }
        ConfigurationManager.createConfigurationDirectoryPathIfNotExists();

        Global.MessageLevel printMessageLevel = Global.MessageLevel.getPrintMessageLevel(consoleParameters);
        Global.setMessageLevel(printMessageLevel);

        if (consoleParameters.isParameterDefined(TEMP_DIRECTORY)) {
            String tempDirectoryStr = consoleParameters.getValue(TEMP_DIRECTORY);
            tempDirectory = new File(tempDirectoryStr);
            if (!tempDirectory.exists()) {
                tempDirectory.mkdirs();
            } else if (!tempDirectory.isDirectory()) {
                FileAlreadyExistsException faee = new FileAlreadyExistsException(
                        "The temp directory '" + tempDirectory.getAbsolutePath() + "' exists and is a file");
                ERROR_CODES.UNDEFINED_ERROR.exit(faee);
            }
        }

        if (consoleParameters.isFlagDefined(RAW_DATA)) {
            Constants.setRawResult(true);
        }

        if (consoleParameters.isFlagDefined(PRINT_FULL_XML)) {
            Constants.setPrintFullXML(true);
        }
    }

    /**
     * Devuelve el formato que se usa para guardar los archivos XML.
     *
     * @return
     */
    public static Format getXMLFormat() {
        return Format.getPrettyFormat().setEncoding("ISO-8859-1");
    }

    public static void initBuildGUI() {
        SwingGUI.initRSBuilderGUI("rs-config.xml");
    }

    /**
     * Establece si se debe terminar la ejecucin del programa al ms mnimo error que se detecte o se debe continuar y
     * lanzar excepcin.
     *
     * @param b
     */
    public static void setExitOnFail(boolean b) {
        ERROR_CODES.setExitOnFail(b);
    }

    /**
     * Realiza la configuracin para que la biblioteca funcione en modo depuracin. Se debe activar antes de los test
     * Junit.
     */
    public static void setJUnitTestMode() {
        setExitOnFail(false);
        Global.setMessageLevel(Global.MessageLevel.INFO);
        Global.setDefaultAnswerYes(true);
    }

    private static void setPrintFullXML(boolean printFullXML) {
        Constants.printFullXML = printFullXML;
    }

    public static boolean isPrintFullXML() {
        return printFullXML;
    }

    public static File getTempDirectory() {
        return tempDirectory;
    }

}