Package adams.data.io.output

Class AbstractEmailFileWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractEmailWriter

adams.data.io.output.AbstractEmailFileWriter

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, EmailFileWriter, EmailWriter, Serializable

Direct Known Subclasses:

PlainTextEmailFileWriter, PropertiesEmailFileWriter

public abstract class AbstractEmailFileWriter
extends AbstractEmailWriter
implements EmailFileWriter

Ancestor for email writers that write to files.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_Output	the file to read the email from.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	getDefaultFormatExtension()	Returns the default extension of the format.
PlaceholderFile	getOutput()	Returns the file to write the email to.
String	outputTipText()	Returns the tip text for this property.
void	setOutput(PlaceholderFile value)	Sets the file to write the email to.

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

check, doWrite, 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.data.io.output.EmailFileWriter

getFormatDescription, getFormatExtensions

Methods inherited from interface adams.data.io.output.EmailWriter

write

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Output

protected PlaceholderFile m_Output

the file to read the email from.

Constructor Detail

AbstractEmailFileWriter

public AbstractEmailFileWriter()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getDefaultFormatExtension

public String getDefaultFormatExtension()

Returns the default extension of the format.

Specified by:

getDefaultFormatExtension in interface FileFormatHandler

Returns:

the default extension (without the dot!)

setOutput

public void setOutput(PlaceholderFile value)

Sets the file to write the email to.

Specified by:

setOutput in interface EmailFileWriter

Parameters:

value - the file

getOutput

public PlaceholderFile getOutput()

Returns the file to write the email to.

Specified by:

getOutput in interface EmailFileWriter

Returns:

the file

outputTipText

public String outputTipText()

Returns the tip text for this property.

Specified by:

outputTipText in interface EmailFileWriter

Returns:

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