Package adams.data.io.output

Class AbstractMultiReportWriter<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.AbstractMultiReportWriter<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

DeepLabCutCSVWriter

public abstract class AbstractMultiReportWriter<T extends Report>
extends AbstractReportWriter<T>
implements MultiReportWriter<T>

Ancestor for report writers that write multiple reports into a single file.

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

Method Summary

Modifier and Type	Method	Description
protected void	checkData(T[] data)	The default implementation only checks whether the provided file is an actual file and whether it exists (if m_OutputIsFile is TRUE).
boolean	write(T[] data)	Performs checks and writes the data.
boolean	writeData(T data)	Performs the actual writing.
protected abstract 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, getFormatDescription, getFormatExtensions, getOutput, getWriters, outputTipText, reset, setOutput, shallowCopy, shallowCopy, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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.MultiReportWriter

getReportClass

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

getOutput, outputTipText, setOutput, write

Constructor Detail

AbstractMultiReportWriter

public AbstractMultiReportWriter()

Method Detail

write

public boolean write(T[] data)

Performs checks and writes the data.

Specified by:

write in interface MultiReportWriter<T extends Report>

Parameters:

data - the data to write

Returns:

true if successfully written

checkData

protected void checkData(T[] data)

The default implementation only checks whether the provided file is an actual file and whether it exists (if m_OutputIsFile is TRUE). Otherwise the directory has to exist.

Parameters:

data - the data to write

writeData

protected abstract boolean writeData(T[] data)

Performs the actual writing.

Parameters:

data - the data to write

Returns:

true if successfully written

writeData

public 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