Package adams.gui.visualization.sequence.metadatacolor

Class ColorPerLabel

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.sequence.metadatacolor.AbstractMetaDataColor<XYSequencePoint>

adams.gui.visualization.sequence.metadatacolor.ColorPerLabel

All Implemented Interfaces:

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

public class ColorPerLabel
extends AbstractMetaDataColor<XYSequencePoint>
implements ColorProviderHandler

Maintains an internal mapping between labels obtained from the meta-data (using the specified key) and colors obtained from the color provider.
Makes use of color providers that implement the adams.gui.visualization.core.ColorProviderWithNameSupport interface, supplying it with the label obtained from the meta-data.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-color-provider <adams.gui.visualization.core.ColorProvider> (property: colorProvider)
    The color provider to use.
    default: adams.gui.visualization.core.DefaultColorProvider
 

-meta-data-key <java.lang.String> (property: metaDataKey)
    The key in the meta-data to obtain the label from.
    default: 
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Color>	m_ColorMap	the mapping between labels and colors.
protected ColorProvider	m_ColorProvider	the color provider to use.
protected String	m_MetaDataKey	the meta-data key to use for obtaining the label.

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
ColorPerLabel()

Method Summary

Modifier and Type	Method	Description
String	colorProviderTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	determineLabel(XYSequencePoint point)	Determines the label for the point.
Color	getColor(XYSequencePoint point, Color defColor)	Extracts the color from the meta-data.
ColorProvider	getColorProvider()	Returns the color provider to use.
String	getMetaDataKey()	Returns the key in the meta-data to obtain the label from.
protected Color	getNextColor(String label)	Returns the next color for the label.
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
void	initialize(List<XYSequencePoint> points)	Initializes the meta-data color scheme.
String	metaDataKeyTipText()	Returns the tip text for this property.
protected void	reset()	Resets the mapping.
void	setColorProvider(ColorProvider value)	Sets the color provider to use.
void	setMetaDataKey(String value)	Sets the key in the meta-data to obtain the label from.

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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_ColorProvider

protected ColorProvider m_ColorProvider

the color provider to use.

m_MetaDataKey

protected String m_MetaDataKey

the meta-data key to use for obtaining the label.

m_ColorMap

protected Map<String,Color> m_ColorMap

the mapping between labels and colors.

Constructor Detail

ColorPerLabel

public ColorPerLabel()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractOptionHandler

reset

protected void reset()

Resets the mapping.

Overrides:

reset in class AbstractOptionHandler

setColorProvider

public void setColorProvider(ColorProvider value)

Sets the color provider to use.

Specified by:

setColorProvider in interface ColorProviderHandler

Parameters:

value - the provider

getColorProvider

public ColorProvider getColorProvider()

Returns the color provider to use.

Specified by:

getColorProvider in interface ColorProviderHandler

Returns:

the provider

colorProviderTipText

public String colorProviderTipText()

Returns the tip text for this property.

Specified by:

colorProviderTipText in interface ColorProviderHandler

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setMetaDataKey

public void setMetaDataKey(String value)

Sets the key in the meta-data to obtain the label from.

Parameters:

value - the key

getMetaDataKey

public String getMetaDataKey()

Returns the key in the meta-data to obtain the label from.

Returns:

the key

metaDataKeyTipText

public String metaDataKeyTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getNextColor

protected Color getNextColor(String label)

Returns the next color for the label.

Parameters:

label - the label to get the next color for

Returns:

the color

determineLabel

protected String determineLabel(XYSequencePoint point)

Determines the label for the point.

Parameters:

point - the point to get the label for

Returns:

the label, null if not available

initialize

public void initialize(List<XYSequencePoint> points)

Initializes the meta-data color scheme.

Specified by:

initialize in class AbstractMetaDataColor<XYSequencePoint>

Parameters:

points - the points to initialize with

getColor

public Color getColor(XYSequencePoint point,
                      Color defColor)

Extracts the color from the meta-data.

Specified by:

getColor in class AbstractMetaDataColor<XYSequencePoint>

Parameters:

point - the point to get the color from

defColor - the default color to use

Returns:

the color