Package adams.flow.core

Class CleanerModelLoader

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractModelLoader<AbstractCleaner>

adams.flow.core.CleanerModelLoader

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.io.ModelFileHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.flow.core.FlowContextHandler, adams.flow.core.ModelLoaderSupporter, Serializable

public class CleanerModelLoader
extends adams.flow.core.AbstractModelLoader<AbstractCleaner>

Model loader for AbstractCleaner objects.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.flow.core.AbstractModelLoader

adams.flow.core.AbstractModelLoader.ModelLoadingType

Field Summary

Fields inherited from class adams.flow.core.AbstractModelLoader

m_FlowContext, m_Helper, m_Model, m_ModelActor, m_ModelFile, m_ModelLoadingType, m_ModelStorage

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

Method Summary

Modifier and Type	Method	Description
protected Object	deserializeFile(adams.core.MessageCollection errors)	Deserializes the model file.
protected AbstractCleaner	getModelFromContainer(adams.flow.container.AbstractContainer cont, adams.core.MessageCollection errors)	Retrieves the model from the container.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.flow.core.AbstractModelLoader

automaticOrderInfo, defineOptions, getFlowContext, getModel, getModelActor, getModelFile, getModelLoadingType, getModelStorage, getQuickInfo, getQuickInfo, initialize, loadAutomatically, loadFromCallableActor, loadFromFile, loadFromStorage, modelActorTipText, modelFileTipText, modelLoadingTypeTipText, modelStorageTipText, reset, setFlowContext, setModelActor, setModelFile, setModelLoadingType, setModelStorage, unhandledContainer, unwrapModel

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

CleanerModelLoader

public CleanerModelLoader()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

deserializeFile

protected Object deserializeFile(adams.core.MessageCollection errors)

Deserializes the model file.

Overrides:

deserializeFile in class adams.flow.core.AbstractModelLoader<AbstractCleaner>

Parameters:

errors - for collecting errors

Returns:

the object read from the file, null if failed

getModelFromContainer

protected AbstractCleaner getModelFromContainer(adams.flow.container.AbstractContainer cont,
                                                adams.core.MessageCollection errors)

Retrieves the model from the container.

Specified by:

getModelFromContainer in class adams.flow.core.AbstractModelLoader<AbstractCleaner>

Parameters:

cont - the container to get the model from

errors - for collecting errors

Returns:

the model, null if not in container