GeneralColumnsChooser.java

/*
Copyright 2008-2010 Gephi
Authors : Eduardo Ramos <eduramiba@gmail.com>
Website : http://www.gephi.org

This file is part of Gephi.

Gephi 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.

Gephi 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 Gephi.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.gephi.datalab.plugin.manipulators;

import org.gephi.data.attributes.api.AttributeColumn;
import org.gephi.datalab.plugin.manipulators.nodes.ClearNodesData;

/**
 * Interface in common for choosing columns to manipulate.
 * Used to be able to get/set the columns to clear in the GeneralChooseColumnsUI.
 * @author Eduardo Ramos <eduramiba@gmail.com>
 * @see ClearNodesData
 */
public interface GeneralColumnsChooser{

    /**
     * Provide columns to show in the UI to be selected or not.
     * Normally provide all table columns that can be manipulated.
     * @return Columns to show in the GeneralClearRowDataUI
     */
    AttributeColumn[] getColumns();

    /**
     * The GeneralClearRowDataUI will use this method to set the columns to finally manipulate, after the GeneralChooseColumnsUI is closed.
     * @param columnsToClearData Columns to clear
     */
    void setColumns(AttributeColumn[] columnsToClearData);

    /**
     * Provide title for the GeneralColumnsChooserUI.
     * @return Title name
     */
    String getName();
}