Package adams.flow.standalone.loadvariables

Class AbstractFileBasedVariableLoader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.loadvariables.AbstractVariableLoader

adams.flow.standalone.loadvariables.AbstractFileBasedVariableLoader

All Implemented Interfaces:

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

Direct Known Subclasses:

FromJson, FromProperties, FromSpreadSheet, FromYaml

public abstract class AbstractFileBasedVariableLoader
extends AbstractVariableLoader

Ancestor for loaders that load the variables from files.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PlaceholderFile	m_InputFile	the file to process.

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

Method Summary

Modifier and Type	Method	Description
protected void	check(MessageCollection errors)	Checks whether the variables can be loaded.
void	defineOptions()	Adds options to the internal list of options.
PlaceholderFile	getInputFile()	Returns the input file to process.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	inputFileTipText()	Returns the tip text for this property.
void	setInputFile(PlaceholderFile value)	Sets the input file to process.

Methods inherited from class adams.flow.standalone.loadvariables.AbstractVariableLoader

doLoadVariables, loadVariables

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, 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, getOptionManager, toCommandLine

Field Detail

m_InputFile

protected PlaceholderFile m_InputFile

the file to process.

Constructor Detail

AbstractFileBasedVariableLoader

public AbstractFileBasedVariableLoader()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setInputFile

public void setInputFile(PlaceholderFile value)

Sets the input file to process.

Parameters:

value - the file

getInputFile

public PlaceholderFile getInputFile()

Returns the input file to process.

Returns:

the file

inputFileTipText

public String inputFileTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractVariableLoader

Returns:

null if no info available, otherwise short string

check

protected void check(MessageCollection errors)

Checks whether the variables can be loaded.

Overrides:

check in class AbstractVariableLoader

Parameters:

errors - for collecting errors