Package adams.data.io.input

Class NestedCommandlineReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractObjectReader

adams.data.io.input.NestedCommandlineReader

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, EncodingSupporter, FileFormatHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class NestedCommandlineReader
extends AbstractObjectReader
implements EncodingSupporter

Loads objects using the commandline store in the file (nested format). Works only with ADAMS objects.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected 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
NestedCommandlineReader()

Method Summary

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

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

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

the encoding to use.

Constructor Detail

NestedCommandlineReader

public NestedCommandlineReader()

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 AbstractObjectReader

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 AbstractObjectReader

Returns:

the extension (without the dot!)

getCorrespondingWriter

public AbstractObjectWriter getCorrespondingWriter()

Returns, if available, the corresponding writer.

Specified by:

getCorrespondingWriter in class AbstractObjectReader

Returns:

the writer, null if none available

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setEncoding

public void setEncoding(BaseCharset value)

Sets the encoding to use.

Specified by:

setEncoding in interface EncodingSupporter

Parameters:

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

getEncoding

public BaseCharset getEncoding()

Returns the encoding to use.

Specified by:

getEncoding in interface 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 EncodingSupporter

Returns:

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

doRead

protected Object doRead(PlaceholderFile file)

Performs the actual reading of the object file.

Specified by:

doRead in class AbstractObjectReader

Parameters:

file - the file to read

Returns:

the object, null if failed to read