org.knime.base.node.io.csvwriter
Class FileWriterNodeSettings

java.lang.Object
  extended by org.knime.base.node.io.csvwriter.FileWriterSettings
      extended by org.knime.base.node.io.csvwriter.FileWriterNodeSettings

 class FileWriterNodeSettings
extends FileWriterSettings

Author:
ohl, University of Konstanz

Nested Class Summary
(package private) static class FileWriterNodeSettings.FileOverwritePolicy
          Policy how to proceed when output file exists (overwrite, abort, append).
 
Nested classes/interfaces inherited from class org.knime.base.node.io.csvwriter.FileWriterSettings
FileWriterSettings.quoteMode
 
Field Summary
static String CFGKEY_FILE
           
 
Constructor Summary
FileWriterNodeSettings()
           
FileWriterNodeSettings(NodeSettingsRO settings)
          Constructs a new object reading the settings from the specified NodeSettings object.
 
Method Summary
(package private)  boolean addCreationTime()
           
(package private)  boolean addCreationUser()
           
(package private)  boolean addTableName()
           
(package private)  String getCommentBegin()
           
(package private)  String getCommentEnd()
           
(package private)  String getCustomCommentLine()
           
(package private)  String getFileName()
           
(package private)  FileWriterNodeSettings.FileOverwritePolicy getFileOverwritePolicy()
           
 void saveSettingsTo(NodeSettingsWO settings)
          Saves the current values (even if they are incomplete or invalid) in the specified settings object.
(package private)  void setAddCreationTime(boolean addCreationTime)
           
(package private)  void setAddCreationUser(boolean addCreationUser)
           
(package private)  void setAddTableName(boolean addTableName)
           
(package private)  void setCommentBegin(String commentBegin)
           
(package private)  void setCommentEnd(String commentEnd)
           
(package private)  void setCustomCommentLine(String customCommentLine)
           
(package private)  void setFileName(String fileName)
           
(package private)  void setFileOverwritePolicy(FileWriterNodeSettings.FileOverwritePolicy fileOverwritePolicy)
           
(package private)  void setSkipColHeaderIfFileExists(boolean skipColHeaderIfFileExists)
           
(package private)  boolean skipColHeaderIfFileExists()
           
 
Methods inherited from class org.knime.base.node.io.csvwriter.FileWriterSettings
escapeString, getColSeparator, getDecimalSeparator, getMissValuePattern, getQuoteBegin, getQuoteEnd, getQuoteMode, getQuoteReplacement, getSeparatorReplacement, replaceSeparatorInStrings, setColSeparator, setDecimalSeparator, setMissValuePattern, setQuoteBegin, setQuoteEnd, setQuoteMode, setQuoteReplacement, setReplaceSeparatorInStrings, setSeparatorReplacement, setWriteColumnHeader, setWriteRowID, unescapeString, writeColumnHeader, writeRowID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CFGKEY_FILE

public static final String CFGKEY_FILE
See Also:
Constant Field Values
Constructor Detail

FileWriterNodeSettings

FileWriterNodeSettings()

FileWriterNodeSettings

FileWriterNodeSettings(NodeSettingsRO settings)
                 throws InvalidSettingsException
Constructs a new object reading the settings from the specified NodeSettings object. If the settings object doesn't contain all settings an exception is thrown. Settings are accepted and set internally even if they are invalid or inconsistent.

Parameters:
settings - the object to read the initial values from.
Throws:
InvalidSettingsException - if the settings object contains incomplete, invalid, or inconsistent values.
Method Detail

saveSettingsTo

public void saveSettingsTo(NodeSettingsWO settings)
Saves the current values (even if they are incomplete or invalid) in the specified settings object.

Overrides:
saveSettingsTo in class FileWriterSettings
Parameters:
settings - the object to write the current values to.

addCreationTime

boolean addCreationTime()
Returns:
the addCreationTime

setAddCreationTime

void setAddCreationTime(boolean addCreationTime)
Parameters:
addCreationTime - the addCreationTime to set

addCreationUser

boolean addCreationUser()
Returns:
the addCreationUser

setAddCreationUser

void setAddCreationUser(boolean addCreationUser)
Parameters:
addCreationUser - the addCreationUser to set

addTableName

boolean addTableName()
Returns:
the addTableName

setAddTableName

void setAddTableName(boolean addTableName)
Parameters:
addTableName - the addTableName to set

getCommentBegin

String getCommentBegin()
Returns:
the commentBegin

setFileOverwritePolicy

void setFileOverwritePolicy(FileWriterNodeSettings.FileOverwritePolicy fileOverwritePolicy)
Parameters:
fileOverwritePolicy - the fileOverwritePolicy to set

getFileOverwritePolicy

FileWriterNodeSettings.FileOverwritePolicy getFileOverwritePolicy()
Returns:
the fileOverwritePolicy, never null

setCommentBegin

void setCommentBegin(String commentBegin)
Parameters:
commentBegin - the commentBegin to set

getCommentEnd

String getCommentEnd()
Returns:
the commentEnd

setCommentEnd

void setCommentEnd(String commentEnd)
Parameters:
commentEnd - the commentEnd to set

getCustomCommentLine

String getCustomCommentLine()
Returns:
the customCommentLine

setCustomCommentLine

void setCustomCommentLine(String customCommentLine)
Parameters:
customCommentLine - the customCommentLine to set

getFileName

String getFileName()
Returns:
the fileName

setFileName

void setFileName(String fileName)
Parameters:
fileName - the fileName to set

skipColHeaderIfFileExists

boolean skipColHeaderIfFileExists()
Returns:
the skipColHeaderIfFileExists

setSkipColHeaderIfFileExists

void setSkipColHeaderIfFileExists(boolean skipColHeaderIfFileExists)
Parameters:
skipColHeaderIfFileExists - the skipColHeaderIfFileExists to set


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.