Package adams.flow.source.newlist

Class Wrapper

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.source.newlist.AbstractListGenerator

adams.flow.source.newlist.Wrapper

All Implemented Interfaces:

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

public class Wrapper
extends AbstractListGenerator

Wraps the list items produced by the specified generator with user-supplied prefix and suffix.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-generator <adams.flow.source.newlist.AbstractListGenerator> (property: generator)
    The list generator to use.
    default: adams.flow.source.newlist.FixedList
 

-prefix <java.lang.String> (property: prefix)
    The prefix to use.
    default: 
 

-suffix <java.lang.String> (property: suffix)
    The suffix to use.
    default: 
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractListGenerator	m_Generator	the generator to use.
protected String	m_Prefix	the prefix to use.
protected String	m_Suffix	the suffix to use.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected List<String>	doGenerate()	Generates the actual list.
String	generatorTipText()	Returns the tip text for this property.
AbstractListGenerator	getGenerator()	Returns the generator to use.
String	getPrefix()	Returns the prefix to use.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	getSuffix()	Returns the suffix to use.
String	globalInfo()	Returns a string describing the object.
String	prefixTipText()	Returns the tip text for this property.
void	setGenerator(AbstractListGenerator value)	Sets the generator to use.
void	setPrefix(String value)	Sets the prefix to use.
void	setSuffix(String value)	Sets the suffix to use.
String	suffixTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.source.newlist.AbstractListGenerator

check, generate, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

Field Detail

m_Generator

protected AbstractListGenerator m_Generator

the generator to use.

m_Prefix

protected String m_Prefix

the prefix to use.

m_Suffix

protected String m_Suffix

the suffix to use.

Constructor Detail

Wrapper

public Wrapper()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractListGenerator

Returns:

null if no info available, otherwise short string

setGenerator

public void setGenerator(AbstractListGenerator value)

Sets the generator to use.

Parameters:

value - the generator

getGenerator

public AbstractListGenerator getGenerator()

Returns the generator to use.

Returns:

the generator

generatorTipText

public String generatorTipText()

Returns the tip text for this property.

Returns:

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

setPrefix

public void setPrefix(String value)

Sets the prefix to use.

Parameters:

value - the prefix

getPrefix

public String getPrefix()

Returns the prefix to use.

Returns:

the prefix

prefixTipText

public String prefixTipText()

Returns the tip text for this property.

Returns:

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

setSuffix

public void setSuffix(String value)

Sets the suffix to use.

Parameters:

value - the suffix

getSuffix

public String getSuffix()

Returns the suffix to use.

Returns:

the suffix

suffixTipText

public String suffixTipText()

Returns the tip text for this property.

Returns:

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

doGenerate

protected List<String> doGenerate()
                           throws Exception

Generates the actual list.

Specified by:

doGenerate in class AbstractListGenerator

Returns:

the list of elements

Throws:

Exception - if generation fails