org.orbisgis.legend.thematic.categorize

Class CategorizedArea

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

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

org.orbisgis.legend.thematic.categorize.AbstractCategorizedLegend<AreaParameters>

org.orbisgis.legend.thematic.categorize.CategorizedArea

All Implemented Interfaces:

Map<Double,AreaParameters>, Legend, LegendStructure, LookupFieldName, EnablesStroke, StrokeUom

public class CategorizedArea
extends AbstractCategorizedLegend<AreaParameters>
implements EnablesStroke

This class intends to propose an API that is useful to handle AreaSymbolizer instances that are made of literal or categorized parameters.

Author:

Alexis Guéganno

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>

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
CategorizedArea() Builds a new, empty, CategorizedArea.
CategorizedArea(AreaSymbolizer as) Build a new CategorizedArea from the given AreaSymbolizer.

Method Summary

Methods

Modifier and Type	Method and Description
AreaParameters	get(Object o)
List<CategorizedLegend>	getCategorizedLegend() Gets all the legends that are used to configure this Categorized symbol
AreaParameters	getFallbackParameters() Gets the configuration used to draw features we can't get a value for in the map in the style .
String	getLegendTypeId() Returns an Id that will be used to check that a Legend can be edited with a given edition panel.
String	getLegendTypeName() Returns a string that describes - for human - the nature of the thematic analysis made in this Legend.
Uom	getStrokeUom() Gets the unit of measure used to compute the form of the stroke.
Symbolizer	getSymbolizer() Gets the associated Symbolizer.
boolean	isStrokeEnabled() Returns true if the stroke of the associated symbolizer.
AreaParameters	put(Double d, AreaParameters ap)
AreaParameters	remove(Object o)
void	setFallbackParameters(AreaParameters fallback) Sets the fallback configuration according to the one given in argument.
void	setStrokeEnabled(boolean enable) Enables or disables the usage of a stroke for the drawn geometries.
void	setStrokeUom(Uom u) Sets the unit of measure used to compute the form of the stroke.

Methods inherited from class org.orbisgis.legend.thematic.categorize.AbstractCategorizedLegend

applyGlobalVisitor, applyGlobalVisitor, getNextThreshold, getNotUsedKey

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

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

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

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

hashCode

Field Detail

NAME

public static final String NAME

Constructor Detail

CategorizedArea

public CategorizedArea()

Builds a new, empty, CategorizedArea.

CategorizedArea

public CategorizedArea(AreaSymbolizer as)

Build a new CategorizedArea from the given AreaSymbolizer. This one must have been built with a SolidFill and a PenStroke containing a SolidFill. All the parameters must either be simple Categorize or Literal instances. If not, Exception will be thrown.

Parameters:

as - The input AreaSymbolizer

Throws:

IllegalArgumentException - If the input symbolizer cannot be recognized as a CategorizedArea.

Method Detail

getCategorizedLegend

public List<CategorizedLegend> getCategorizedLegend()

Description copied from class: AbstractCategorizedLegend

Gets all the legends that are used to configure this Categorized symbol

Specified by:

getCategorizedLegend in class AbstractCategorizedLegend<AreaParameters>

Returns:

A list of CategorizedLegend instances.

getSymbolizer

public Symbolizer getSymbolizer()

Description copied from interface: Legend

Gets the associated Symbolizer.

Specified by:

getSymbolizer in interface Legend

Returns:

getLegendTypeName

public String getLegendTypeName()

Description copied from interface: Legend

Returns a string that describes - for human - the nature of the thematic analysis made in this Legend.

Specified by:

getLegendTypeName in interface Legend

Returns:

get

public AreaParameters get(Object o)

Specified by:

get in interface Map<Double,AreaParameters>

put

public AreaParameters put(Double d,
                 AreaParameters ap)

Specified by:

put in interface Map<Double,AreaParameters>

remove

public AreaParameters remove(Object o)

Specified by:

remove in interface Map<Double,AreaParameters>

setFallbackParameters

public void setFallbackParameters(AreaParameters fallback)

Description copied from class: MappedLegend

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

Specified by:

setFallbackParameters in class MappedLegend<Double,AreaParameters>

Parameters:

fallback - The new basis for the fallback configuration.

getFallbackParameters

public AreaParameters getFallbackParameters()

Description copied from class: MappedLegend

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

Specified by:

getFallbackParameters in class MappedLegend<Double,AreaParameters>

Returns:

The fallback configuration.

isStrokeEnabled

public boolean isStrokeEnabled()

Description copied from interface: EnablesStroke

Returns true if the stroke of the associated symbolizer.

Specified by:

isStrokeEnabled in interface EnablesStroke

Returns:

true if the geometries can be stroked by the associated symbolizer, ie its inner PenStroke is not null.

setStrokeEnabled

public void setStrokeEnabled(boolean enable)

Description copied from interface: EnablesStroke

Enables or disables the usage of a stroke for the drawn geometries.

Specified by:

setStrokeEnabled in interface EnablesStroke

Parameters:

enable - If true, the stroke will be drawn. If false, it won't be drawn.

getStrokeUom

public Uom getStrokeUom()

Description copied from interface: StrokeUom

Gets the unit of measure used to compute the form of the stroke.

Specified by:

getStrokeUom in interface StrokeUom

Returns:

setStrokeUom

public void setStrokeUom(Uom u)

Description copied from interface: StrokeUom

Sets the unit of measure used to compute the form of the stroke.

Specified by:

setStrokeUom in interface StrokeUom

getLegendTypeId

public String getLegendTypeId()

Description copied from interface: Legend

Returns an Id that will be used to check that a Legend can be edited with a given edition panel.

Specified by:

getLegendTypeId in interface Legend

Overrides:

getLegendTypeId in class SymbolizerLegend

Returns: