org.orbisgis.legend.structure.categorize

Class CategorizedLegend<U>

java.lang.Object

org.orbisgis.legend.structure.parameter.AbstractAttributeLegend

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

All Implemented Interfaces:

LegendStructure, LookupFieldName, ParameterLegend

Direct Known Subclasses:

CategorizedColor, CategorizedReal, CategorizedString

public abstract class CategorizedLegend<U>
extends AbstractAttributeLegend
implements ParameterLegend

Author:

alexis

Field Summary

Fields

Modifier and Type	Field and Description
protected String	field

Constructor Summary

Constructors

Constructor and Description
CategorizedLegend()

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptVisitor(CategorizedParameterVisitor cpv) Implementation of the visitor pattern.
void	addListener(TypeListener l) Adds a listener that will be notified when fireTypeChanged is called.
void	fireTypeChanged() Notifies that the actual type of the inner SeParameter has changed.
abstract U	get(Double d) Gets the U value associated to the key d.
String	getField() Gets the name of the field on which the analysis is performed.
abstract U	getFromLower(Double d) Gets the value associated to d, if any, or to the lower threshold.
Set<Double>	getKeys()
String	getLookupFieldName() Gets the field name.
ValueReference	getValueReference()
abstract void	put(Double d, U val) Put the couple (d,v) in this categorization.
abstract U	remove(Double d) Removes the mapping associated to d, if it exists and if it does not let the mapping empty.
void	setField(String field) Sets the name of the field on which the analysis is performed.
void	setLookupFieldName(String name) Sets the field name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orbisgis.legend.structure.parameter.ParameterLegend

getParameter

Field Detail

field

protected String field

Constructor Detail

CategorizedLegend

public CategorizedLegend()

Method Detail

getValueReference

public ValueReference getValueReference()

Specified by:

getValueReference in class AbstractAttributeLegend

getLookupFieldName

public String getLookupFieldName()

Description copied from interface: LookupFieldName

Gets the field name.

Specified by:

getLookupFieldName in interface LookupFieldName

Overrides:

getLookupFieldName in class AbstractAttributeLegend

Returns:

The field name

setLookupFieldName

public void setLookupFieldName(String name)

Description copied from interface: LookupFieldName

Sets the field name.

Specified by:

setLookupFieldName in interface LookupFieldName

Overrides:

setLookupFieldName in class AbstractAttributeLegend

Parameters:

name - Name

getField

public String getField()

Gets the name of the field on which the analysis is performed.

Returns:

The name of the analyzed field.

setField

public void setField(String field)

Sets the name of the field on which the analysis is performed.

Parameters:

field - The name of the analyzed field.

get

public abstract U get(Double d)

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

Parameters:

d - The key whose associated value is wanted

Returns:

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

remove

public abstract U remove(Double d)

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

Parameters:

d - The threshold we want to remove.

Returns:

The value of the removed mapping, if any.

Throws:

IllegalStateException - if, for whatever reason, one the key of the mapping appears not to be a literal.

put

public abstract void put(Double d,
       U val)

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

Parameters:

d - The key

val - The value

getFromLower

public abstract U getFromLower(Double d)

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

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

getKeys

public Set<Double> getKeys()

addListener

public void addListener(TypeListener l)

Adds a listener that will be notified when fireTypeChanged is called.

Parameters:

l - The listener that will be added.

fireTypeChanged

public void fireTypeChanged()

Notifies that the actual type of the inner SeParameter has changed.

acceptVisitor

public void acceptVisitor(CategorizedParameterVisitor cpv)

Implementation of the visitor pattern.

Parameters:

cpv - The external visitor.