org.orbisgis.legend.structure.categorize

Class CategorizedReal

java.lang.Object

org.orbisgis.legend.structure.parameter.AbstractAttributeLegend

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

org.orbisgis.legend.structure.categorize.CategorizedReal

All Implemented Interfaces:

LegendStructure, LookupFieldName, ParameterLegend

public class CategorizedReal
extends CategorizedLegend<Double>

This class embeds a RealParameter that can be either a literal or a categorize. It is presented as a categorize whatever the inner parameter is really. The main goal is to provide a transparent way to manage complex interval classification without much pain while keeping the SE models simple.

Author:

Alexis Guéganno

Field Summary

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

field

Constructor Summary

Constructors

Constructor and Description
CategorizedReal(RealParameter sp) Build a CategorizedReal from the given RealParameter.

Method Summary

Methods

Modifier and Type	Method and Description
Double	get(Double d) Gets the U value associated to the key d.
Double	getFallbackValue() Gets the value obtained when the input data can't be processed for whatever reason.
Double	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, Double v) Put the couple (d,v) in this categorization.
Double	remove(Double d) Removes the mapping associated to d, if it exists and if it does not let the mapping empty.
void	setFallbackValue(Double value) Sets the value obtained when the input data can't be processed for whatever reason.
void	setParameter(RealParameter param) Replaces the inner RealParameter 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

CategorizedReal

public CategorizedReal(RealParameter sp)

Build a CategorizedReal from the given RealParameter.

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(RealParameter param)

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

Parameters:

param - The new inner RealParameter used in this CategorizedReal.

Throws:

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

getFallbackValue

public Double getFallbackValue()

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

Returns:

The value directly as a Real.

setFallbackValue

public void setFallbackValue(Double value)

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

Parameters:

value - The new fallback value.

get

public Double 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<Double>

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,
       Double v)

Description copied from class: CategorizedLegend

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

Specified by:

put in class CategorizedLegend<Double>

Parameters:

d - The key

v - The value

remove

public Double 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<Double>

Parameters:

d - The threshold we want to remove.

Returns:

The value of the removed mapping, if any.

getFromLower

public Double 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<Double>

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).