adams.gui.visualization.instances.instancestable.AbstractPlotColumn.java Source code

Introduction

Here is the source code for adams.gui.visualization.instances.instancestable.AbstractPlotColumn.java

Source

/*
 *   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 <http://www.gnu.org/licenses/>.
 */

/**
 * AbstractPlotColumn.java
 * Copyright (C) 2016 University of Waikato, Hamilton, NZ
 */

package adams.gui.visualization.instances.instancestable;

import adams.core.option.AbstractOptionHandler;
import adams.gui.core.GUIHelper;
import adams.gui.visualization.instances.InstancesTable;
import weka.core.Instances;

/**
 * Ancestor for plugins that plot a column.
 *
 * @author FracPete (fracpete at waikato dot ac dot nz)
 * @version $Revision$
 */
public abstract class AbstractPlotColumn extends AbstractOptionHandler implements PlotColumn {

    private static final long serialVersionUID = 6555579088265005460L;

    /**
     * For sorting the menu items.
     *
     * @param o       the other item
     * @return        -1 if less than, 0 if equal, +1 if larger than this
     *                menu item name
     */
    @Override
    public int compareTo(InstancesTablePopupMenuItem o) {
        return getMenuItem().compareTo(o.getMenuItem());
    }

    /**
     * Returns the name of the icon.
     *
     * @return            the name, null if none available
     */
    public String getIconName() {
        return null;
    }

    /**
     * Hook method for checks before attempting the plot.
     *
     * @param table   the source table
     * @param data   the instances to use as basis
     * @param column   the column in the instances
     * @return      null if passed, otherwise error message
     */
    protected String check(InstancesTable table, Instances data, int column) {
        if (table == null)
            return "No source table available!";
        if (data == null)
            return "No instances available!";
        if (column < 0)
            return "Negative column index!";
        if (column >= data.numAttributes())
            return "Column index too large: " + (column + 1) + " > " + data.numAttributes();
        return null;
    }

    /**
     * Plots the specified column.
     *
     * @param table   the source table
     * @param data   the instances to use as basis
     * @param column   the column in the instances
     * @return      true if successful
     */
    protected abstract boolean doPlotColumn(InstancesTable table, Instances data, int column);

    /**
     * Plots the specified column.
     *
     * @param table   the source table
     * @param data   the instances to use as basis
     * @param column   the column in the instances
     * @return      true if successful
     */
    public boolean plotColumn(InstancesTable table, Instances data, int column) {
        boolean result;
        String error;

        error = check(table, data, column);
        result = (error == null);
        if (result)
            result = doPlotColumn(table, data, column);
        else
            GUIHelper.showErrorMessage(table, "Failed to plot column #" + (column + 1) + "\n" + error);

        return result;
    }
}