AbstractFlowGenerator (adams-pom 24.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.generator.AbstractFlowGenerator<T>

Type Parameters:

T - the type of actor that owns this generator

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Generator<T>, Serializable

Direct Known Subclasses:

Template
```
public abstract class AbstractFlowGenerator<T extends Actor>
extends AbstractOptionHandler
implements Generator<T>
```
Ancestor for generators that use model setups to generate flows.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected T m_Owner
the 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

AbstractFlowGenerator()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`check()`	Hook method for checks before generating the flow.
`protected abstract Actor`	`doGenerate()`	Generates the flow.
`Actor`	`generate()`	Generates the flow and returns it.
`T`	`getOwner()`	Returns the owner.
`void`	`setOwner(T value)`	Sets the owner.

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

- Field Detail
  - m_Owner
```
protected T extends Actor m_Owner
```
    the owner.
- Constructor Detail
  - AbstractFlowGenerator
```
public AbstractFlowGenerator()
```
- Method Detail
  - setOwner
```
public void setOwner(T value)
```
    Sets the owner.
    
    Specified by:
    
    setOwner in interface Generator<T extends Actor>
    
    Parameters:
    
    value - the owner of this generator
  - getOwner
```
public T getOwner()
```
    Returns the owner.
    
    Specified by:
    
    getOwner in interface Generator<T extends Actor>
    
    Returns:
    
    the owner, null if none set
  - check
```
protected void check()
```
    Hook method for checks before generating the flow.
    
    Checks for owner.
  - doGenerate
```
protected abstract Actor doGenerate()
```
    Generates the flow.
    
    Returns:
    
    the flow
  - generate
```
public Actor generate()
```
    Generates the flow and returns it.
    
    Specified by:
    
    generate in interface Generator<T extends Actor>
    
    Returns:
    
    the generated flow