org.knime.base.node.preproc.joiner
Class NewJoinerSettings

java.lang.Object
  extended by org.knime.base.node.preproc.joiner.NewJoinerSettings

public class NewJoinerSettings
extends Object

This class hold the settings for the joiner node.

Author:
Thorsten Meinl, University of Konstanz

Nested Class Summary
static class NewJoinerSettings.DuplicateHandling
          This enum holds all ways of handling duplicate column names in the two input tables.
static class NewJoinerSettings.JoinMode
          This enum holds all ways of joining the two tables.
 
Field Summary
(package private) static String ROW_KEY_COL_NAME
          Name of the row key column in the dialog.
(package private) static String ROW_KEY_IDENTIFIER
          Internally used row key identifier.
 
Constructor Summary
NewJoinerSettings()
           
 
Method Summary
 NewJoinerSettings.DuplicateHandling duplicateHandling()
          Returns how duplicate column names should be handled.
 void duplicateHandling(NewJoinerSettings.DuplicateHandling duplicateHandling)
          Sets how duplicate column names should be handled.
 NewJoinerSettings.JoinMode joinMode()
          Returns the mode how the two tables should be joined.
 void joinMode(NewJoinerSettings.JoinMode joinMode)
          Sets the mode how the two tables should be joined.
 String keySuffix()
          Returns the suffix that is appended to row keys from the first table if multiple rows from the second table match.
 void keySuffix(String suffix)
          Sets the suffix that is appended to row keys from the first table if multiple rows from the second table match.
 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 some settings are missing.
 void saveSettings(NodeSettingsWO settings)
          Saves the settings into the node settings object.
 String secondTableColumn()
          Returns the join column's name from the second table.
 void secondTableColumn(String secondTableColumn)
          Sets the join column's name from the second table.
 String suffix()
          Returns the suffix that is appended to duplicate columns from the second table if the duplicate handling method is JoinMode.AppendSuffix.
 void suffix(String suffix)
          Sets the suffix that is appended to duplicate columns from the second table if the duplicate handling method is JoinMode.AppendSuffix.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ROW_KEY_COL_NAME

static final String ROW_KEY_COL_NAME
Name of the row key column in the dialog.

See Also:
Constant Field Values

ROW_KEY_IDENTIFIER

static final String ROW_KEY_IDENTIFIER
Internally used row key identifier.

See Also:
Constant Field Values
Constructor Detail

NewJoinerSettings

public NewJoinerSettings()
Method Detail

secondTableColumn

public String secondTableColumn()
Returns the join column's name from the second table.

Returns:
the column's name

secondTableColumn

public void secondTableColumn(String secondTableColumn)
Sets the join column's name from the second table.

Parameters:
secondTableColumn - the column's name

duplicateHandling

public NewJoinerSettings.DuplicateHandling duplicateHandling()
Returns how duplicate column names should be handled.

Returns:
the duplicate handling method

duplicateHandling

public void duplicateHandling(NewJoinerSettings.DuplicateHandling duplicateHandling)
Sets how duplicate column names should be handled.

Parameters:
duplicateHandling - the duplicate handling method

joinMode

public NewJoinerSettings.JoinMode joinMode()
Returns the mode how the two tables should be joined.

Returns:
the join mode

joinMode

public void joinMode(NewJoinerSettings.JoinMode joinMode)
Sets the mode how the two tables should be joined.

Parameters:
joinMode - the join mode

suffix

public String suffix()
Returns the suffix that is appended to duplicate columns from the second table if the duplicate handling method is JoinMode.AppendSuffix.

Returns:
the suffix

suffix

public void suffix(String suffix)
Sets the suffix that is appended to duplicate columns from the second table if the duplicate handling method is JoinMode.AppendSuffix.

Parameters:
suffix - the suffix

keySuffix

public String keySuffix()
Returns the suffix that is appended to row keys from the first table if multiple rows from the second table match.

Returns:
the suffix

keySuffix

public void keySuffix(String suffix)
Sets the suffix that is appended to row keys from the first table if multiple rows from the second table match.

Parameters:
suffix - the suffix

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 some settings are missing

loadSettingsForDialog

public void loadSettingsForDialog(NodeSettingsRO settings)
Loads the settings from the node settings object using default values if some settings are missing.

Parameters:
settings - a node settings object

saveSettings

public void saveSettings(NodeSettingsWO settings)
Saves the settings into the node settings object.

Parameters:
settings - a node settings object


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.