org.conqat.lib.commons.color

Class MultiColor

java.lang.Object

java.awt.Color

org.conqat.lib.commons.color.MultiColor

All Implemented Interfaces:

java.awt.Paint, java.awt.Transparency, java.io.Serializable

public class MultiColor
extends java.awt.Color

A multicolor manages an ordered color distribution, i.e. provides a list of colors with a count for these colors. Colors may be contained more than once. To be compatible with code that expects "plain" colors, we inherit from color and require a primary/dominant color to be determined for such code.

This class is designed to be immutable.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.awt.Color

black, BLACK, blue, BLUE, cyan, CYAN, DARK_GRAY, darkGray, gray, GRAY, green, GREEN, LIGHT_GRAY, lightGray, magenta, MAGENTA, orange, ORANGE, pink, PINK, red, RED, white, WHITE, yellow, YELLOW

Fields inherited from interface java.awt.Transparency

BITMASK, OPAQUE, TRANSLUCENT

Constructor Summary

Constructors

Constructor and Description
MultiColor(java.awt.Color primaryColor, PairList<java.awt.Color,java.lang.Integer> colorDistribution) Constructor.

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getColor(int index) Returns the color at the given index.
int	getFrequency(int index) Returns the absolute frequency of the color at the given index.
double	getRelativeFrequency(int index) Returns the relative frequency of the color at the given index.
int	size() Returns the number of colors in the distribution.

Methods inherited from class java.awt.Color

brighter, createContext, darker, decode, equals, getAlpha, getBlue, getColor, getColor, getColor, getColorComponents, getColorComponents, getColorSpace, getComponents, getComponents, getGreen, getHSBColor, getRed, getRGB, getRGBColorComponents, getRGBComponents, getTransparency, hashCode, HSBtoRGB, RGBtoHSB, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MultiColor

public MultiColor(java.awt.Color primaryColor,
                  PairList<java.awt.Color,java.lang.Integer> colorDistribution)

Constructor.

Parameters:

primaryColor - the primary color passed to code that does not support multi colors.

colorDistribution - the color distribution. All entries must have a positive integer and the list may not be empty.

Method Detail

size

public int size()

Returns the number of colors in the distribution. This corresponds to the number of (color, int) pairs and does not necessarily count distinct colors.

getColor

public java.awt.Color getColor(int index)

Returns the color at the given index.

getFrequency

public int getFrequency(int index)

Returns the absolute frequency of the color at the given index.

getRelativeFrequency

public double getRelativeFrequency(int index)

Returns the relative frequency of the color at the given index.