Package adams.flow.source.newlist

Class AbstractListGenerator

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.newlist.AbstractListGenerator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractListGenerator>, SizeOfHandler, Serializable

Direct Known Subclasses:

FixedList, ForLoop, Wrapper

public abstract class AbstractListGenerator
extends AbstractOptionHandler
implements QuickInfoSupporter, ShallowCopySupporter<AbstractListGenerator>

Ancestor for list generators.

Version:

$Revision$

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

Method Summary

Modifier and Type	Method	Description
protected void	check()	Hook method for checks.
protected abstract List<String>	doGenerate()	Generates the actual list.
List<String>	generate()	Generates the list.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
AbstractListGenerator	shallowCopy()	Returns a shallow copy of itself, i.e., based on the commandline options.
AbstractListGenerator	shallowCopy(boolean expand)	Returns a shallow copy of itself, i.e., based on the commandline options.

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

AbstractListGenerator

public AbstractListGenerator()

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()
              throws Exception

Hook method for checks.

Default implementation does nothing.

Throws:

Exception - if check fails

doGenerate

protected abstract List<String> doGenerate()
                                    throws Exception

Generates the actual list.

Returns:

the list of elements

Throws:

Exception - if generation fails

generate

public List<String> generate()
                      throws Exception

Generates the list.

Returns:

the list of elements

Throws:

Exception - if check or generation fails

shallowCopy

public AbstractListGenerator shallowCopy()

Returns a shallow copy of itself, i.e., based on the commandline options.

Specified by:

shallowCopy in interface ShallowCopySupporter<AbstractListGenerator>

Returns:

the shallow copy

shallowCopy

public AbstractListGenerator shallowCopy(boolean expand)

Returns a shallow copy of itself, i.e., based on the commandline options.

Specified by:

shallowCopy in interface ShallowCopySupporter<AbstractListGenerator>

Parameters:

expand - whether to expand variables to their current values

Returns:

the shallow copy