Package adams.data.io.output

Class TextFileWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractTextWriter

adams.data.io.output.AbstractTextWriterWithEncoding

adams.data.io.output.AbstractTextWriterWithFilenameGenerator

adams.data.io.output.TextFileWriter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, EncodingSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

TextFileWithLineNumbersWriter

public class TextFileWriter
extends AbstractTextWriterWithFilenameGenerator

Writes the content to a text file.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-enabled <boolean> (property: enabled)
    Whether the writer is enabled.
    default: true
 

-encoding <adams.core.base.BaseCharset> (property: encoding)
    The type of encoding to use.
    default: Default
 

-filename-generator <adams.core.io.AbstractFilenameGenerator> (property: filenameGenerator)
    The filename generator to use.
    default: adams.core.io.SimpleFilenameGenerator
 

-ignore-name <boolean> (property: ignoreName)
    If set to true, then the name of the content is ignored for generating the 
    filename (useful when prefix or suffix is based on variables).
    default: false
 

-append <boolean> (property: append)
    If enabled, the content gets appended rather than rewriting the file.
    default: false
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Append	whether to append the file.

Fields inherited from class adams.data.io.output.AbstractTextWriterWithFilenameGenerator

m_FilenameGenerator, m_IgnoreName

Fields inherited from class adams.data.io.output.AbstractTextWriterWithEncoding

m_Encoding

Fields inherited from class adams.data.io.output.AbstractTextWriter

m_Enabled

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
TextFileWriter()

Method Summary

Modifier and Type	Method	Description
String	appendTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doWrite(String content, String name)	Writes the given content under the specified name.
boolean	getAppend()	Returns whether to append the file rather than rewriting it.
String	globalInfo()	Returns a short description of the writer.
void	setAppend(boolean value)	Sets whether to append the file rather than rewriting it.

Methods inherited from class adams.data.io.output.AbstractTextWriterWithFilenameGenerator

createFilename, filenameGeneratorTipText, getFilenameGenerator, getIgnoreName, ignoreNameTipText, setFilenameGenerator, setIgnoreName

Methods inherited from class adams.data.io.output.AbstractTextWriterWithEncoding

encodingTipText, getEncoding, setEncoding

Methods inherited from class adams.data.io.output.AbstractTextWriter

enabledTipText, getEnabled, setEnabled, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Append

protected boolean m_Append

whether to append the file.

Constructor Detail

TextFileWriter

public TextFileWriter()

Method Detail

globalInfo

public String globalInfo()

Returns a short description of the writer.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description of the writer

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractTextWriterWithFilenameGenerator

setAppend

public void setAppend(boolean value)

Sets whether to append the file rather than rewriting it.

Parameters:

value - if true then append the content

getAppend

public boolean getAppend()

Returns whether to append the file rather than rewriting it.

Returns:

true if to append the content

appendTipText

public String appendTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doWrite

protected String doWrite(String content,
                         String name)

Writes the given content under the specified name.

Specified by:

doWrite in class AbstractTextWriter

Parameters:

content - the content to write

name - the name under which to save the content

Returns:

if a file was generated, the filename the content was written as, otherwise null