Package adams.flow.standalone.loadvariables

Class AbstractVariableLoader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.loadvariables.AbstractVariableLoader

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, VariableLoader, Serializable

Direct Known Subclasses:

AbstractFileBasedVariableLoader, Null

public abstract class AbstractVariableLoader
extends AbstractOptionHandler
implements VariableLoader

Ancestor for variable loaders.

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

Method Summary

Modifier and Type	Method	Description
protected void	check(MessageCollection errors)	Checks whether the variables can be loaded.
protected abstract Variables	doLoadVariables(MessageCollection errors)	Loads the variables.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
Variables	loadVariables(MessageCollection errors)	Loads the variables.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, toCommandLine, toString

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Constructor Detail

AbstractVariableLoader

public AbstractVariableLoader()

Method Detail

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Returns:

null if no info available, otherwise short string

check

protected void check(MessageCollection errors)

Checks whether the variables can be loaded.

Parameters:

errors - for collecting errors

doLoadVariables

protected abstract Variables doLoadVariables(MessageCollection errors)

Loads the variables.

Parameters:

errors - for collecting errors

Returns:

the variables

loadVariables

public Variables loadVariables(MessageCollection errors)

Loads the variables.

Specified by:

loadVariables in interface VariableLoader

Parameters:

errors - for collecting errors

Returns:

the variables, null if failed to load