Package adams.flow.transformer.preparefilebaseddataset

Class AbstractFileBasedDatasetPreparation<T>

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.preparefilebaseddataset.AbstractFileBasedDatasetPreparation<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractRandomizableFileBasedDatasetPreparation, Selected

public abstract class AbstractFileBasedDatasetPreparation<T>
extends AbstractOptionHandler
implements QuickInfoSupporter

Ancestor for schemes that prepare file-based datasets.

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

Method Summary

Modifier and Type	Method	Description
abstract Class	accepts()	Returns the class that the preparation scheme accepts as input.
protected String	check(T data)	Hook method for checking the data.
protected abstract List<FileBasedDatasetContainer>	doPrepare(T data)	Prepares the data.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
List<FileBasedDatasetContainer>	prepare(T data)	Prepares the data.

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.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

AbstractFileBasedDatasetPreparation

public AbstractFileBasedDatasetPreparation()

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

accepts

public abstract Class accepts()

Returns the class that the preparation scheme accepts as input.

Returns:

the class

check

protected String check(T data)

Hook method for checking the data.
Default implementation just returns null.

Parameters:

data - the data to check

Returns:

null if succesful, otherwise error message

doPrepare

protected abstract List<FileBasedDatasetContainer> doPrepare(T data)

Prepares the data.

Parameters:

data - the data to use

Returns:

the generated container(s)

prepare

public List<FileBasedDatasetContainer> prepare(T data)

Prepares the data.

Parameters:

data - the data to use

Returns:

the generated container(s)