Package adams.data.io.input

Class SerializableObjectReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractObjectReader

adams.data.io.input.SerializableObjectReader

All Implemented Interfaces:

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

public class SerializableObjectReader
extends AbstractObjectReader
implements LenientModeSupporter

Loads a SerializableObject.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Lenient	whether to be lenient.

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
SerializableObjectReader()	Default constructor.
SerializableObjectReader(boolean lenient)	Initializes the reader with specified lenient mode.

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.
AbstractObjectWriter	getCorrespondingWriter()	Returns, if available, the corresponding writer.
String	getFormatDescription()	Returns a string describing the format (used in the file chooser).
String[]	getFormatExtensions()	Returns the extension(s) of the format.
boolean	getLenient()	Returns whether lenient, ie first tries to load the object as SerializableObject and if that fails just deserializes it.
String	globalInfo()	Returns a string describing the object.
String	lenientTipText()	Returns the tip text for this property.
void	setLenient(boolean value)	Sets whether lenient, ie first tries to load the object as SerializableObject and if that fails just deserializes it.

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_Lenient

protected boolean m_Lenient

whether to be lenient.

Constructor Detail

SerializableObjectReader

public SerializableObjectReader()

Default constructor.

SerializableObjectReader

public SerializableObjectReader(boolean lenient)

Initializes the reader with specified lenient mode.

Parameters:

lenient - whether to be lenient or not

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setLenient

public void setLenient(boolean value)

Sets whether lenient, ie first tries to load the object as SerializableObject and if that fails just deserializes it.

Specified by:

setLenient in interface LenientModeSupporter

Parameters:

value - true if lenient

getLenient

public boolean getLenient()

Returns whether lenient, ie first tries to load the object as SerializableObject and if that fails just deserializes it.

Specified by:

getLenient in interface LenientModeSupporter

Returns:

true if lenient

lenientTipText

public String lenientTipText()

Returns the tip text for this property.

Specified by:

lenientTipText in interface LenientModeSupporter

Returns:

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

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

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