org.dllearner.cli.CLI.java Source code

Java tutorial

Introduction

Here is the source code for org.dllearner.cli.CLI.java

Source

/**
 * Copyright (C) 2007-2011, Jens Lehmann
 *
 * This file is part of DL-Learner.
 * 
 * DL-Learner 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.
 *
 * DL-Learner 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 org.dllearner.cli;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.apache.commons.lang.exception.ExceptionUtils;
import org.apache.log4j.Level;
import org.apache.xmlbeans.XmlObject;
import org.dllearner.algorithms.ParCEL.ParCELPosNegLP;
import org.dllearner.algorithms.qtl.QTL2;
import org.dllearner.configuration.IConfiguration;
import org.dllearner.configuration.spring.ApplicationContextBuilder;
import org.dllearner.configuration.spring.DefaultApplicationContextBuilder;
import org.dllearner.configuration.util.SpringConfigurationXMLBeanConverter;
import org.dllearner.confparser3.ConfParserConfiguration;
import org.dllearner.confparser3.ParseException;
import org.dllearner.core.AbstractCELA;
import org.dllearner.core.AbstractLearningProblem;
import org.dllearner.core.AbstractReasonerComponent;
import org.dllearner.core.ComponentInitException;
import org.dllearner.core.KnowledgeSource;
import org.dllearner.core.LearningAlgorithm;
import org.dllearner.core.ReasoningMethodUnsupportedException;
import org.dllearner.learningproblems.PosNegLP;
import org.dllearner.reasoning.SPARQLReasoner;
import org.dllearner.utilities.Files;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.core.io.FileSystemResource;
import org.springframework.core.io.Resource;

/**
 * 
 * New commandline interface.
 * 
 * @author Jens Lehmann
 *
 */
public class CLI {

    private static Logger logger = LoggerFactory.getLogger(CLI.class);

    private ApplicationContext context;
    private IConfiguration configuration;
    private File confFile;

    private LearningAlgorithm algorithm;
    private KnowledgeSource knowledgeSource;

    // some CLI options
    private boolean writeSpringConfiguration = false;
    private boolean performCrossValidation = false;
    private int nrOfFolds = 10;
    private int noOfRuns = 1;

    private String logLevel = "INFO";

    private AbstractLearningProblem lp;

    private AbstractReasonerComponent rs;

    private AbstractCELA la;

    public CLI() {

    }

    public CLI(File confFile) {
        this();
        this.confFile = confFile;
    }

    // separate init methods, because some scripts may want to just get the application
    // context from a conf file without actually running it
    public void init() throws IOException {
        if (context == null) {
            Resource confFileR = new FileSystemResource(confFile);
            List<Resource> springConfigResources = new ArrayList<Resource>();
            configuration = new ConfParserConfiguration(confFileR);

            ApplicationContextBuilder builder = new DefaultApplicationContextBuilder();
            context = builder.buildApplicationContext(configuration, springConfigResources);

            knowledgeSource = context.getBean(KnowledgeSource.class);
            rs = context.getBean(AbstractReasonerComponent.class);
            la = context.getBean(AbstractCELA.class);
            lp = context.getBean(AbstractLearningProblem.class);
        }
    }

    public void run() throws IOException {
        try {
            org.apache.log4j.Logger.getLogger("org.dllearner").setLevel(Level.toLevel(logLevel.toUpperCase()));
        } catch (Exception e) {
            logger.warn("Error setting log level to " + logLevel);
        }

        if (writeSpringConfiguration) {
            SpringConfigurationXMLBeanConverter converter = new SpringConfigurationXMLBeanConverter();
            XmlObject xml;
            if (configuration == null) {
                Resource confFileR = new FileSystemResource(confFile);
                configuration = new ConfParserConfiguration(confFileR);
                xml = converter.convert(configuration);
            } else {
                xml = converter.convert(configuration);
            }
            String springFilename = confFile.getCanonicalPath().replace(".conf", ".xml");
            File springFile = new File(springFilename);
            if (springFile.exists()) {
                logger.warn("Cannot write Spring configuration, because " + springFilename + " already exists.");
            } else {
                Files.createFile(springFile, xml.toString());
            }
        }
        rs = context.getBean(AbstractReasonerComponent.class);
        la = context.getBeansOfType(AbstractCELA.class).entrySet().iterator().next().getValue();

        if (performCrossValidation) {
            //this test is added for PDLL algorithm since it does not use the PosNegLP         
            try {
                ParCELPosNegLP lp = context.getBean(ParCELPosNegLP.class);
                new ParCELCrossValidation(la, lp, rs, nrOfFolds, false, noOfRuns);
            } catch (BeansException be) {
                PosNegLP lp = context.getBean(PosNegLP.class);
                if (la instanceof QTL2) {
                    new SPARQLCrossValidation((QTL2) la, lp, rs, nrOfFolds, false);
                } else {
                    new CrossValidation(la, lp, rs, nrOfFolds, false);
                }
            }

        } else {
            lp = context.getBean(AbstractLearningProblem.class);
            //            knowledgeSource = context.getBeansOfType(Knowledge1Source.class).entrySet().iterator().next().getValue();
            for (Entry<String, LearningAlgorithm> entry : context.getBeansOfType(LearningAlgorithm.class)
                    .entrySet()) {
                algorithm = entry.getValue();
                logger.info("Running algorithm instance \"" + entry.getKey() + "\" ("
                        + algorithm.getClass().getSimpleName() + ")");
                algorithm.start();
            }
        }
    }

