/*
 * ------------------------------------------------------------------------
 *
 *  Copyright (C) 2003 - 2013
 *  University of Konstanz, Germany and
 *  KNIME GmbH, Konstanz, Germany
 *  Website: http://www.knime.org; Email: contact@knime.org
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  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>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME GMBH herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * --------------------------------------------------------------------- *
 *
 */
package org.knime.knip.base.nodes.features.providers;

import java.util.List;

import org.knime.core.data.DataCell;
import org.knime.core.data.DataColumnSpec;
import org.knime.core.node.defaultnodesettings.DialogComponent;
import org.knime.core.node.defaultnodesettings.SettingsModel;

/**
 * Calculates features on a specific object and associates the feature calculation with some {@link DialogComponent}s
 * (and their {@link SettingsModel}s) allowing the configuration of the actual feature calculation.
 *
 *
 * @param <T> the target object for the feature calculation
 * @author <a href="mailto:dietzc85@googlemail.com">Christian Dietz</a>
 * @author <a href="mailto:horn_martin@gmx.de">Martin Horn</a>
 * @author <a href="mailto:michael.zinsmaier@googlemail.com">Michael Zinsmaier</a>
 */
public interface FeatureSetProvider<T> {

    /**
     * Performs the actual calculation of the features based the the given T. The cells itself and their order has to be
     * conform with the column specs (@see {@link FeatureSetProvider#initAndAddColumnSpecs(List)}.
     *
     * @param obj
     * @param name TODO
     * @param axes TODO
     * @param resCells
     */
    void calcAndAddFeatures(T obj, List<DataCell> resCells);

    /**
     * @return the name of the feature set
     */
    String getFeatureSetName();

    /**
     * @return a unique id of the feature set
     */
    String getFeatureSetId();

    /**
     * Creates and adds the column specifications to the result list.
     *
     * @param columns
     */
    void initAndAddColumnSpecs(List<DataColumnSpec> columns);

    /**
     * Initialises the dialog components needed for the feature calculation and adds them to dialog component
     * collection. Please note that the settings model objects used here must be different to the settings model objects
     * used in this{@link #initAndAddSettingsModels(List)}!
     *
     * @param dialogComponents
     */
    void initAndAddDialogComponents(List<DialogComponent> dialogComponents);

    /**
     * Initialises the settings models needed for the feature calculation and adds them to the list.
     *
     * @param settingsModels
     */
    void initAndAddSettingsModels(List<SettingsModel> settingsModels);

    /**
     *
     */
    void cleanUp();

}