Package adams.data.io.output

Class AbstractTextWriterWithFilenameGenerator

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TextFileWriter

public abstract class AbstractTextWriterWithFilenameGenerator
extends AbstractTextWriterWithEncoding

Ancestor for text writers that use an AbstractFilenameGenerator to generate their filename.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractFilenameGenerator	m_FilenameGenerator	the filename generator to use.
protected boolean	m_IgnoreName	whether to discard the provided name object.

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
AbstractTextWriterWithFilenameGenerator()

Method Summary

Modifier and Type	Method	Description
protected String	createFilename(String name)	Creates the filename.
void	defineOptions()	Adds options to the internal list of options.
String	filenameGeneratorTipText()	Returns the tip text for this property.
AbstractFilenameGenerator	getFilenameGenerator()	Returns the filename generator.
boolean	getIgnoreName()	Returns whether the name of the content is ignored and the filename is only generated based on prefix/suffix.
String	ignoreNameTipText()	Returns the tip text for this property.
void	setFilenameGenerator(AbstractFilenameGenerator value)	Sets the filename generator.
void	setIgnoreName(boolean value)	Sets whether to ignore the name and just rely on prefix/suffix to generate the filename.

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

encodingTipText, getEncoding, setEncoding

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

doWrite, enabledTipText, getEnabled, setEnabled, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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_FilenameGenerator

protected AbstractFilenameGenerator m_FilenameGenerator

the filename generator to use.

m_IgnoreName

protected boolean m_IgnoreName

whether to discard the provided name object.

Constructor Detail

AbstractTextWriterWithFilenameGenerator

public AbstractTextWriterWithFilenameGenerator()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractTextWriterWithEncoding

setFilenameGenerator

public void setFilenameGenerator(AbstractFilenameGenerator value)

Sets the filename generator.

Parameters:

value - the generator

getFilenameGenerator

public AbstractFilenameGenerator getFilenameGenerator()

Returns the filename generator.

Returns:

the generator

filenameGeneratorTipText

public String filenameGeneratorTipText()

Returns the tip text for this property.

Returns:

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

setIgnoreName

public void setIgnoreName(boolean value)

Sets whether to ignore the name and just rely on prefix/suffix to generate the filename.

Parameters:

value - if true then the name of the content gets ignored

getIgnoreName

public boolean getIgnoreName()

Returns whether the name of the content is ignored and the filename is only generated based on prefix/suffix.

Returns:

true if the name of the content gets ignored

ignoreNameTipText

public String ignoreNameTipText()

Returns the tip text for this property.

Returns:

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

createFilename

protected String createFilename(String name)

Creates the filename.

Parameters:

name - the name of the content

Returns:

the generated filename