Package adams.data.io.output

Class AbstractSimpleCSVReportWriter<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.AbstractSimpleCSVReportWriter<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>, Serializable, Comparable

Direct Known Subclasses:

DefaultSimpleCSVReportWriter

public abstract class AbstractSimpleCSVReportWriter<T extends Report>
extends AbstractReportWriter<T>

Abstract ancestor for writing reports in CSV format.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	COL_FIELD	the name of the "field" column.
static String	COL_TYPE	the name of the "type" column.
static String	COL_VALUE	the name of the "value" column.

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

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

Field Detail

COL_FIELD

public static final String COL_FIELD

the name of the "field" column.

See Also:

Constant Field Values

COL_TYPE

public static final String COL_TYPE

the name of the "type" column.

See Also:

Constant Field Values

COL_VALUE

public static final String COL_VALUE

the name of the "value" column.

See Also:

Constant Field Values

Constructor Detail

AbstractSimpleCSVReportWriter

public AbstractSimpleCSVReportWriter()

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

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