/*
* ------------------------------------------------------------------------
*
* 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.node;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import org.knime.core.data.DataValue;
import org.knime.core.node.defaultnodesettings.DialogComponent;
import org.knime.core.node.defaultnodesettings.DialogComponentColumnNameSelection;
import org.knime.core.node.defaultnodesettings.DialogComponentStringSelection;
import org.knime.core.node.defaultnodesettings.SettingsModelString;
import org.knime.node.v210.FullDescriptionDocument.FullDescription;
import org.knime.node.v210.OptionDocument.Option;
import org.knime.node.v210.TabDocument.Tab;
/**
* Dialog corresponding to the {@link ValueToCellsNodeModel} which already contains dialog components, but others can
* still be added (this {@link #addDialogComponent(String, String, DialogComponent)}.
*
* @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>
*
* @param <VIN1>
*/
public abstract class ValueToCellsNodeDialog<VIN1 extends DataValue> extends LazyNodeDialogPane {
/**
* Adds the description of the column selection tab to the node description.
*
* @param desc
*/
static void addTabsDescriptionTo(final FullDescription desc) {
final Tab tab = desc.addNewTab();
tab.setName("Column Selection");
Option opt = tab.addNewOption();
opt.setName("Column Creation Mode");
opt.addNewP()
.newCursor()
.setTextValue("Mode how to handle the selected column. The processed column can be added to a new table, appended to the end of the table, or the old column can be replaced by the new result");
opt = tab.addNewOption();
opt.setName("Column Selection");
opt.newCursor().setTextValue("Selection of the columns to be processed.");
}
/* The column settings model */
private SettingsModelString m_columnSettingsModel;
/**
* Default Constructor
*/
public ValueToCellsNodeDialog() {
this(false);
}
/**
* Possible lazy constructor
*
* If lazy is true addDialogComponents(); buildDialog();
*
* Must be called manually!
*
* @param lazy indicator whether lazy or not
*/
public ValueToCellsNodeDialog(final boolean lazy) {
addDCs();
if (!lazy) {
addDialogComponents();
buildDialog();
}
}
/**
* Helper add the dialog components needed for the this dialog and the ValueToCellNodeModel, respectively.
*/
@SuppressWarnings("unchecked")
protected void addDCs() {
addDialogComponent("Column Selection", "Creation Mode", new DialogComponentStringSelection(
ValueToCellsNodeModel.createColCreationModeModel(), "Column Creation Mode",
ValueToCellsNodeModel.COL_CREATION_MODES));
final Class<? extends DataValue> argTypeClasses = getTypeArgumentClasses();
m_columnSettingsModel = ValueToCellsNodeModel.createColSelectionModel();
addDialogComponent("Column Selection", "Choose", new DialogComponentColumnNameSelection(m_columnSettingsModel,
getColumnSelectionLabel(), 0, isColumnRequired(), !isColumnRequired(), argTypeClasses));
}
/**
* Add the dialog components to the dialog here. Do NOT add them in the constructor!
*/
public abstract void addDialogComponents();
/**
* @return the label of the column selection
*/
protected String getColumnSelectionLabel() {
return "Column";
}
/**
* @return SettingsModel object of dialog, used to store column settings model
*/
public SettingsModelString getColumnSettingsModel() {
return m_columnSettingsModel;
}
/*
* Retrieves the classes of the type arguments VIN1, VIN2 and COUT.
*/
@SuppressWarnings("unchecked")
private Class<? extends DataValue> getTypeArgumentClasses() {
Class<?> c = getClass();
Class<? extends DataValue> res = null;
for (int i = 0; i < 5; i++) {
if (c.getSuperclass().equals(ValueToCellsNodeDialog.class)) {
final Type[] types = ((ParameterizedType)c.getGenericSuperclass()).getActualTypeArguments();
if (types[0] instanceof ParameterizedType) {
types[0] = ((ParameterizedType)types[0]).getRawType();
}
res = (Class<VIN1>)types[0];
break;
}
c = c.getSuperclass();
}
return res;
}
/**
* Indicates whether the first column is required to be selected or not
*
* @return true if first column is required
*/
public boolean isColumnRequired() {
return true;
}
}