org.knime.base.node.io.filereader
Class VariableFileReaderNodeSettings

java.lang.Object
  org.knime.core.util.tokenizer.TokenizerSettings
      org.knime.base.node.io.filereader.FileReaderSettings
          org.knime.base.node.io.filereader.FileReaderNodeSettings
              org.knime.base.node.io.filereader.VariableFileReaderNodeSettings

 class VariableFileReaderNodeSettings
extends FileReaderNodeSettings

Author:

ohl, University of Konstanz

Field Summary

Fields inherited from class org.knime.base.node.io.filereader.FileReaderSettings

CFGKEY_DATAURL, DEF_ROWPREFIX

Constructor Summary

VariableFileReaderNodeSettings()
Creates an empty settings object.

VariableFileReaderNodeSettings(FileReaderNodeSettings clonee)
Create new settings object for the variable file reader based on the given settings object.

VariableFileReaderNodeSettings(NodeSettingsRO cfg)
Creates a new settings object initialized with the values from the passed object.

VariableFileReaderNodeSettings(String variableName)

VariableFileReaderNodeSettings(VariableFileReaderNodeSettings clonee)
Creates a clone.

Method Summary

(package private) VariableFileReaderNodeSettings	createSettingsFrom(Map<String,FlowVariable> stack) Creates a clone from this object replacing the dataURL location by the value from stack.
String	getVariableName()
void	saveToConfiguration(NodeSettingsWO cfg) Writes all settings into the passed configuration object.
void	setVariableName(String variableName)

Methods inherited from class org.knime.base.node.io.filereader.FileReaderNodeSettings

addStatusOfSettings, analyzeUsedAllRows, createDataTableSpec, decimalSeparatorUserSet, getColumnProperties, getMissingValueOfColumn, getNumberOfColumns, getPreserveSettings, getSkippedColumns, getStatusOfSettings, getStatusOfSettings, ignoreDelimsAtEORUserSet, ignoreDelimsAtEORUserValue, isCommentUserSet, isDelimiterUserSet, isFileHasColumnHeadersUserSet, isFileHasRowHeadersUserSet, isIgnoreEmptyLinesUserSet, isQuoteUserSet, isWhiteSpaceUserSet, readSettingsFromXMLFile, setAnalyzeUsedAllRows, setColumnProperties, setCommentUserSet, setDecimalSeparatorUserSet, setDelimiterUserSet, setFileHasColumnHeadersUserSet, setFileHasRowHeadersUserSet, setIgnoreDelimsAtEndOfRowUserValue, setIgnoreEmptyLinesUserSet, setMissingValueForColumn, setNumberOfColumns, setPreserveSettings, setQuoteUserSet, setWhiteSpaceUserSet, toString

Methods inherited from class org.knime.base.node.io.filereader.FileReaderSettings

addRowDelimiter, combinesMultipleRowDelimiters, createNewInputReader, getCharsetName, getColumnNumDeterminingLineNumber, getDataFileLocation, getDecimalSeparator, getFileHasColumnHeaders, getFileHasRowHeaders, getIgnoreEmtpyLines, getMaximumNumberOfRowsToRead, getMissValuePatternStrCols, getRowHeaderPrefix, getSupportShortLines, getTableName, getThousandsSeparator, ignoreEmptyTokensAtEndOfRow, isRowDelimiter, removeAllDelimiters, removeAllRowDelimiters, removeDelimiterPattern, removeRowDelimiter, setCharsetName, setColumnNumDeterminingLineNumber, setDataFileLocationAndUpdateTableName, setDecimalSeparator, setFileHasColumnHeaders, setFileHasRowHeaders, setIgnoreEmptyLines, setIgnoreEmptyTokensAtEndOfRow, setMaximumNumberOfRowsToRead, setMissValuePatternStrCols, setRowHeaderPrefix, setSupportShortLines, setTableName, setThousandsSeparator, setUniquifyRowIDs, uniquifyRowIDs

Methods inherited from class org.knime.core.util.tokenizer.TokenizerSettings

addBlockCommentPattern, addDelimiterPattern, addDelimiterPattern, addOrReplaceDelimiterPattern, addQuotePattern, addQuotePattern, addQuotePattern, addQuotePattern, addSingleLineCommentPattern, addStatusOfSettings, addWhiteSpaceCharacter, addWhiteSpaceCharacter, getAllComments, getAllDelimiters, getAllQuotes, getAllWhiteSpaces, getCombineMultipleDelimiters, getDelimiterPattern, getLineContinuationCharacter, printableStr, removeAllComments, removeAllQuotes, removeAllWhiteSpaces, removeQuotePattern, setCombineMultipleDelimiters, setLineContinuationCharacter, unescapeString

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableFileReaderNodeSettings

public VariableFileReaderNodeSettings()

Creates an empty settings object.

VariableFileReaderNodeSettings

VariableFileReaderNodeSettings(String variableName)

Parameters:

variableName - the name of the scope variable to read the file location from

VariableFileReaderNodeSettings

public VariableFileReaderNodeSettings(VariableFileReaderNodeSettings clonee)

Creates a clone.

Parameters:

clonee - the thing to clone.

VariableFileReaderNodeSettings

public VariableFileReaderNodeSettings(FileReaderNodeSettings clonee)

Create new settings object for the variable file reader based on the given settings object.

Parameters:

clonee - clone this settings object

VariableFileReaderNodeSettings

public VariableFileReaderNodeSettings(NodeSettingsRO cfg)
                               throws InvalidSettingsException

Creates a new settings object initialized with the values from the passed object.

Parameters:

cfg - the config to read the values from

Throws:

InvalidSettingsException - if cfg object is invalid

Method Detail

setVariableName

public void setVariableName(String variableName)

Parameters:

variableName - the variableName to set

getVariableName

public String getVariableName()

Returns:

the variableName

createSettingsFrom

VariableFileReaderNodeSettings createSettingsFrom(Map<String,FlowVariable> stack)
                                            throws MalformedURLException,
                                                   InvalidSettingsException

Creates a clone from this object replacing the dataURL location by the value from stack.

Parameters:

stack - the map containing all currently available variables and their values

Returns:

a copy of this settings object with the file location replaced by the value of the variable

Throws:

InvalidSettingsException - if the variable is not on the stack

MalformedURLException - if the value of the variable is not a valid URL

saveToConfiguration

public void saveToConfiguration(NodeSettingsWO cfg)

Writes all settings into the passed configuration object. Except for the analyzedAllRows flag. Saves all settings into a NodeSettingsWO object. Using the cfg object to construct a new FileReaderSettings object should lead to an object identical to this.

Overrides:

saveToConfiguration in class FileReaderNodeSettings

Parameters:

cfg - the config object the settings are stored into