FRParameters.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2019 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.programs.fitnessevaluator;
 
import java.io.File;
import java.lang.reflect.Field;
import java.util.logging.Level;
 
import denoptim.exception.DENOPTIMException;
import denoptim.files.FileFormat;
import denoptim.files.FileUtils;
import denoptim.logging.StaticLogger;
import denoptim.programs.RunTimeParameters;
 
 
public class FRParameters extends RunTimeParameters
{
    private File inpFile = null;
    
    private File outFile = new File("output.sdf");
    
    protected boolean addTemplatesToLibraries = false;
    
    private int walltime = 5;
    
//-----------------------------------------------------------------------------
    
    public FRParameters()
    {
        super(ParametersType.FR_PARAMS);
    }
   
//-----------------------------------------------------------------------------
 
    public File getInputFile()
    {
        return inpFile;
    }
    
//-----------------------------------------------------------------------------
 
    public File getOutputFile()
    {
        return outFile;
    }
    
//-----------------------------------------------------------------------------
 
    public void interpretKeyword(String key, String value)
            throws DENOPTIMException
    {
        String msg = "";
        switch (key.toUpperCase())
        {
        case "WORKDIR=":
            workDir = value;
            break;
        case "INPUT=":
            inpFile = new File(value);
            break;
        case "OUTPUT=":
            outFile = new File(value);
            break;
        case "WALLTIME=":
            walltime = Integer.parseInt(value);
            break;
        case "EXTRACTTEMPLATES":
            addTemplatesToLibraries = true;
            break;
        case "VERBOSITY=":
            try
            {
                verbosity = Integer.parseInt(value);
            }
            catch (Throwable t)
            {
                msg = "Unable to understand value " + key + "'" + value + "'";
                throw new DENOPTIMException(msg);
            }
            break;
        default:
             msg = "Keyword " + key + " is not a known " 
                     + "related keyword for FitnessRunner. Check input files.";
            throw new DENOPTIMException(msg);
        }
    }
 
//-----------------------------------------------------------------------------
 
    public void checkParameters() throws DENOPTIMException
    {
        String msg = "";
        if (!workDir.equals(".") && !FileUtils.checkExists(workDir))
        {
           msg = "Directory '" + workDir + "' not found. Please specify an "
             + "existing directory.";
           throw new DENOPTIMException(msg);
        }
 
        if (inpFile != null && !inpFile.exists())
        {
            msg = "File with input data not found. Check " + inpFile;
                throw new DENOPTIMException(msg);
        }
        
        if (outFile != null && outFile.exists())
        {
            msg = "File meant for output ("
                    + outFile.getAbsolutePath()
                    + ")already exists and we do not overwrite.";
            throw new DENOPTIMException(msg);
        }
        checkOtherParameters();
    }
 
//----------------------------------------------------------------------------
 
    public void processParameters() throws DENOPTIMException
    {
        FileUtils.addToRecentFiles(outFile, FileFormat.GRAPHSDF);
        processOtherParameters();
        
        StaticLogger.appLogger.log(Level.INFO, "Output files associated with "
                + "the current run are located in " + workDir);
    }
    
//------------------------------------------------------------------------------
 
    public String getPrintedList()
    {
        StringBuilder sb = new StringBuilder(1024);
        sb.append(" " + paramTypeName() + " ").append(NL);
        for (Field f : this.getClass().getDeclaredFields()) 
        {
            try
            {
                sb.append(f.getName()).append(" = ").append(
                            f.get(this)).append(NL);
            }
            catch (Throwable t)
            {
                sb.append("ERROR! Unable to print " + paramTypeName() 
                        + " parameters. Cause: " + t);
                break;
            }
        }
        for (RunTimeParameters otherCollector : otherParameters.values())
        {
            sb.append(otherCollector.getPrintedList());
        }
        return sb.toString();
    }
 
//----------------------------------------------------------------------------
 
    public long getWallTime()
    {
        return walltime;
    }
 
//----------------------------------------------------------------------------
 
}