org.knime.base.node.preproc.cellsplit
Class CellSplitterUserSettings

java.lang.Object
  org.knime.base.node.preproc.cellsplit.CellSplitterUserSettings

Direct Known Subclasses:

CellSplitterSettings

public class CellSplitterUserSettings
extends Object

Holds all user settings needed for the cell splitter. Provides methods for saving and a constructor taking a NodeSettingRO object.

Author:

ohl, University of Konstanz

Constructor Summary

CellSplitterUserSettings()
Creates a new settings object with no (or default) settings.

CellSplitterUserSettings(NodeSettingsRO settings)
Creates a new settings object with the value from the specified settings object.

Method Summary

(package private) String	getColumnName()
(package private) String	getDelimiter()
(package private) int	getNumOfCols()
(package private) String	getQuotePattern()
(package private) String	getStatus(DataTableSpec spec)
(package private) boolean	isGuessNumOfCols()
(package private) boolean	isRemoveQuotes()
(package private) boolean	isUseEmptyString()
(package private) void	saveSettingsTo(NodeSettingsWO settings) Stores the settings values in the specified object.
(package private) void	setColumnName(String columnName)
(package private) void	setDelimiter(String delimiter)
(package private) void	setGuessNumOfCols(boolean guessNumOfCols)
(package private) void	setNumOfCols(int numOfCols)
(package private) void	setQuotePattern(String quotePattern)
(package private) void	setRemoveQuotes(boolean removeQuotes)
(package private) void	setUseEmptyString(boolean useEmptyString) If set to true, the node creates an empty cell in case of a missing input cell or a missing split.

Methods inherited from class java.lang.Object

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

Constructor Detail

CellSplitterUserSettings

CellSplitterUserSettings()

Creates a new settings object with no (or default) settings.

CellSplitterUserSettings

CellSplitterUserSettings(NodeSettingsRO settings)
                   throws InvalidSettingsException

Creates a new settings object with the value from the specified settings object. If the values in there are incomplete it throws an Exception. The values can be validated (checked for consistency and validity) with the getStatus method.

Parameters:

settings - the config object to read the settings values from

Throws:

InvalidSettingsException - if the values in the settings object are incomplete.

Method Detail

saveSettingsTo

void saveSettingsTo(NodeSettingsWO settings)

Stores the settings values in the specified object.

Parameters:

settings - the config object to save the values in

getStatus

String getStatus(DataTableSpec spec)

Parameters:

spec - the spec to check the settings against. Can be null.

Returns:

null, if the settings are okay, or an user error message if some settings are missing or invalid.

getColumnName

String getColumnName()

Returns:

the columnName

setColumnName

void setColumnName(String columnName)

Parameters:

columnName - the columnName to set

getDelimiter

String getDelimiter()

Returns:

the delimiter

setDelimiter

void setDelimiter(String delimiter)

Parameters:

delimiter - the delimiter to set

isGuessNumOfCols

boolean isGuessNumOfCols()

Returns:

the guessNumOfCols

setGuessNumOfCols

void setGuessNumOfCols(boolean guessNumOfCols)

Parameters:

guessNumOfCols - the guessNumOfCols to set

getNumOfCols

int getNumOfCols()

Returns:

the numOfCols

setNumOfCols

void setNumOfCols(int numOfCols)

Parameters:

numOfCols - the numOfCols to set

getQuotePattern

String getQuotePattern()

Returns:

the quotePattern

setQuotePattern

void setQuotePattern(String quotePattern)

Parameters:

quotePattern - the quotePattern to set

isRemoveQuotes

boolean isRemoveQuotes()

Returns:

the removeQuotes

setRemoveQuotes

void setRemoveQuotes(boolean removeQuotes)

Parameters:

removeQuotes - the removeQuotes to set

isUseEmptyString

boolean isUseEmptyString()

Returns:

true, if an empty string cell is introduced instead of a missing cell (in case of in missing input cell, or missing split results).

setUseEmptyString

void setUseEmptyString(boolean useEmptyString)

If set to true, the node creates an empty cell in case of a missing input cell or a missing split. Otherwise, if set false, it introduces a missing cell instead.

Parameters:

useEmptyString - set to true to create empty string cells instead of missing cells.