org.knime.base.node.meta.looper.condition
Class LoopEndConditionSettings

java.lang.Object
  org.knime.base.node.meta.looper.condition.LoopEndConditionSettings

public class LoopEndConditionSettings
extends Object

This class holds the settings for the condition loop tail node.

Author:

Thorsten Meinl, University of Konstanz

Nested Class Summary

static class

LoopEndConditionSettings.Operator All comparison operators the user can choose from in the dialog.

Constructor Summary

LoopEndConditionSettings()

Method Summary

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.
boolean	addLastRows() Returns if the rows from the loop's last iteration should be added to the output table or not.
void	addLastRows(boolean b) Sets if the rows from the loop's last iteration should be added to the output table or not.
boolean	addLastRowsOnly() Returns if only the rows from the loop's last iteration should be added to the output table or not.
void	addLastRowsOnly(boolean b) Sets if only the rows from the loop's last iteration should be added to the output table or not.
void	loadSettings(NodeSettingsRO settings) Loads the settings from the node settings object.
void	loadSettingsForDialog(NodeSettingsRO settings) Loads the settings from the node settings object.
LoopEndConditionSettings.Operator	operator() Returns the operator that should be used in the comparison between variable and value.
void	operator(LoopEndConditionSettings.Operator op) Sets the operator that should be used in the comparison between variable and value.
void	saveSettings(NodeSettingsWO settings) Writes the settings into the node settings object.
String	value() Returns the value the flow variable should be compared with.
void	value(String s) Sets the value the flow variable should be compared with.
void	variable(FlowVariable var) Sets the flow variable which is checked in each iteration.
String	variableName() Returns the flow variable's name which is checked in each iteration.
FlowVariable.Type	variableType() Returns the flow variable's type which is checked in each iteration.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoopEndConditionSettings

public LoopEndConditionSettings()

Method Detail

addLastRows

public boolean addLastRows()

Returns if the rows from the loop's last iteration should be added to the output table or not.

Returns:

true if the rows should be added, false otherwise

addLastRowsOnly

public void addLastRowsOnly(boolean b)

Sets if only the rows from the loop's last iteration should be added to the output table or not.

Parameters:

b - true if the only the last rows should be added, false otherwise

addLastRowsOnly

public boolean addLastRowsOnly()

Returns if only the rows from the loop's last iteration should be added to the output table or not.

Returns:

true if the only the last rows should be added, false otherwise

addLastRows

public void addLastRows(boolean b)

Sets if the rows from the loop's last iteration should be added to the output table or not.

Parameters:

b - true if the rows should be added, false otherwise

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

variableName

public String variableName()

Returns the flow variable's name which is checked in each iteration.

Returns:

the variable's name

variableType

public FlowVariable.Type variableType()

Returns the flow variable's type which is checked in each iteration.

Returns:

the variable's type

variable

public void variable(FlowVariable var)

Sets the flow variable which is checked in each iteration.

Parameters:

var - the flow variable

operator

public LoopEndConditionSettings.Operator operator()

Returns the operator that should be used in the comparison between variable and value.

Returns:

the comparison operator

operator

public void operator(LoopEndConditionSettings.Operator op)

Sets the operator that should be used in the comparison between variable and value.

Parameters:

op - the comparison operator

value

public String value()

Returns the value the flow variable should be compared with. It can either be a number or a string, depending on the flow variables type.

Returns:

the value

value

public void value(String s)

Sets the value the flow variable should be compared with. It can either be a number or a string, depending on the flow variables type.

Parameters:

s - the value

loadSettings

public void loadSettings(NodeSettingsRO settings)
                  throws InvalidSettingsException

Loads the settings from the node settings object.

Parameters:

settings - a node settings object

Throws:

InvalidSettingsException

loadSettingsForDialog

public void loadSettingsForDialog(NodeSettingsRO settings)

Loads the settings from the node settings object.

Parameters:

settings - a node settings object

saveSettings

public void saveSettings(NodeSettingsWO settings)

Writes the settings into the node settings object.

Parameters:

settings - a node settings object