ParametersForm.java

Go to the documentation of this file.

/*
 *   DENOPTIM
 *   Copyright (C) 2020 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.gui;
 
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.Color;
import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
 
import javax.swing.BoxLayout;
import javax.swing.JEditorPane;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JRadioButton;
import javax.swing.JScrollPane;
import javax.swing.JSeparator;
import javax.swing.JSpinner;
import javax.swing.JTable;
import javax.swing.JTextArea;
import javax.swing.JTextField;
import javax.swing.SwingConstants;
import javax.swing.UIManager;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.event.TableModelEvent;
import javax.swing.event.TableModelListener;
 
import denoptim.constants.DENOPTIMConstants;
import denoptim.files.FileUtils;
 
 
public class ParametersForm extends JPanel implements IParametersForm
{
        
     private static final long serialVersionUID = 3787855399355076733L;
        
    final Dimension fileLabelSize = new Dimension(250,28);
        
    final int preferredHeight = 
            (int) (new JTextField()).getPreferredSize().getHeight();
        
    final Dimension fileFieldSize = new Dimension(350,preferredHeight);
 
    final Dimension strFieldSize = new Dimension(75,preferredHeight);
        
    private final String NL = System.getProperty("line.separator");
    
    protected boolean unsavedChanges = false;
    
    protected FieldListener fieldListener;
    
    protected RdbFieldChange rdbFieldChange;
    
    protected TabFieldChange tabFieldChange;
    
    protected CmbFieldChange cmbFieldChange;
    
    protected Map<String,Boolean> checkedFlags = new HashMap<String,Boolean>();
 
    protected JTextArea txtUnformattedInput = new JTextArea(5,20);
    
    protected boolean foundCLIOnlyContent = false;
    
    private final String UNSETUNFORMATTEDINPUTTXT = 
            "Write additional text for the input file here...";
    private final Color UNSETUNFORMATTEDINPUTTXTCOLOR = Color.GRAY;
    private final Color SETUNFORMATTEDINPUTTXTCOLOR = Color.BLACK;
    
//-----------------------------------------------------------------------------
    
    public ParametersForm()
    {
        fieldListener = new FieldListener();
        rdbFieldChange = new RdbFieldChange();
        tabFieldChange = new TabFieldChange();
        cmbFieldChange = new CmbFieldChange();
    }
    
//-----------------------------------------------------------------------------
    
    protected String getStringIfNotEmpty(String key, JTextField field, 
            String prefix, String suffix)
    {
        StringBuilder sb = new StringBuilder();
        if (!field.getText().equals(""))
        {
            sb.append(key).append("=");
            sb.append(prefix).append(field.getText()).append(suffix).append(NL);
        }
        return sb.toString();
    }
    
//-----------------------------------------------------------------------------
    
    protected String getStringIfNotEmpty(String key, JEditorPane field, 
            boolean multipleLines)
    {
        StringBuilder sb = new StringBuilder();
        if (!field.getText().equals(""))
        {
            if (multipleLines)
            {
                String[] lines = field.getText().split(
                        System.getProperty("line.separator"));
                for (int i=0; i<lines.length; i++)
                {
                    sb.append(key).append("=").append(lines[i]).append(NL);
                }
            } else {
                sb.append(key).append("=").append(field.getText()).append(NL);
            }
        }
        return sb.toString();
    }
    
//-----------------------------------------------------------------------------
    
    protected String getStringIfNotEmpty(String key, JTextField field)
    {
        StringBuilder sb = new StringBuilder();
        if (!field.getText().equals(""))
        {
            sb.append(key).append("=").append(field.getText()).append(NL);
        }
        return sb.toString();
    }
    
//-----------------------------------------------------------------------------
    
    protected String getStringForKVLine(String key, JSpinner spinner)
    {
        StringBuilder sb = new StringBuilder();
        String value = spinner.getValue().toString();
        if (!value.equals(""))
        {
            sb.append(key).append("=").append(value).append(NL);
        }
        return sb.toString();
    }
    
//-----------------------------------------------------------------------------
    
    protected String getStringIfSelected(String key, JRadioButton btn)
    {
        StringBuilder sb = new StringBuilder();
        if (btn.isSelected())
        {
            //sb.append(key).append("=").append("SELECTED_by_GUI").append(NL);
            sb.append(key).append(NL);
        }
        return sb.toString();
    }
    
//-----------------------------------------------------------------------------
    
    protected String getStringFromTable(String key, JTable tab)
    {
        return getStringFromTable(key, tab, new int[]{0}, false);
    }
    
//-----------------------------------------------------------------------------
    
    protected String getStringFromTable(String key, JTable tab, 
            boolean skipHeader)
    {
        return getStringFromTable(key, tab, new int[]{0}, skipHeader);
    }
  
//-----------------------------------------------------------------------------
    
    protected String getStringFromTable(String key, JTable tab, int[] fields, 
            boolean skipHeader)
    {
        return getStringFromTable(key, tab, fields, " ", skipHeader);
    }
    
//-----------------------------------------------------------------------------
    
    protected String getStringFromTable(String key, JTable tab, int[] fields,
            String sep, boolean skipHeader)
    {
        StringBuilder sb = new StringBuilder();
        int firstRow = 0;
        if (skipHeader)
        {
            firstRow = 1;
        }
        for (int i=firstRow; i<tab.getRowCount(); i++)
        {
            String val = "";
            for (int j=0; j<fields.length; j++)
            {
                if (j==0)
                {
                    val = tab.getValueAt(i, fields[j]).toString();
                }    
                else
                {
                    val = val + sep + tab.getValueAt(i, fields[j]).toString();
                }
            }
            sb.append(key).append("=").append(val).append(NL);
        }
        return sb.toString();
    }
    
//-----------------------------------------------------------------------------
    
    public void importParametersFromDenoptimParamsFile(String fileName) 
            throws Exception
    {
        System.err.println("WARNING: runnin empty method "
                + "'importParametersFromDenoptimParamsFile'. "
                + "A subclass is not overwriting it. "
                + "Report this bug to the development team.");
    }
    
//-----------------------------------------------------------------------------
    
    protected void importParametersFromDenoptimParamsFile(String fileName, 
            String keyRoot) throws Exception
    {           
        if (keyRoot.equals("") || keyRoot == null)
        {
            throw new Exception("<html>Root of DENOPTIM keywords not defined."
                    + "<br>Bugus use of method "
                    + "'importParametersFromDenoptimParamsFile'!</html>");
        }
        String parType = keyRoot.replaceAll("-", "");
        if (fileName.equals("") || !FileUtils.checkExists(fileName))
        {
            throw new Exception("<html>Source file for the " + parType 
                    + " parameters is not found!<br>Please, specify another"
                    + " file name.");
        }
        
        preliminatyTasksUponImportingParams();
        
        String line;
        BufferedReader br = null;
        try
        {
            br = new BufferedReader(new FileReader(fileName));
            while ((line = br.readLine()) != null)
            {   
                if ((line.trim()).length() == 0)
                {
                    continue;
                }
 
                if (line.startsWith("#"))
                {
                    continue;
                }
                
                for (String flag : checkedFlags.keySet())
                {
                    if (line.toUpperCase().startsWith(flag.toUpperCase()))
                        checkedFlags.put(flag,true);
                }
                
                if (line.toUpperCase().startsWith(keyRoot.toUpperCase()))
                {               
                    importParameterFromLine(line);
                }
            }
        }
        catch (IOException ioe)
        {
            throw new Exception("Unable to read file '" + fileName + "'", ioe);
        }
        finally
        {
            try
            {
                if (br != null)
                {
                    br.close();
                    br = null;
                }
            }
            catch (IOException ioe)
            {
                throw new Exception("Unable to close file '" + fileName + "'",
                        ioe);
            }
        }
        
        //adapt visibility to imported parameters
        adaptVisibility();
    }
 
//------------------------------------------------------------------------------
 
    protected void preliminatyTasksUponImportingParams() 
    {
    }
    
//------------------------------------------------------------------------------
 
    protected void adaptVisibility() 
    {
    }
 
//-----------------------------------------------------------------------------
    
    protected void importParameterFromLine(String line) throws Exception
    {
        String key = line.trim();
        String value = "";
        if (line.contains("="))
        {
            key = line.substring(0,line.indexOf("=")).trim();
            value = line.substring(line.indexOf("=") + 1).trim();
        }
        importSingleParameter(key,value);
    }
  
//-----------------------------------------------------------------------------
    
    @Override
    public void importSingleParameter(String key, String value) 
            throws Exception 
    {
      System.err.println("WARNING: running empty method "
              + "'importSingleParameter'. "
              + "A subclass is not overwriting it. "
              + "Report this bug to the development team.");
    }
 
//-----------------------------------------------------------------------------
 
    @Override
    public void putParametersToString(StringBuilder sb) throws Exception
    {
    }
    
//-----------------------------------------------------------------------------
    
    @Override
    public boolean hasUnsavedChanges()
    {
        return unsavedChanges;
    }
    
//-----------------------------------------------------------------------------
 
    @Override
    public void setUnsavedChanges(boolean val)
    {
        unsavedChanges = val;
    }
    
//-----------------------------------------------------------------------------
    
    private class FieldListener implements DocumentListener
    {
        @Override
        public void insertUpdate(DocumentEvent e) 
        {
            unsavedChanges = true;
        }
    
        @Override
        public void removeUpdate(DocumentEvent e) 
        {
            unsavedChanges = true;
        }
    
        @Override
        public void changedUpdate(DocumentEvent e) 
        {
            unsavedChanges = true;
        }
    }
    
//-----------------------------------------------------------------------------
    
    private class RdbFieldChange implements ChangeListener
    {
        @Override
        public void stateChanged(ChangeEvent e) 
        {
            unsavedChanges = true;
        }   
    }
    
//-----------------------------------------------------------------------------
 
    private class TabFieldChange implements TableModelListener
    {   
        @Override
        public void tableChanged(TableModelEvent e) 
        {
            unsavedChanges = true;
        }
    }
    
//-----------------------------------------------------------------------------
    
    private class CmbFieldChange implements ActionListener
    {
        @Override
        public void actionPerformed(ActionEvent e) 
        {
            unsavedChanges = true;
        }
    }
    
//-----------------------------------------------------------------------------
    
    public void showUnknownKeyWarning(Component parent, String paramType)
    {
        if (foundCLIOnlyContent)
        {
            JOptionPane.showMessageDialog(parent,
                    String.format("<html><body width='%1s'>"
                            + "Found text that is either not recognized "
                            + " as " + paramType + " parameters "
                            + "or pertains settings that cannot yet be "
                            + "controlled from the GUI. "
                            + "You can edit/delete this content in the "
                            + "parameter editor located at the bottom of the "
                            + "parameter's form. <br>"
                            + "Content of the unformatted content:"
                            + "</body></html>", 400)
                    + DENOPTIMConstants.EOL
                    + txtUnformattedInput.getText(),
                    "WARNING",
                    JOptionPane.WARNING_MESSAGE,
                    UIManager.getIcon("OptionPane.errorIcon"));
        }
    }
    
//------------------------------------------------------------------------------
    
    protected void addToUnformattedTxt(String key, String value)
    {
        foundCLIOnlyContent = true;
        if (txtUnformattedInput.getText().equals(UNSETUNFORMATTEDINPUTTXT)) 
        {
            txtUnformattedInput.setText(key + "=" + value);
        } else {
            txtUnformattedInput.append(DENOPTIMConstants.EOL + key + "=" + value);
        }
        txtUnformattedInput.setForeground(SETUNFORMATTEDINPUTTXTCOLOR);
    }
 
//------------------------------------------------------------------------------
    
    protected JPanel getPanelForUnformattedInput()
    {
        JPanel blockUnformatted = new JPanel();
        blockUnformatted.setLayout(new BoxLayout(blockUnformatted, 
                SwingConstants.VERTICAL));
        blockUnformatted.add(new JSeparator());
        String toolTip = String.format(
                "<html><body width='%1s'>Here you can find/write any "
                + "further text lines that can be written/found in the "
                + "parameter's file. Such text may contain comments (i.e., "
                + "start with '#') and any keyword that is not controllable by "
                + "the GUI.</body></html>", 400);
        blockUnformatted.setToolTipText(toolTip);
        JPanel lineHeader = new JPanel(new FlowLayout(FlowLayout.LEFT));
        JLabel lbl = new JLabel(
                "Additional input file content not controlled by GUI", 
                SwingConstants.LEFT);
        lineHeader.add(lbl);
        blockUnformatted.add(lineHeader);
        txtUnformattedInput.setToolTipText(toolTip);
        txtUnformattedInput.setText(UNSETUNFORMATTEDINPUTTXT);
        txtUnformattedInput.setForeground(UNSETUNFORMATTEDINPUTTXTCOLOR);
        txtUnformattedInput.addFocusListener(new FocusListener() {
 
            @Override
            public void focusGained(FocusEvent e)
            {
                showPromptIfEmpty();
            }
 
            @Override
            public void focusLost(FocusEvent e)
            {
                showPromptIfEmpty();
            }
            
        });
        JScrollPane scroller = new JScrollPane(txtUnformattedInput); 
        blockUnformatted.add(scroller);
        
        return blockUnformatted;
    }
    
//-----------------------------------------------------------------------------
    
    protected String getTextForUnformattedSettings()
    {
        return txtUnformattedInput.getText();
    }
    
//-----------------------------------------------------------------------------
    
    private void showPromptIfEmpty()
    {
        String txt = txtUnformattedInput.getText();
        if (txt.equals(UNSETUNFORMATTEDINPUTTXT)) 
        {
            txtUnformattedInput.setText("");
            txtUnformattedInput.setForeground(SETUNFORMATTEDINPUTTXTCOLOR);
        } else if (txt.isBlank()) {
            txtUnformattedInput.setText(UNSETUNFORMATTEDINPUTTXT);
            txtUnformattedInput.setForeground(UNSETUNFORMATTEDINPUTTXTCOLOR);
        } else {
            txtUnformattedInput.setForeground(SETUNFORMATTEDINPUTTXTCOLOR);
        }
    }
    
//-----------------------------------------------------------------------------
    
    protected void clearUnformattedTxtArea()
    {
        txtUnformattedInput.setText(UNSETUNFORMATTEDINPUTTXT);
        txtUnformattedInput.setForeground(UNSETUNFORMATTEDINPUTTXTCOLOR);
    }
    
//-----------------------------------------------------------------------------
 
}