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

java.lang.Object
  org.knime.base.node.preproc.joiner.Joiner2Settings

public class Joiner2Settings
extends Object

This class hold the settings for the joiner node.

Author:

Heiko Hofer

Nested Class Summary

static class	Joiner2Settings.CompositionMode This enum holds all ways how join attributes can be combined.
static class	Joiner2Settings.DuplicateHandling This enum holds all ways of handling duplicate column names in the two input tables.
static class	Joiner2Settings.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

Joiner2Settings()

Method Summary

Joiner2Settings.CompositionMode	getCompositionMode()
String	getDuplicateColumnSuffix() Returns the suffix that is appended to duplicate columns from the right table if the duplicate handling method is JoinMode.AppendSuffix.
Joiner2Settings.DuplicateHandling	getDuplicateHandling() Returns how duplicate column names should be handled.
boolean	getEnableHiLite() Returns true when hiliting should be supported.
Joiner2Settings.JoinMode	getJoinMode() Returns the mode how the two tables should be joined.
boolean	getLeftIncludeAll() Returns true when all columns of the left table should be added to the joining table.
String[]	getLeftIncludeCols() Returns the columns of the left table that should be included to the joining table.
String[]	getLeftJoinColumns() Returns the columns of the left table used in the join predicate.
int	getMaxOpenFiles() Return number of files that are allowed to be openend by the Joiner.
boolean	getRemoveLeftJoinCols() Returns true when the columns returned by getLeftJoinColumns() should not be added to the joining table.
boolean	getRemoveRightJoinCols() Returns true when the columns returned by getRightJoinColumns() should not be added to the joining table.
boolean	getRightIncludeAll() Returns true when all columns of the right table should be added to the joining table.
String[]	getRightIncludeCols() Returns the columns of the right table that should be included to the joining table.
String[]	getRightJoinColumns() Returns the columns of the right table used in the join predicate.
String	getRowKeySeparator() Return Separator of the RowKeys in the joined table.
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.
void	setCompositionMode(Joiner2Settings.CompositionMode compositionMode)
void	setDuplicateColumnSuffix(String suffix) Sets the suffix that is appended to duplicate columns from the right table if the duplicate handling method is JoinMode.AppendSuffix.
void	setDuplicateHandling(Joiner2Settings.DuplicateHandling duplicateHandling) Sets how duplicate column names should be handled.
void	setEnableHiLite(boolean enableHiLite) Set if hiliting should be supported.
void	setJoinMode(Joiner2Settings.JoinMode joinMode) Sets the mode how the two tables should be joined.
void	setLeftIncludeAll(boolean leftIncludeAll) Pass true when all columns of the left table should be added to the joining table.
void	setLeftIncludeCols(String[] leftIncludeCols) Sets the columns of the left table that should be included to the joining table.
void	setLeftJoinColumns(String[] leftJoinColumns) Sets the columns of the left table used in the join predicate.
void	setMaxOpenFiles(int maxOpenFiles) Set number of files that are allowed to be openend by the Joiner.
void	setRemoveLeftJoinCols(boolean rmLeftJoinCols) Pass true when the columns returned by getLeftJoinColumns() should not be added to the joining table.
void	setRemoveRightJoinCols(boolean rmRightJoinCols) Pass true when the columns returned by getRightJoinColumns() should not be added to the joining table.
void	setRightIncludeAll(boolean rightIncludeAll) Pass true when all columns of the right table should be added to the joining table.
void	setRightIncludeCols(String[] rightIncludeCols) Sets the columns of the right table that should be included to the joining table.
void	setRightJoinColumns(String[] rightJoinColumns) Sets the columns of the right table used in the join predicate.
void	setRowKeySeparator(String rowKeySeparator) Set Separator of the RowKeys in the joined table.

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

Joiner2Settings

public Joiner2Settings()

Method Detail

getLeftJoinColumns

public String[] getLeftJoinColumns()

Returns the columns of the left table used in the join predicate.

Returns:

the leftJoinColumns

setLeftJoinColumns

public void setLeftJoinColumns(String[] leftJoinColumns)

Sets the columns of the left table used in the join predicate.

Parameters:

leftJoinColumns - the leftJoinColumns to set

getRightJoinColumns

public String[] getRightJoinColumns()

Returns the columns of the right table used in the join predicate.

Returns:

the rightJoinColumns

setRightJoinColumns

public void setRightJoinColumns(String[] rightJoinColumns)

Sets the columns of the right table used in the join predicate.

Parameters:

rightJoinColumns - the rightJoinColumns to set

getCompositionMode

public Joiner2Settings.CompositionMode getCompositionMode()

Returns:

the compositionMode

setCompositionMode

