org.orbisgis.legend.thematic.map

Class MappedLegend<T,U extends SymbolParameters>

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

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

All Implemented Interfaces:

Map<T,U>, Legend, LegendStructure, LookupFieldName, StrokeUom

Direct Known Subclasses:

AbstractCategorizedLegend, AbstractRecodedLegend

public abstract class MappedLegend<T,U extends SymbolParameters>
extends SymbolizerLegend
implements Map<T,U>, LookupFieldName

This abstract class gathers methods that will be common to instances of unique value classifications and interval classifications. It presents a mapping between the keys and configurations of the associated classification.

Author:

alexis

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	MappedLegend.MappedLegendEntry MapEntry dedicated to MappedLegend instances.
static class	MappedLegend.NumComparator This comparator intends to transform the input String instances to Double instances and to compare them thereafter.

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MappedLegend()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	applyGlobalVisitor(ParameterVisitor rpv) Apply the given visitor to all the Legend that are used in this MappedLegend.
void	clear() Removes all the entries in this classification.
boolean	containsKey(Object s) Checks whether s is a key of this mapping.
boolean	containsValue(Object lp) Checks if lp is a value contained in this MappedLegend
Set<Map.Entry<T,U>>	entrySet() Gets a Set representation of the key-value mapping we have in this MappedLegend.
boolean	equals(Object o)
abstract U	getFallbackParameters() Gets the configuration used to draw features we can't get a value for in the map in the style .
String	getLookupFieldName() Gets the field name.
abstract T	getNotUsedKey(T orig) Search in this legend for a key that is not already used.
boolean	isEmpty() Returns true if there is nothing in this map.
SortedSet<T>	keySet() Gets the keys currently used in the analysis.
void	putAll(Map<? extends T,? extends U> input) Put all the entries found in the given map as entries in this MappedLegend.
void	setComparator(Comparator<T> comp) Sets the comparator we want to use for elements ordering.
abstract void	setFallbackParameters(U fallback) Sets the fallback configuration according to the one given in argument.
void	setLookupFieldName(String field) Sets the field name.
int	size() Returns the number of elements contained in this classification.
Collection<U>	values() Gets all the LineParameters stored in this RecodedLine, default one excepted.

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

MappedLegend

public MappedLegend()

Method Detail

applyGlobalVisitor

public abstract void applyGlobalVisitor(ParameterVisitor rpv)

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

Parameters:

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

getNotUsedKey

public abstract T getNotUsedKey(T orig)

Search in this legend for a key that is not already used. If the given key is not already in use, it is returned. Otherwise, a new one is created.

Parameters:

orig - The original key on which to base the search

Returns:

An unused key

getLookupFieldName

public String getLookupFieldName()

Description copied from interface: LookupFieldName

Gets the field name.

Specified by:

getLookupFieldName in interface LookupFieldName

Returns:

The field name

setLookupFieldName

public void setLookupFieldName(String field)

Description copied from interface: LookupFieldName

Sets the field name.

Specified by:

setLookupFieldName in interface LookupFieldName

Parameters:

field - Name

keySet

public SortedSet<T> keySet()

Gets the keys currently used in the analysis.

Specified by:

keySet in interface Map<T,U extends SymbolParameters>

Returns:

The keys used in a Set of T.

size

public int size()

Returns the number of elements contained in this classification.

Specified by:

size in interface Map<T,U extends SymbolParameters>

Returns:

The number of elements contained in this classification.

isEmpty

public boolean isEmpty()

Returns true if there is nothing in this map.

Specified by:

isEmpty in interface Map<T,U extends SymbolParameters>

Returns:

true if we don't have any key-value mapping.

putAll

public void putAll(Map<? extends T,? extends U> input)

Put all the entries found in the given map as entries in this MappedLegend.

Specified by:

putAll in interface Map<T,U extends SymbolParameters>

Parameters:

input - The input map.

entrySet

public Set<Map.Entry<T,U>> entrySet()

Gets a Set representation of the key-value mapping we have in this MappedLegend.

Specified by:

entrySet in interface Map<T,U extends SymbolParameters>

Returns:

The mapping in a set of Map.Entry.

clear

public void clear()

Removes all the entries in this classification.

Specified by:

clear in interface Map<T,U extends SymbolParameters>

containsValue

public boolean containsValue(Object lp)

Checks if lp is a value contained in this MappedLegend

Specified by:

containsValue in interface Map<T,U extends SymbolParameters>

Parameters:

lp - The value we search

Returns:

true if we have a mapping to lp.

containsKey

public boolean containsKey(Object s)

Checks whether s is a key of this mapping.

Specified by:

containsKey in interface Map<T,U extends SymbolParameters>

Parameters:

s - The key we search

Returns:

true if we have a mapping with s as a key.

Throws:

ClassCastException - if the key is of an inappropriate type for this map

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<T,U extends SymbolParameters>

Overrides:

equals in class Object

values

public Collection<U> values()

Gets all the LineParameters stored in this RecodedLine, default one excepted.

Specified by:

values in interface Map<T,U extends SymbolParameters>

Returns:

The LineParameters in a Collection.

setComparator

public void setComparator(Comparator<T> comp)

Sets the comparator we want to use for elements ordering.

Parameters:

comp - The comparator we want to use.

setFallbackParameters

public abstract void setFallbackParameters(U fallback)

Sets the fallback configuration according to the one given in argument.

Parameters:

fallback - The new basis for the fallback configuration.

getFallbackParameters

public abstract U getFallbackParameters()

Gets the configuration used to draw features we can't get a value for in the map in the style .

Returns:

The fallback configuration.