    public boolean isWriteSpringConfiguration() {
        return writeSpringConfiguration;
    }

    public void setWriteSpringConfiguration(boolean writeSpringConfiguration) {
        this.writeSpringConfiguration = writeSpringConfiguration;
    }

    /**
     * @return the lp
     */
    public AbstractLearningProblem getLearningProblem() {
        return lp;
    }

    /**
     * @return the rs
     */
    public AbstractReasonerComponent getReasonerComponent() {
        return rs;
    }

    /**
     * @return the la
     */
    public AbstractCELA getLearningAlgorithm() {
        return la;
    }

    /**
     * @param args
     * @throws ParseException 
     * @throws IOException 
     * @throws ReasoningMethodUnsupportedException 
     */
    public static void main(String[] args) throws ParseException, IOException, ReasoningMethodUnsupportedException {

        //      System.out.println("DL-Learner " + Info.build + " [TODO: read pom.version and put it here (make sure that the code for getting the version also works in the release build!)] command line interface");
        System.out.println("DL-Learner command line interface");

        // currently, CLI has exactly one parameter - the conf file
        if (args.length == 0) {
            System.out.println("You need to give a conf file as argument.");
            System.exit(0);
        }

        // read file and print and print a message if it does not exist
        File file = new File(args[args.length - 1]);
        if (!file.exists()) {
            System.out.println("File \"" + file + "\" does not exist.");
            System.exit(0);
        }

        Resource confFile = new FileSystemResource(file);

        List<Resource> springConfigResources = new ArrayList<Resource>();

        try {
            //DL-Learner Configuration Object
            IConfiguration configuration = new ConfParserConfiguration(confFile);

            ApplicationContextBuilder builder = new DefaultApplicationContextBuilder();
            ApplicationContext context = builder.buildApplicationContext(configuration, springConfigResources);

            // TODO: later we could check which command line interface is specified in the conf file
            // for now we just use the default one

            CLI cli;
            if (context.containsBean("cli")) {
                cli = (CLI) context.getBean("cli");
            } else {
                cli = new CLI();
            }
            cli.setContext(context);
            cli.setConfFile(file);
            cli.run();
        } catch (Exception e) {
            e.printStackTrace();
            String stacktraceFileName = "log/error.log";

            //            e.printStackTrace();

            //Find the primary cause of the exception.
            Throwable primaryCause = findPrimaryCause(e);

            // Get the Root Error Message
            logger.error("An Error Has Occurred During Processing.");
            //            logger.error(primaryCause.getMessage());
            logger.debug("Stack Trace: ", e);
            logger.error("Terminating DL-Learner...and writing stacktrace to: " + stacktraceFileName);
            FileOutputStream fos = new FileOutputStream(stacktraceFileName);
            PrintStream ps = new PrintStream(fos);
            e.printStackTrace(ps);
        }

    }

    /**
     * Find the primary cause of the specified exception.
     *
     * @param e The exception to analyze
     * @return The primary cause of the exception.
     */
    private static Throwable findPrimaryCause(Exception e) {
        // The throwables from the stack of the exception
        Throwable[] throwables = ExceptionUtils.getThrowables(e);

        //Look For a Component Init Exception and use that as the primary cause of failure, if we find it
        int componentInitExceptionIndex = ExceptionUtils.indexOfThrowable(e, ComponentInitException.class);

        Throwable primaryCause;
        if (componentInitExceptionIndex > -1) {
            primaryCause = throwables[componentInitExceptionIndex];
        } else {
            //No Component Init Exception on the Stack Trace, so we'll use the root as the primary cause.
            primaryCause = ExceptionUtils.getRootCause(e);
        }
        return primaryCause;
    }

    public void setContext(ApplicationContext context) {
        this.context = context;
    }

    public ApplicationContext getContext() {
        return context;
    }

    public File getConfFile() {
        return confFile;
    }

    public void setConfFile(File confFile) {
        this.confFile = confFile;
    }

    public boolean isPerformCrossValidation() {
        return performCrossValidation;
    }

    public void setPerformCrossValidation(boolean performCrossValiation) {
        this.performCrossValidation = performCrossValiation;
    }

    public int getNrOfFolds() {
        return nrOfFolds;
    }

    public void setNrOfFolds(int nrOfFolds) {
        this.nrOfFolds = nrOfFolds;
    }

    public void setLogLevel(String logLevel) {
        this.logLevel = logLevel;
    }

    public String getLogLevel() {
        return logLevel;
    }

    //   public LearningAlgorithm getLearningAlgorithm() {
    //      return algorithm;
    //   }

    public KnowledgeSource getKnowledgeSource() {
        return knowledgeSource;
    }

    public int getNoOfRuns() {
        return noOfRuns;
    }

    public void setNoOfRuns(int noOfRuns) {
        this.noOfRuns = noOfRuns;
    }

}