Package adams.data.io.input

Class AbstractObjectReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractObjectReader

All Implemented Interfaces:

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

Direct Known Subclasses:

CommandlineReader, NestedCommandlineReader, SerializableObjectReader, SerializedObjectReader, XStreamReader

public abstract class AbstractObjectReader
extends AbstractOptionHandler
implements FileFormatHandler

Ancestor for object readers.

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

Method Summary

Modifier and Type	Method	Description
protected void	check(PlaceholderFile file)	Performs checks.
protected abstract Object	doRead(PlaceholderFile file)	Performs the actual reading of the object file.
abstract AbstractObjectWriter	getCorrespondingWriter()	Returns, if available, the corresponding writer.
String	getDefaultFormatExtension()	Returns the default extension of the format.
abstract String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
abstract String[]	getFormatExtensions()	Returns the extension(s) of the format.
static String[]	getReaders()	Returns a list with classnames of readers.
boolean	isAvailable()	Returns whether the reader is actually available.
Object	read(PlaceholderFile file)	Reads the object file.

Methods inherited from class adams.core.option.AbstractOptionHandler

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

AbstractObjectReader

public AbstractObjectReader()

Method Detail

getFormatDescription

public abstract String getFormatDescription()

Returns a string describing the format (used in the file chooser).

Specified by:

getFormatDescription in interface FileFormatHandler

Returns:

a description suitable for displaying in the file chooser

getFormatExtensions

public abstract String[] getFormatExtensions()

Returns the extension(s) of the format.

Specified by:

getFormatExtensions in interface FileFormatHandler

Returns:

the extension (without the dot!)

getDefaultFormatExtension

public String getDefaultFormatExtension()

Returns the default extension of the format.

Specified by:

getDefaultFormatExtension in interface FileFormatHandler

Returns:

the default extension (without the dot!)

getCorrespondingWriter

public abstract AbstractObjectWriter getCorrespondingWriter()

Returns, if available, the corresponding writer.

Returns:

the writer, null if none available

isAvailable

public boolean isAvailable()

Returns whether the reader is actually available.

Returns:

true if available and ready to use

check

protected void check(PlaceholderFile file)

Performs checks.

Parameters:

file - the image file to check

doRead

protected abstract Object doRead(PlaceholderFile file)

Performs the actual reading of the object file.

Parameters:

file - the file to read

Returns:

the object, null if failed to read

read

public Object read(PlaceholderFile file)

Reads the object file.

Parameters:

file - the file to read

Returns:

the object, null if failed to read

getReaders

public static String[] getReaders()

Returns a list with classnames of readers.

Returns:

the reader classnames