Package adams.data.io.input

Class AbstractIndexedSplitsRunsReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractIndexedSplitsRunsReader

All Implemented Interfaces:

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

Direct Known Subclasses:

JsonIndexedSplitsRunsReader, PropertiesIndexedSplitsRunsReader

public abstract class AbstractIndexedSplitsRunsReader
extends AbstractOptionHandler
implements FileFormatHandler

Ancestor for readers that load files containing IndexedSplitsRuns.

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

Method Summary

Modifier and Type	Method	Description
protected abstract IndexedSplitsRuns	doRead(Reader reader, MessageCollection errors)	Reads the split definitions from the specified reader.
IndexedSplitsRuns	read(File file, MessageCollection errors)	Reads the split definitions from the specified file.
IndexedSplitsRuns	read(Reader reader, MessageCollection errors)	Reads the split definitions from the specified reader.

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

getDefaultFormatExtension, getFormatDescription, getFormatExtensions

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractIndexedSplitsRunsReader

public AbstractIndexedSplitsRunsReader()

Method Detail

doRead

protected abstract IndexedSplitsRuns doRead(Reader reader,
                                            MessageCollection errors)

Reads the split definitions from the specified reader. The caller must close the reader object.

Parameters:

reader - the reader to read from

errors - for storing errors

Returns:

the definitions or null in case of an error

read

public IndexedSplitsRuns read(Reader reader,
                              MessageCollection errors)

Reads the split definitions from the specified reader. The caller must close the reader object.

Parameters:

reader - the reader to read from

errors - for storing errors

Returns:

the definitions or null in case of an error

read

public IndexedSplitsRuns read(File file,
                              MessageCollection errors)

Reads the split definitions from the specified file.

Parameters:

file - the file to read

errors - for storing errors

Returns:

the definitions or null in case of an error