org.knime.base.node.meta.looper.columnlist
Class ColumnListLoopStartSettings

java.lang.Object
  org.knime.base.node.meta.looper.columnlist.ColumnListLoopStartSettings

public class ColumnListLoopStartSettings
extends Object

This class holds the settings for the column list loop start node.

Author:

Thorsten Meinl, University of Konstanz

Constructor Summary

ColumnListLoopStartSettings()

Method Summary

Collection<String>	alwaysIncludeColumns() Returns a collection with the columns that should always be included in all iterations.
void	alwaysIncludeColumns(Collection<String> colNames) Sets the collection of columns that should always be included in all iterations.
boolean	iterateAllColumns() Returns if always all columns should be iterated over.
void	iterateAllColumns(boolean b) Sets if always all columns should be iterated over.
void	iterateOverColumn(Collection<String> colNames) Sets the collection with the columns over which the loop should iterate.
List<String>	iterateOverColumns() Returns a list with the columns over which the loop should iterate.
void	loadSettings(NodeSettingsRO settings) Loads the settings from the node settings object.
void	loadSettingsForDialog(NodeSettingsRO settings) Loads the settings from the node settings object, using default values if a setting is missing.
void	saveSettings(NodeSettingsWO settings) Saves the settings to the node settings object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColumnListLoopStartSettings

public ColumnListLoopStartSettings()

Method Detail

iterateAllColumns

public boolean iterateAllColumns()

Returns if always all columns should be iterated over.

Returns:

true if all columns should be iterated over (ignoring iterateOverColumns()), false if the iterated columns should be set explicitly

Since:

2.4

iterateAllColumns

public void iterateAllColumns(boolean b)

Sets if always all columns should be iterated over.

Parameters:

b - true if all columns should be iterated over (ignoring iterateOverColumns()), false if the iterated columns should be set explicitly

Since:

2.4

alwaysIncludeColumns

public Collection<String> alwaysIncludeColumns()

Returns a collection with the columns that should always be included in all iterations.

Returns:

a collection with column names

alwaysIncludeColumns

public void alwaysIncludeColumns(Collection<String> colNames)

Sets the collection of columns that should always be included in all iterations.

Parameters:

colNames - a collection with column names

iterateOverColumns

public List<String> iterateOverColumns()

Returns a list with the columns over which the loop should iterate.

Returns:

a list with column names

iterateOverColumn

public void iterateOverColumn(Collection<String> colNames)

Sets the collection with the columns over which the loop should iterate.

Parameters:

colNames - a list with column names

saveSettings

public void saveSettings(NodeSettingsWO settings)

Saves the settings to the node settings object.

Parameters:

settings - a node settings object

loadSettings

public void loadSettings(NodeSettingsRO settings)
                  throws InvalidSettingsException

Loads the settings from the node settings object.

Parameters:

settings - a node settings object

Throws:

InvalidSettingsException - if a setting is missing

loadSettingsForDialog

public void loadSettingsForDialog(NodeSettingsRO settings)

Loads the settings from the node settings object, using default values if a setting is missing.

Parameters:

settings - a node settings object