org.orbisgis.legend.structure.categorize

Class CategorizedColor

java.lang.Object

org.orbisgis.legend.structure.parameter.AbstractAttributeLegend

org.orbisgis.legend.structure.categorize.CategorizedLegend<Color>

org.orbisgis.legend.structure.categorize.CategorizedColor

All Implemented Interfaces:

LegendStructure, LookupFieldName, ParameterLegend

public class CategorizedColor
extends CategorizedLegend<Color>

Author:

Alexis Guéganno

Field Summary

Fields inherited from class org.orbisgis.legend.structure.categorize.CategorizedLegend

field

Constructor Summary

Constructors

Constructor and Description
CategorizedColor(ColorParameter sp) Build a CategorizedColor from the given ColorParameter.

Method Summary

Methods

Modifier and Type	Method and Description
Color	get(Double d) Gets the U value associated to the key d.
Color	getFallbackValue() Gets the value obtained when the input data can't be processed for whatever reason.
Color	getFromLower(Double d) Gets the value associated to d, if any, or to the lower threshold.
SeParameter	getParameter() Gets the SeParameter that had been used to build this LegendStructure.
void	put(Double d, Color v) Put the couple (d,v) in this categorization.
Color	remove(Double d) Removes the mapping associated to d, if it exists and if it does not let the mapping empty.
void	setFallbackValue(Color value) Sets the value obtained when the input data can't be processed for whatever reason.
void	setParameter(ColorParameter param) Replaces the inner ColorParameter with the given one.

Methods inherited from class org.orbisgis.legend.structure.categorize.CategorizedLegend

acceptVisitor, addListener, fireTypeChanged, getField, getKeys, getLookupFieldName, getValueReference, setField, setLookupFieldName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CategorizedColor

public CategorizedColor(ColorParameter sp)

Build a CategorizedColor from the given ColorParameter.

Parameters:

sp - The input parameter.

Method Detail

getParameter

public SeParameter getParameter()

Description copied from interface: ParameterLegend

Gets the SeParameter that had been used to build this LegendStructure.

Returns:

setParameter

public void setParameter(ColorParameter param)

Replaces the inner ColorParameter with the given one. param must either be a literal or a Categorize2Color whose lookup value is a simple RealAttribute

Parameters:

param - The new inner ColorParameter used in this CategorizedColor.

Throws:

IllegalArgumentException - if param can't be used to build a valid CategorizedColor

getFallbackValue

public Color getFallbackValue()

Gets the value obtained when the input data can't be processed for whatever reason.

Returns:

The value directly as a Color.

setFallbackValue

public void setFallbackValue(Color value)

Sets the value obtained when the input data can't be processed for whatever reason.

Parameters:

value - The new fallback value.

get

public Color get(Double d)

Description copied from class: CategorizedLegend

Gets the U value associated to the key d. If d is not a valid key in the underlying mapping, this method returns null.

Specified by:

get in class CategorizedLegend<Color>

Parameters:

d - The key whose associated value is wanted

Returns:

The value associated to d or null if d is not a valid key.

put

public void put(Double d,
       Color v)

Description copied from class: CategorizedLegend

Put the couple (d,v) in this categorization.

Specified by:

put in class CategorizedLegend<Color>

Parameters:

d - The key

v - The value

remove

public Color remove(Double d)

Description copied from class: CategorizedLegend

Removes the mapping associated to d, if it exists and if it does not let the mapping empty.

Specified by:

remove in class CategorizedLegend<Color>

Parameters:

d - The threshold we want to remove.

Returns:

The value of the removed mapping, if any.

getFromLower

public Color getFromLower(Double d)

Description copied from class: CategorizedLegend

Gets the value associated to d, if any, or to the lower threshold.

Specified by:

getFromLower in class CategorizedLegend<Color>

Returns:

The value associated to d in the mapping, if d is one of its keys. Otherwise, the returned value can be expressed as max( k in keys where k < d).