Package adams.data.io.input

Class AbstractEmailFileReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractEmailReader

adams.data.io.input.AbstractEmailFileReader

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, EmailFileReader, EmailReader, Serializable

Direct Known Subclasses:

EmlEmailFileReader, PropertiesEmailFileReader

public abstract class AbstractEmailFileReader
extends AbstractEmailReader
implements EmailFileReader

Ancestor of email readers that read emails from 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_Input	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
AbstractEmailFileReader()

Method Summary

Modifier and Type	Method	Description
protected void	check()	Hook method for performing checks before reading the emails.
void	defineOptions()	Adds options to the internal list of options.
String	getDefaultFormatExtension()	Returns the default extension of the format.
PlaceholderFile	getInput()	Returns the file to read.
String	inputTipText()	Returns the tip text for this property.
void	setInput(PlaceholderFile value)	Sets the file to read.

Methods inherited from class adams.data.io.input.AbstractEmailReader

doRead, read

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.input.EmailFileReader

getFormatDescription, getFormatExtensions

Methods inherited from interface adams.data.io.input.EmailReader

read

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Input

protected PlaceholderFile m_Input

the file to read the email from.

Constructor Detail

AbstractEmailFileReader

public AbstractEmailFileReader()

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!)

setInput

public void setInput(PlaceholderFile value)

Sets the file to read.

Specified by:

setInput in interface EmailFileReader

Parameters:

value - the file

getInput

public PlaceholderFile getInput()

Returns the file to read.

Specified by:

getInput in interface EmailFileReader

Returns:

the object

inputTipText

public String inputTipText()

Returns the tip text for this property.

Specified by:

inputTipText in interface EmailFileReader

Returns:

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

check

protected void check()

Hook method for performing checks before reading the emails. Throws IllegalStateException in case something is wrong.

Ensures that input is a file and present.

Overrides:

check in class AbstractEmailReader