Package adams.data.io.input

Class AbstractParameterMapReader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.input.AbstractParameterMapReader

All Implemented Interfaces:

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

Direct Known Subclasses:

JsonParameterMapReader, SerializedParameterMapReader, YamlParameterMapReader

public abstract class AbstractParameterMapReader
extends AbstractOptionHandler
implements FileFormatHandler

Ancestor for classes that read parameter maps.

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

Method Summary

Modifier and Type	Method	Description
protected String	check(PlaceholderFile input)	Hook method for performing checks.
protected abstract Map<String,Object>	doRead(PlaceholderFile input)	Reads the parameters from the file.
Map<String,Object>	read(PlaceholderFile input)	Reads the parameters from the 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.io.FileFormatHandler

getDefaultFormatExtension, getFormatDescription, getFormatExtensions

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractParameterMapReader

public AbstractParameterMapReader()

Method Detail

check

protected String check(PlaceholderFile input)

Hook method for performing checks.

Parameters:

input - the input file to read

Returns:

null if checks passed, otherwise error message

doRead

protected abstract Map<String,Object> doRead(PlaceholderFile input)
                                            throws Exception

Reads the parameters from the file.

Parameters:

input - the input file to read

Returns:

the parameters that were read

Throws:

Exception - if reading fails

read

public Map<String,Object> read(PlaceholderFile input)
                              throws Exception

Reads the parameters from the file.

Parameters:

input - the input file to read

Returns:

the parameters that were read

Throws:

Exception - if reading fails