AbstractFilenameGenerator (adams-pom 24.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.core.io.AbstractFilenameGenerator

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractFilenameGeneratorWithDirectory, NullFilenameGenerator, ReportFieldFilenameGenerator, SimpleFixedFilenameGenerator, SimpleObjectToStringFilenameGenerator
```
public abstract class AbstractFilenameGenerator
extends AbstractOptionHandler
implements QuickInfoSupporter
```
Ancestor for filename generators.

Version:

$Revision$

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

AbstractFilenameGenerator()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract boolean`	`canHandleNullObject()`	Returns whether we actually need an object to generate the filename.
`protected void`	`check(Object obj)`	Performs checks on the object to generate the filename for.
`protected abstract String`	`doGenerate(Object obj)`	Performs the actual generation of the filename.
`String`	`generate(Object obj)`	Generates a filename for the object.
`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
  - AbstractFilenameGenerator
```
public AbstractFilenameGenerator()
```
- 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
  - canHandleNullObject
```
public abstract boolean canHandleNullObject()
```
    Returns whether we actually need an object to generate the filename.
    
    Returns:
    
    true if object required
  - check
```
protected void check(Object obj)
```
    Performs checks on the object to generate the filename for.
    
    Default implementation only checks whether object is null (if one is required).
    
    Parameters:
    
    obj - the object to check
  - doGenerate
```
protected abstract String doGenerate(Object obj)
```
    Performs the actual generation of the filename.
    
    Parameters:
    
    obj - the object to generate the filename for
    
    Returns:
    
    the generated filename
  - generate
```
public String generate(Object obj)
```
    Generates a filename for the object.
    
    Parameters:
    
    obj - the object to generate the filename for
    
    Returns:
    
    the generated filename