org.orbisgis.legend.thematic.recode

Class RecodedArea

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

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

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

org.orbisgis.legend.thematic.recode.RecodedArea

All Implemented Interfaces:

Map<String,AreaParameters>, Legend, LegendStructure, LookupFieldName, RecodedLegendStructure, EnablesStroke, StrokeUom

public class RecodedArea
extends AbstractRecodedLegend<AreaParameters>
implements EnablesStroke

Wrapper for unique value classification that are made on AreaSymbolizer instances.

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
RecodedArea() Default constructor : builds an empty classification based on the default AreaSymbolizer.
RecodedArea(AreaSymbolizer sym) Builds a new RecodedArea considering that sym matches the configuration constraints expected by this class.

Method Summary

Methods

Modifier and Type	Method and Description
AreaParameters	get(Object objKey)
AreaParameters	getFallbackParameters() Gets the configuration used to draw features we can't get a value for in the map in the style .
org.orbisgis.legend.structure.recode.RecodedColor	getFillColor() Gets the wrapper that manages the color of the line.
org.orbisgis.legend.structure.recode.RecodedReal	getFillOpacity() Gets the wrapper that manages the opacity of the line.
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.
org.orbisgis.legend.structure.recode.RecodedColor	getLineColor() Gets the wrapper that manages the color of the line.
org.orbisgis.legend.structure.recode.RecodedString	getLineDash() Gets the wrapper that manages the dash pattern of the line.
org.orbisgis.legend.structure.recode.RecodedReal	getLineOpacity() Gets the wrapper that manages the opacity of the line.
org.orbisgis.legend.structure.recode.RecodedReal	getLineWidth() Gets the wrapper that manages the width of the line.
List<org.orbisgis.legend.structure.recode.RecodedLegend>	getRecodedLegends() Get all the instances of RecodedLegend that are needed to configure this legend.
Uom	getStrokeUom() Gets the unit of measure used to compute the form of the stroke.
Symbolizer	getSymbolizer() Gets the associated Symbolizer.
int	hashCode()
boolean	isStrokeEnabled() Returns true if the stroke of the associated symbolizer.
AreaParameters	put(String key, AreaParameters value)
AreaParameters	remove(Object objKey)
void	setFallbackParameters(AreaParameters ap) 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.recode.AbstractRecodedLegend

applyGlobalVisitor, applyGlobalVisitor, getComparator, 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, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

Constructor Detail

RecodedArea

public RecodedArea()

Default constructor : builds an empty classification based on the default AreaSymbolizer.

RecodedArea

public RecodedArea(AreaSymbolizer sym)

Builds a new RecodedArea considering that sym matches the configuration constraints expected by this class. That means it must be made of a PenStroke and of a SolidFill and that both of them are built with literals or recode instances containing only literals, and that the recode instances are all built with the same analysis field. Use the analyzer dedicated to area to check that automatically.

Parameters:

sym - The base Symbolizer

Method Detail

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:

getLineWidth

public org.orbisgis.legend.structure.recode.RecodedReal getLineWidth()

Gets the wrapper that manages the width of the line.

Returns:

the recoded width

getLineOpacity

public org.orbisgis.legend.structure.recode.RecodedReal getLineOpacity()

Gets the wrapper that manages the opacity of the line.

Returns:

the recoded opacity

getLineColor

public org.orbisgis.legend.structure.recode.RecodedColor getLineColor()

Gets the wrapper that manages the color of the line.

Returns:

the recoded color

getLineDash

public org.orbisgis.legend.structure.recode.RecodedString getLineDash()

Gets the wrapper that manages the dash pattern of the line.

Returns:

the recoded dash

getFillOpacity

public org.orbisgis.legend.structure.recode.RecodedReal getFillOpacity()

Gets the wrapper that manages the opacity of the line.

Returns:

the recoded opacity

getFillColor

public org.orbisgis.legend.structure.recode.RecodedColor getFillColor()

Gets the wrapper that manages the color of the line.

Returns:

the recoded color

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

get

public AreaParameters get(Object objKey)

Specified by:

get in interface Map<String,AreaParameters>

put

public AreaParameters put(String key,
                 AreaParameters value)

Specified by:

put in interface Map<String,AreaParameters>

remove

public AreaParameters remove(Object objKey)

Specified by:

remove in interface Map<String,AreaParameters>

getRecodedLegends

public List<org.orbisgis.legend.structure.recode.RecodedLegend> getRecodedLegends()

Description copied from interface: RecodedLegendStructure

Get all the instances of RecodedLegend that are needed to configure this legend.

Specified by:

getRecodedLegends in interface RecodedLegendStructure

Returns:

A list gathering the recoded parameters.

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<String,AreaParameters>

Returns:

The fallback configuration.

setFallbackParameters

public void setFallbackParameters(AreaParameters ap)

Description copied from class: MappedLegend

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

Specified by:

setFallbackParameters in class MappedLegend<String,AreaParameters>

Parameters:

ap - The new basis for the fallback configuration.

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,AreaParameters>

Overrides:

hashCode in class Object

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:

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.