Package adams.data.io.output

Class NestedAdamsExperimentWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractAdamsExperimentWriter

adams.data.io.output.NestedAdamsExperimentWriter

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.FileFormatHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

public class NestedAdamsExperimentWriter
extends AbstractAdamsExperimentWriter

Writes ADAMS experiments in nested format. Does not store the results.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
protected String	doWrite(adams.core.io.PlaceholderFile file, AbstractExperiment exp)	Performs the actual writing of the experiment file.
AbstractAdamsExperimentReader	getCorrespondingReader()	Returns, if available, the corresponding reader.
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.

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

check, getDefaultFormatExtension, getWriters, isAvailable, write

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

Constructor Detail

NestedAdamsExperimentWriter

public NestedAdamsExperimentWriter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.io.FileFormatHandler

Specified by:

getFormatDescription in class AbstractAdamsExperimentWriter

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 adams.core.io.FileFormatHandler

Specified by:

getFormatExtensions in class AbstractAdamsExperimentWriter

Returns:

the extension (without the dot!)

getCorrespondingReader

public AbstractAdamsExperimentReader getCorrespondingReader()

Returns, if available, the corresponding reader.

Specified by:

getCorrespondingReader in class AbstractAdamsExperimentWriter

Returns:

the reader, null if none available

doWrite

protected String doWrite(adams.core.io.PlaceholderFile file,
                         AbstractExperiment exp)

Performs the actual writing of the experiment file.

Specified by:

doWrite in class AbstractAdamsExperimentWriter

Parameters:

file - the file to write to

exp - the experiment to write

Returns:

null if successfully written, otherwise error message