org.knime.base.node.meta.looper

Class AbstractLoopEndNodeSettings

java.lang.Object

org.knime.base.node.meta.looper.AbstractLoopEndNodeSettings

Direct Known Subclasses:

LoopEnd2NodeSettings, LoopEndNodeSettings

public class AbstractLoopEndNodeSettings
extends Object

Abstract class for Loop End node settings.

Since:

2.9

Author:

Thorsten Meinl, KNIME.com AG, Zurich, Switzerland

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	AbstractLoopEndNodeSettings.RowKeyPolicy Specifies how to generate the row keys

Constructor Summary

Constructors

Constructor and Description
AbstractLoopEndNodeSettings()

Method Summary

Modifier and Type	Method and Description
boolean	addIterationColumn() Returns if a column containing the iteration number should be appended to the output table.
void	addIterationColumn(boolean add) Sets if a column containing the iteration number should be appended to the output table.
void	loadSettings(NodeSettingsRO settings) Loads the settings from the node settings object.
AbstractLoopEndNodeSettings.RowKeyPolicy	rowKeyPolicy()
void	rowKeyPolicy(AbstractLoopEndNodeSettings.RowKeyPolicy policy)
void	saveSettings(NodeSettingsWO settings) Writes the settings into the node settings object.
boolean	uniqueRowIDs() Deprecated.
void	uniqueRowIDs(boolean b) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLoopEndNodeSettings

public AbstractLoopEndNodeSettings()

Method Detail

uniqueRowIDs

@Deprecated
public void uniqueRowIDs(boolean b)

Deprecated.

Sets if row keys are made unique by adding the iteration number.

Parameters:

b - true if the iteration number is added, false otherwise Deprecated: use rowKeyPolicy(RowKeyPolicy) instead

Since:

2.3

uniqueRowIDs

@Deprecated
public boolean uniqueRowIDs()

Deprecated.

Returns if row keys are made unique by adding the iteration number.

Returns:

true if the iteration number is added, false otherwise Deprecated: use rowKeyPolicy() instead

Since:

2.3

rowKeyPolicy

public void rowKeyPolicy(AbstractLoopEndNodeSettings.RowKeyPolicy policy)

Parameters:

the - row key policy specifying whether row keys are to be newly generated, a suffix is appended or remain unmodified

Since:

3.1

rowKeyPolicy

public AbstractLoopEndNodeSettings.RowKeyPolicy rowKeyPolicy()

Returns:

the row key policy specifying whether row keys are to be newly generated, a suffix is appended or remain unmodified

Since:

3.1

addIterationColumn

public void addIterationColumn(boolean add)

Sets if a column containing the iteration number should be appended to the output table.

Parameters:

add - true if a column should be added, false otherwise

addIterationColumn

public boolean addIterationColumn()

Returns if a column containing the iteration number should be appended to the output table.

Returns:

true if a column should be added, false otherwise

saveSettings

public void saveSettings(NodeSettingsWO settings)

Writes the settings into the node settings object.

Parameters:

settings - a node settings object

loadSettings

public void loadSettings(NodeSettingsRO settings)

Loads the settings from the node settings object.

Parameters:

settings - a node settings object