AbstractColorPalette (adams-addons-pom 24.10.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.transformer.wordcloud.AbstractColorPalette

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, Serializable

Direct Known Subclasses:

ColorListPalette, DefaultColorPalette, LinearGradientColorPalette
```
public abstract class AbstractColorPalette
extends adams.core.option.AbstractOptionHandler
```
Ancestor for schemes that generate color palettes.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected adams.core.base.BaseColor[] m_ColorPalette
the color palette to use.
- 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

AbstractColorPalette()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`abstract com.kennycason.kumo.palette.ColorPalette`	`generate(adams.core.MessageCollection errors)`	Generates the color palette.

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_ColorPalette
```
protected adams.core.base.BaseColor[] m_ColorPalette
```
    the color palette to use.
- Constructor Detail
  - AbstractColorPalette
```
public AbstractColorPalette()
```
- Method Detail
  - generate
```
public abstract com.kennycason.kumo.palette.ColorPalette generate(adams.core.MessageCollection errors)
```
    Generates the color palette.
    
    Parameters:
    
    errors - for collecting errors
    
    Returns:
    
    the color palette, null if none generated