Package adams.data.io.input

Class NestedAdamsExperimentReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractAdamsExperimentReader

adams.data.io.input.NestedAdamsExperimentReader

All Implemented Interfaces:

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

public class NestedAdamsExperimentReader
extends AbstractAdamsExperimentReader
implements adams.core.io.EncodingSupporter

Reads ADAMS Experiments in nested format.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.base.BaseCharset	m_Encoding	the encoding to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected AbstractExperiment	doRead(adams.core.io.PlaceholderFile file)	Performs the actual reading of the experiment file.
String	encodingTipText()	Returns the tip text for this property.
AbstractAdamsExperimentWriter	getCorrespondingWriter()	Returns, if available, the corresponding writer.
adams.core.base.BaseCharset	getEncoding()	Returns the encoding to use.
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.
void	setEncoding(adams.core.base.BaseCharset value)	Sets the encoding to use.

Methods inherited from class adams.data.io.input.AbstractAdamsExperimentReader

check, getDefaultFormatExtension, getReaders, isAvailable, read

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Field Detail

m_Encoding

protected adams.core.base.BaseCharset m_Encoding

the encoding to use.

Constructor Detail

NestedAdamsExperimentReader

public NestedAdamsExperimentReader()

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 AbstractAdamsExperimentReader

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 AbstractAdamsExperimentReader

Returns:

the extension (without the dot!)

getCorrespondingWriter

public AbstractAdamsExperimentWriter getCorrespondingWriter()

Returns, if available, the corresponding writer.

Specified by:

getCorrespondingWriter in class AbstractAdamsExperimentReader

Returns:

the writer, null if none available

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setEncoding

public void setEncoding(adams.core.base.BaseCharset value)

Sets the encoding to use.

Specified by:

setEncoding in interface adams.core.io.EncodingSupporter

Parameters:

value - the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

getEncoding

public adams.core.base.BaseCharset getEncoding()

Returns the encoding to use.

Specified by:

getEncoding in interface adams.core.io.EncodingSupporter

Returns:

the encoding, e.g. "UTF-8" or "UTF-16", empty string for default

encodingTipText

public String encodingTipText()

Returns the tip text for this property.

Specified by:

encodingTipText in interface adams.core.io.EncodingSupporter

Returns:

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

doRead

protected AbstractExperiment doRead(adams.core.io.PlaceholderFile file)

Performs the actual reading of the experiment file.

Specified by:

doRead in class AbstractAdamsExperimentReader

Parameters:

file - the file to read

Returns:

the experiment, null if failed to read