org.orbisgis.legend.thematic.recode

Class AbstractRecodedLegend<U extends SymbolParameters>

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

org.orbisgis.legend.thematic.map.MappedLegend<String,U>

org.orbisgis.legend.thematic.recode.AbstractRecodedLegend<U>

All Implemented Interfaces:

Map<String,U>, Legend, LegendStructure, LookupFieldName, RecodedLegendStructure, StrokeUom

Direct Known Subclasses:

RecodedArea, RecodedLine, RecodedPoint

public abstract class AbstractRecodedLegend<U extends SymbolParameters>
extends MappedLegend<String,U>
implements RecodedLegendStructure

Common base for all the legends describing unique value analysis. It provides useful method to globally manage some parameters, like the field name on which the analysis is made.

Methods provided here will rely on the visitor pattern implemented in RecodedLegend instances as much as possible.

Author:

alexis

Nested Class Summary

Nested classes/interfaces inherited from class org.orbisgis.legend.thematic.map.MappedLegend

MappedLegend.MappedLegendEntry, MappedLegend.NumComparator

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AbstractRecodedLegend()

Method Summary

Methods

Modifier and Type	Method and Description
void	applyGlobalVisitor(ParameterVisitor pv) Apply the given visitor to all the Legend that are used in this MappedLegend.
void	applyGlobalVisitor(RecodedParameterVisitor rpv) Apply the given visitor to all the RecodedLegend that are used in this AbstractRecodedLegend.
static Comparator<String>	getComparator(int type) Gets a comparator well-suited for the given type
String	getNotUsedKey(String orig) Search in this recoded legend for a key that is not already used, based on the String given in argument.

Methods inherited from class org.orbisgis.legend.thematic.map.MappedLegend

clear, containsKey, containsValue, entrySet, equals, getFallbackParameters, getLookupFieldName, isEmpty, keySet, putAll, setComparator, setFallbackParameters, setLookupFieldName, size, values

Methods inherited from class org.orbisgis.legend.thematic.SymbolizerLegend

getLegendTypeId, getMaxScale, getMinScale, getName, setMaxScale, setMinScale, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orbisgis.legend.structure.recode.RecodedLegendStructure

getRecodedLegends

Methods inherited from interface java.util.Map

get, hashCode, put, remove

Methods inherited from interface org.orbisgis.legend.Legend

getLegendTypeName, getSymbolizer

Methods inherited from interface org.orbisgis.legend.thematic.uom.StrokeUom

getStrokeUom, setStrokeUom

Constructor Detail

AbstractRecodedLegend

public AbstractRecodedLegend()

Method Detail

applyGlobalVisitor

public void applyGlobalVisitor(ParameterVisitor pv)

Description copied from class: MappedLegend

Apply the given visitor to all the Legend that are used in this MappedLegend.

Specified by:

applyGlobalVisitor in class MappedLegend<String,U extends SymbolParameters>

Parameters:

pv - The visitor that will be used in each inner MappedLegend.

applyGlobalVisitor

public void applyGlobalVisitor(RecodedParameterVisitor rpv)

Apply the given visitor to all the RecodedLegend that are used in this AbstractRecodedLegend.

Parameters:

rpv - The visitor that will be used in each inner RecodedLegend.

getNotUsedKey

public String getNotUsedKey(String orig)

Search in this recoded legend for a key that is not already used, based on the String given in argument.

Specified by:

getNotUsedKey in class MappedLegend<String,U extends SymbolParameters>

Parameters:

orig - The original String

Returns:

base+n if base is empty or already in use, where n is the smaller positive integer so that base+n is not an already used key. base if it is not already a key of this map.

getComparator

public static Comparator<String> getComparator(int type)

Gets a comparator well-suited for the given type

Parameters:

type - The input type of Types

Returns:

The well-suited separator