Package adams.data.io.output

Class AbstractParameterMapWriter

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.io.output.AbstractParameterMapWriter

All Implemented Interfaces:

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

Direct Known Subclasses:

JsonParameterMapWriter, SerializedParameterMapWriter, YamlParameterMapWriter

public abstract class AbstractParameterMapWriter
extends AbstractOptionHandler
implements FileFormatHandler

Ancestor for classes that write 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
AbstractParameterMapWriter()

Method Summary

Modifier and Type	Method	Description
protected String	check(PlaceholderFile output)	Hook method for performing checks.
protected abstract void	doWrite(Map<String,Object> params, PlaceholderFile output)	Reads the parameters from the file.
void	write(Map<String,Object> params, PlaceholderFile output)	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

AbstractParameterMapWriter

public AbstractParameterMapWriter()

Method Detail

check

protected String check(PlaceholderFile output)

Hook method for performing checks.

Parameters:

output - the output file to read

Returns:

null if checks passed, otherwise error message

doWrite

protected abstract void doWrite(Map<String,Object> params,
                                PlaceholderFile output)
                         throws Exception

Reads the parameters from the file.

Parameters:

params - the parameters to write

output - the output file to write to

Throws:

Exception - if reading fails

write

public void write(Map<String,Object> params,
                  PlaceholderFile output)
           throws Exception

Reads the parameters from the file.

Parameters:

params - the parameters to write

output - the output file to write to

Throws:

Exception - if writing fails