AbstractFileBasedDatasetGeneration (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.transformer.generatefilebaseddataset.AbstractFileBasedDatasetGeneration<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

SimpleFileList
```
public abstract class AbstractFileBasedDatasetGeneration<T>
extends AbstractOptionHandler
implements QuickInfoSupporter
```
Ancestor for schemes that generate datasets.

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

AbstractFileBasedDatasetGeneration()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`check(FileBasedDatasetContainer cont)`	Performs checks on the container.
`protected abstract T`	`doGenerate(FileBasedDatasetContainer cont)`	Generates the dataset.
`T`	`generate(FileBasedDatasetContainer cont)`	Generates the dataset.
`abstract Class`	`generates()`	Returns the class that gets generated.
`String`	`getQuickInfo()`	Returns a quick info about the object, which can be displayed in the GUI.
`protected abstract String[]`	`requiredValues()`	The keys of the values that need to be present in the container.

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
  - AbstractFileBasedDatasetGeneration
```
public AbstractFileBasedDatasetGeneration()
```
- 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
  - generates
```
public abstract Class generates()
```
    Returns the class that gets generated.
    
    Returns:
    
    the generated class
  - requiredValues
```
protected abstract String[] requiredValues()
```
    The keys of the values that need to be present in the container.
    
    Returns:
    
    the keys
  - check
```
protected String check(FileBasedDatasetContainer cont)
```
    Performs checks on the container.
    
    Parameters:
    
    cont - the container to check
    
    Returns:
    
    null if successful, otherwise error message
  - doGenerate
```
protected abstract T doGenerate(FileBasedDatasetContainer cont)
```
    Generates the dataset.
    
    Parameters:
    
    cont - the container to use
    
    Returns:
    
    the generated output
  - generate
```
public T generate(FileBasedDatasetContainer cont)
```
    Generates the dataset.
    
    Parameters:
    
    cont - the container to use
    
    Returns:
    
    the generated output