AbstractDatasetGenerator (adams-pom 25.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.visualization.xchart.dataset.AbstractDatasetGenerator<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

XYDatasetGenerator
```
public abstract class AbstractDatasetGenerator<T extends Dataset>
extends AbstractOptionHandler
implements QuickInfoSupporter
```
Ancestor for dataset generators.

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

AbstractDatasetGenerator()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`check(SpreadSheet data)`	Hook method for checks before generating the dataset.
`protected abstract Datasets<T>`	`doGenerate(SpreadSheet data)`	Performs the actual generation of the dataset.
`Datasets<T>`	`generate(SpreadSheet data)`	Generates the dataset.
`abstract Class<? extends Dataset>`	`generates()`	Returns the class of dataset that it generates.
`String`	`getQuickInfo()`	Returns a quick info about the object, which can be displayed in the GUI.

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
  - AbstractDatasetGenerator
```
public AbstractDatasetGenerator()
```
- Method Detail
  - getQuickInfo
```
public String getQuickInfo()
```
    Returns a quick info about the object, which can be displayed in the GUI.
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Returns:
    
    null if no info available, otherwise short string
  - generates
```
public abstract Class<? extends Dataset> generates()
```
    Returns the class of dataset that it generates.
    
    Returns:
    
    the dataset class
  - check
```
protected String check(SpreadSheet data)
```
    Hook method for checks before generating the dataset.
    
    Parameters:
    
    data - the data to use
    
    Returns:
    
    null if checks passed, otherwise error message
  - doGenerate
```
protected abstract Datasets<T> doGenerate(SpreadSheet data)
```
    Performs the actual generation of the dataset.
    
    Parameters:
    
    data - the data to use
    
    Returns:
    
    the dataset(s)
  - generate
```
public Datasets<T> generate(SpreadSheet data)
```
    Generates the dataset.
    
    Parameters:
    
    data - the data to use
    
    Returns:
    
    the dataset(s)