ProgramTask.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2019 Vishwesh Venkatraman <vishwesh.venkatraman@ntnu.no> and
 *   Marco Foscato <marco.foscato@uib.no>
 * 
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 *   You should have received a copy of the GNU Affero General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package denoptim.task;
 
import java.io.File;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;
 
import denoptim.exception.DENOPTIMException;
import denoptim.files.FileFormat;
import denoptim.files.FileUtils;
import denoptim.io.DenoptimIO;
import denoptim.logging.StaticLogger;
import denoptim.utils.TaskUtils;
 
public abstract class ProgramTask extends Task
{
    protected File configFilePathName;
    
    protected String loggerIdentifier = "none";
    
//------------------------------------------------------------------------------
    
    public ProgramTask(File configFile, File workDir)
    {
        super(TaskUtils.getUniqueTaskIndex());
        this.configFilePathName = configFile;
        this.workDir = workDir;
        loggerIdentifier = this.getClass().getSimpleName() + "-" + id;
    }
    
//------------------------------------------------------------------------------
 
    @Override
    public Object call()
    {   
        StaticLogger.appLogger.log(Level.INFO, "Starting " + loggerIdentifier 
                + " (input="
                + configFilePathName + ", workSpace=" + workDir + ")");
        try
        {
            runProgram();
            StaticLogger.appLogger.log(Level.INFO, "Completed " 
                    + loggerIdentifier);
        } catch (Throwable t)
        {
            thrownExc = t;
            handleThrowable();
        }
        
        if (notifyGlobalTaskManager)
        {
            StaticTaskManager.subtractDoneTask();
        }
        
        return null;
    }
    
//------------------------------------------------------------------------------
    
    protected void handleThrowable()
    {
        printErrorToFile();
        stopLogger();
    }
    
//------------------------------------------------------------------------------
    
    protected void stopLogger()
    {
        // The logger is garbage-collected once we leave this thread, but we 
        // must stop the file handler gracefully.
        Logger logger = Logger.getLogger(loggerIdentifier);
        for (Handler h : logger.getHandlers())
            h.close();
    }
    
//------------------------------------------------------------------------------
    
    public void printErrorToFile()
    {
        StringWriter sw = new StringWriter();
        PrintWriter pw = new PrintWriter(sw);
        thrownExc.printStackTrace(pw);
        String errFile = workDir + SEP + "ERROR";
        
        try {
            DenoptimIO.writeData(errFile, sw.toString(), false);
            StaticLogger.appLogger.log(Level.SEVERE, 
                    "ERROR occurred in " + loggerIdentifier + ". "
                    + "Details in "+errFile);
        } catch (DENOPTIMException e) {
            StaticLogger.appLogger.log(Level.SEVERE, 
                    "ERROR occurred in " + loggerIdentifier + ". Details are "
                            + "reported here since we could not write to file '"
                            + errFile + "'. ");
            thrownExc.printStackTrace();
        }
        FileUtils.addToRecentFiles(errFile, FileFormat.TXT);
    }
    
//------------------------------------------------------------------------------ 
 
    protected abstract void runProgram() throws Throwable;
    
//------------------------------------------------------------------------------
 
}