public void setCompositionMode(Joiner2Settings.CompositionMode compositionMode)

Parameters:

compositionMode - the compositionMode to set

getDuplicateHandling

public Joiner2Settings.DuplicateHandling getDuplicateHandling()

Returns how duplicate column names should be handled.

Returns:

the duplicate handling method

setDuplicateHandling

public void setDuplicateHandling(Joiner2Settings.DuplicateHandling duplicateHandling)

Sets how duplicate column names should be handled.

Parameters:

duplicateHandling - the duplicate handling method

getJoinMode

public Joiner2Settings.JoinMode getJoinMode()

Returns the mode how the two tables should be joined.

Returns:

the join mode

setJoinMode

public void setJoinMode(Joiner2Settings.JoinMode joinMode)

Sets the mode how the two tables should be joined.

Parameters:

joinMode - the join mode

getDuplicateColumnSuffix

public String getDuplicateColumnSuffix()

Returns the suffix that is appended to duplicate columns from the right table if the duplicate handling method is JoinMode.AppendSuffix.

Returns:

the suffix

setDuplicateColumnSuffix

public void setDuplicateColumnSuffix(String suffix)

Sets the suffix that is appended to duplicate columns from the right table if the duplicate handling method is JoinMode.AppendSuffix.

Parameters:

suffix - the suffix

getLeftIncludeCols

public String[] getLeftIncludeCols()

Returns the columns of the left table that should be included to the joining table.

Returns:

the leftIncludeCols

setLeftIncludeCols

public void setLeftIncludeCols(String[] leftIncludeCols)

Sets the columns of the left table that should be included to the joining table.

Parameters:

leftIncludeCols - the leftIncludeCols to set

getRightIncludeCols

public String[] getRightIncludeCols()

Returns the columns of the right table that should be included to the joining table.

Returns:

the rightIncludeCols

setRightIncludeCols

public void setRightIncludeCols(String[] rightIncludeCols)

Sets the columns of the right table that should be included to the joining table.

Parameters:

rightIncludeCols - the rightIncludeCols to set

getLeftIncludeAll

public boolean getLeftIncludeAll()

Returns true when all columns of the left table should be added to the joining table.

Returns:

the leftIncludeAll

setLeftIncludeAll

public void setLeftIncludeAll(boolean leftIncludeAll)

Pass true when all columns of the left table should be added to the joining table.

Parameters:

leftIncludeAll - the leftIncludeAll to set

getRightIncludeAll

public boolean getRightIncludeAll()

Returns true when all columns of the right table should be added to the joining table.

Returns:

the rightIncludeAll

setRightIncludeAll

public void setRightIncludeAll(boolean rightIncludeAll)

Pass true when all columns of the right table should be added to the joining table.

Parameters:

rightIncludeAll - the rightIncludeAll to set

getRemoveLeftJoinCols

public boolean getRemoveLeftJoinCols()

Returns true when the columns returned by getLeftJoinColumns() should not be added to the joining table.

Returns:

the rmLeftJoinCols

setRemoveLeftJoinCols

public void setRemoveLeftJoinCols(boolean rmLeftJoinCols)

Pass true when the columns returned by getLeftJoinColumns() should not be added to the joining table.

Parameters:

rmLeftJoinCols - the rmLeftJoinCols to set

getRemoveRightJoinCols

public boolean getRemoveRightJoinCols()

Returns true when the columns returned by getRightJoinColumns() should not be added to the joining table.

Returns:

the rmRightJoinCols

setRemoveRightJoinCols

public void setRemoveRightJoinCols(boolean rmRightJoinCols)

Pass true when the columns returned by getRightJoinColumns() should not be added to the joining table.

Parameters:

rmRightJoinCols - the rmRightJoinCols to set

getMaxOpenFiles

public int getMaxOpenFiles()

Return number of files that are allowed to be openend by the Joiner.

Returns:

the maxOpenFiles

setMaxOpenFiles

public void setMaxOpenFiles(int maxOpenFiles)

Set number of files that are allowed to be openend by the Joiner.

Parameters:

maxOpenFiles - the maxOpenFiles to set

getRowKeySeparator

public String getRowKeySeparator()

Return Separator of the RowKeys in the joined table.

Returns:

the rowKeySeparator

setRowKeySeparator

public void setRowKeySeparator(String rowKeySeparator)

Set Separator of the RowKeys in the joined table.

Parameters:

rowKeySeparator - the rowKeySeparator to set

getEnableHiLite

public boolean getEnableHiLite()

Returns true when hiliting should be supported.

Returns:

the enableHiLite

setEnableHiLite

public void setEnableHiLite(boolean enableHiLite)

Set if hiliting should be supported.

Parameters:

enableHiLite - the enableHiLite to set

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