Package adams.doc.listing

Class AbstractFileBasedListingOutput

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.doc.listing.AbstractListingOutput

adams.doc.listing.AbstractFileBasedListingOutput

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, FileWriter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, Serializable

Direct Known Subclasses:

AbstractFileBasedListingOutputWithEncoding

public abstract class AbstractFileBasedListingOutput
extends AbstractListingOutput
implements FileWriter

Ancestor for schemes that output the listings to a file.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_OutputFile	the output file.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(Class superclass, Map<String,List<String>> listing)	Hook method for performing checks before generating the output.
void	defineOptions()	Adds options to the internal list of options.
protected abstract PlaceholderFile	getDefaultOutputFile()	Returns the default output file.
PlaceholderFile	getOutputFile()	Returns the output file.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
abstract String	outputFileTipText()	Returns the tip text for this property.
void	setOutputFile(PlaceholderFile value)	Sets the output file.

Methods inherited from class adams.doc.listing.AbstractListingOutput

doGenerate, generate, getModules

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_OutputFile

protected PlaceholderFile m_OutputFile

the output file.

Constructor Detail

AbstractFileBasedListingOutput

public AbstractFileBasedListingOutput()

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

getDefaultOutputFile

protected abstract PlaceholderFile getDefaultOutputFile()

Returns the default output file.

Returns:

the default

setOutputFile

public void setOutputFile(PlaceholderFile value)

Sets the output file.

Specified by:

setOutputFile in interface FileWriter

Parameters:

value - the file

getOutputFile

public PlaceholderFile getOutputFile()

Returns the output file.

Specified by:

getOutputFile in interface FileWriter

Returns:

the file

outputFileTipText

public abstract String outputFileTipText()

Returns the tip text for this property.

Specified by:

outputFileTipText in interface FileWriter

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractListingOutput

Returns:

null if no info available, otherwise short string

check

protected String check(Class superclass,
                       Map<String,List<String>> listing)

Hook method for performing checks before generating the output.

Overrides:

check in class AbstractListingOutput

Parameters:

superclass - the superclass this listing is for

listing - the listing data to check

Returns:

null if successful, otherwise error message