weka.gui.knowledgeflow.steps.ClassifierPerformanceEvaluatorStepEditorDialog Maven / Gradle / Ivy

/*
 *   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 .
 */

/*
 *    ClassifierPerformanceEvaluatorStepEditorDialog.java
 *    Copyright (C) 2015 University of Waikato, Hamilton, New Zealand
 *
 */

package weka.gui.knowledgeflow.steps;

import weka.classifiers.CostMatrix;
import weka.gui.CostMatrixEditor;
import weka.gui.EvaluationMetricSelectionDialog;
import weka.gui.PropertyDialog;
import weka.gui.knowledgeflow.GOEStepEditorDialog;
import weka.knowledgeflow.steps.ClassifierPerformanceEvaluator;
import weka.knowledgeflow.steps.Step;

import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JPanel;
import java.awt.BorderLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.List;

/**
 * GUI step editor dialog for the ClassifierPerformanceEvaluator step
 *
 * @author Mark Hall (mhall{[at]}pentaho{[dot]}com)
 * @version $Revision: $
 */
public class ClassifierPerformanceEvaluatorStepEditorDialog extends
  GOEStepEditorDialog {

  private static final long serialVersionUID = -4459460141076392499L;

  /** Button for popping up the evaluation metrics selector dialog */
  protected JButton m_showEvalDialog = new JButton("Evaluation metrics...");

  /** Checkbox for selecting cost-sensitive evaluation */
  protected JCheckBox m_useCosts = new JCheckBox("Cost-sensitive evaluation");

  /** Button for popping up cost editor */
  protected JButton m_setCostMatrix = new JButton("Set...");

  /** The cost matrix editor for evaluation costs. */
  protected CostMatrixEditor m_CostMatrixEditor = new CostMatrixEditor();

  /** The frame used to show the cost matrix editing panel. */
  protected PropertyDialog m_SetCostsFrame;

  /** Holds selected evaluation metrics */
  protected List m_evaluationMetrics = new ArrayList();

  /**
   * Constructor
   */
  public ClassifierPerformanceEvaluatorStepEditorDialog() {
    super();
  }

  /**
   * Set the step to edit
   *
   * @param step the step to edit
   */
  @Override
  public void setStepToEdit(Step step) {
    copyOriginal(step);

    m_CostMatrixEditor.setValue(new CostMatrix(1));
    if (((ClassifierPerformanceEvaluator) getStepToEdit())
      .getEvaluateWithRespectToCosts()) {
      String costString =
        ((ClassifierPerformanceEvaluator) getStepToEdit())
          .getCostMatrixString();
      if (costString != null && costString.length() > 0) {
        try {
          CostMatrix cm = CostMatrix.parseMatlab(costString);
          m_CostMatrixEditor.setValue(cm);
        } catch (Exception e) {
          showErrorDialog(e);
        }
      }
    }

    addPrimaryEditorPanel(BorderLayout.NORTH);
    JPanel p = new JPanel(new BorderLayout());
    p.add(m_showEvalDialog, BorderLayout.NORTH);
    m_primaryEditorHolder.add(p, BorderLayout.CENTER);
    add(m_editorHolder, BorderLayout.NORTH);
    JPanel costP = new JPanel();
    costP.add(m_useCosts);
    costP.add(m_setCostMatrix);
    m_useCosts.setSelected(((ClassifierPerformanceEvaluator) getStepToEdit())
      .getEvaluateWithRespectToCosts());
    m_setCostMatrix
      .setEnabled(((ClassifierPerformanceEvaluator) getStepToEdit())
        .getEvaluateWithRespectToCosts());
    p.add(costP, BorderLayout.SOUTH);

    String evalM =
      ((ClassifierPerformanceEvaluator) step).getEvaluationMetricsToOutput();
    if (evalM != null && evalM.length() > 0) {
      String[] parts = evalM.split(",");
      for (String s : parts) {
        m_evaluationMetrics.add(s.trim());
      }
    }

    m_showEvalDialog.addActionListener(new ActionListener() {
      @Override
      public void actionPerformed(ActionEvent e) {
        EvaluationMetricSelectionDialog esd =
          new EvaluationMetricSelectionDialog(m_parent, m_evaluationMetrics);
        esd.setLocation(m_showEvalDialog.getLocationOnScreen());
        esd.pack();
        esd.setVisible(true);
        m_evaluationMetrics = esd.getSelectedEvalMetrics();
      }
    });

    m_useCosts.addActionListener(new ActionListener() {
      @Override
      public void actionPerformed(ActionEvent e) {
        m_setCostMatrix.setEnabled(m_useCosts.isSelected());
        if (m_SetCostsFrame != null && !m_useCosts.isSelected()) {
          m_SetCostsFrame.setVisible(false);
        }
      }
    });

    m_setCostMatrix.addActionListener(new ActionListener() {
      @Override
      public void actionPerformed(ActionEvent e) {
        m_setCostMatrix.setEnabled(false);
        if (m_SetCostsFrame == null) {
          if (PropertyDialog
            .getParentDialog(ClassifierPerformanceEvaluatorStepEditorDialog.this) != null) {
            m_SetCostsFrame =
              new PropertyDialog(
                PropertyDialog
                  .getParentDialog(ClassifierPerformanceEvaluatorStepEditorDialog.this),
                m_CostMatrixEditor, -1, -1);
          } else {
            m_SetCostsFrame =
              new PropertyDialog(
                PropertyDialog
                  .getParentFrame(ClassifierPerformanceEvaluatorStepEditorDialog.this),
                m_CostMatrixEditor, -1, -1);
          }
          m_SetCostsFrame.setTitle("Cost Matrix Editor");
          // pd.setSize(250,150);
          m_SetCostsFrame.addWindowListener(new java.awt.event.WindowAdapter() {
            @Override
            public void windowClosing(java.awt.event.WindowEvent p) {
              m_setCostMatrix.setEnabled(m_useCosts.isSelected());
              if ((m_SetCostsFrame != null) && !m_useCosts.isSelected()) {
                m_SetCostsFrame.setVisible(false);
              }
            }
          });
        }
        m_SetCostsFrame.setVisible(true);
      }
    });
  }

  /**
   * Called when the OK button is pressed
   */
  @Override
  protected void okPressed() {
    StringBuilder b = new StringBuilder();
    for (String s : m_evaluationMetrics) {
      b.append(s).append(",");
    }
    String newList = b.substring(0, b.length() - 1);
    ((ClassifierPerformanceEvaluator) getStepToEdit())
      .setEvaluationMetricsToOutput(newList);

    ((ClassifierPerformanceEvaluator) getStepToEdit())
      .setEvaluateWithRespectToCosts(m_useCosts.isSelected());
    if (m_useCosts.isSelected()) {
      CostMatrix m = (CostMatrix) m_CostMatrixEditor.getValue();
      ((ClassifierPerformanceEvaluator) getStepToEdit()).setCostMatrixString(m
        .toMatlab());
    }
  }
}