Package adams.data.io.output

Class AbstractSimpleReportWriter<T extends Report>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractReportWriter<T>

adams.data.io.output.AbstractSimpleReportWriter<T>

Type Parameters:

T - the type of report to handle

All Implemented Interfaces:

CleanUpHandler, Destroyable, GlobalInfoSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<AbstractReportWriter>, SizeOfHandler, ReportWriter<T>, StringReportWriter<T>, Serializable, Comparable

Direct Known Subclasses:

DefaultSimpleReportWriter

public abstract class AbstractSimpleReportWriter<T extends Report>
extends AbstractReportWriter<T>
implements StringReportWriter<T>

Abstract ancestor for writing reports in properties format.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

m_Output

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

Method Summary

Modifier and Type	Method	Description
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
String	globalInfo()	Returns a string describing the object.
protected String[]	toLines(T data)	Turns the data into an array of strings (sorted field names).
String	write(T data, MessageCollection errors)	Performs checks and converts the report to a string.
protected boolean	writeData(T data)	Performs the actual writing.

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

checkData, cleanUp, compareTo, defineOptions, destroy, equals, forCommandLine, forName, getDefaultFormatExtension, getOutput, getWriters, outputTipText, reset, setOutput, shallowCopy, shallowCopy, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

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

getOutput, outputTipText, setOutput, write

Constructor Detail

AbstractSimpleReportWriter

public AbstractSimpleReportWriter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getFormatDescription

public String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface FileFormatHandler

Specified by:

getFormatDescription in class AbstractReportWriter<T extends Report>

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface FileFormatHandler

Specified by:

getFormatExtensions in class AbstractReportWriter<T extends Report>

Returns:

the extension(s) (without the dot!)

toLines

protected String[] toLines(T data)
                    throws Exception

Turns the data into an array of strings (sorted field names).

Parameters:

data - the data to convert

Returns:

the generated string array

Throws:

Exception - if conversion fails

writeData

protected boolean writeData(T data)

Performs the actual writing.

Specified by:

writeData in class AbstractReportWriter<T extends Report>

Parameters:

data - the data to write

Returns:

true if successfully written

write

public String write(T data,
                    MessageCollection errors)

Performs checks and converts the report to a string.

Specified by:

write in interface StringReportWriter<T extends Report>

Parameters:

data - the data to write

errors - for collecting errors

Returns:

the generated data, null in case of failure