Package adams.flow.generator

Class Template

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.generator.AbstractFlowGenerator

adams.flow.generator.Template

All Implemented Interfaces:

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

public class Template
extends AbstractFlowGenerator

Uses the specified flow template to generate the sub-flow.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to 
    the console (0 = off).
    default: 0
    minimum: 0
 

-template <adams.flow.template.AbstractActorTemplate> (property: template)
    The template to use for generating the actual actor.
    default: adams.flow.template.DummyStandalone
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractActorTemplate	m_Template	the template.

Fields inherited from class adams.flow.generator.AbstractFlowGenerator

m_Owner

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Actor	doGenerate()	Generates the flow.
protected AbstractActorTemplate	getDefaultTemplate()	Returns the default template to use.
AbstractActorTemplate	getTemplate()	Returns the name of the global actor in use.
String	globalInfo()	Returns a string describing the object.
void	setTemplate(AbstractActorTemplate value)	Sets the name of the global actor to use.
String	templateTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.generator.AbstractFlowGenerator

check, generate, getOwner, setOwner

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_Template

protected AbstractActorTemplate m_Template

the template.

Constructor Detail

Template

public Template()

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

getDefaultTemplate

protected AbstractActorTemplate getDefaultTemplate()

Returns the default template to use.

Returns:

the template

setTemplate

public void setTemplate(AbstractActorTemplate value)

Sets the name of the global actor to use.

Parameters:

value - the global name

getTemplate

public AbstractActorTemplate getTemplate()

Returns the name of the global actor in use.

Returns:

the global name

templateTipText

public String templateTipText()

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 Actor doGenerate()

Generates the flow.

Specified by:

doGenerate in class AbstractFlowGenerator

Returns:

the flow