org.orbisgis.legend.thematic.recode

Class RecodedLine

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

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

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

org.orbisgis.legend.thematic.recode.RecodedLine

All Implemented Interfaces:

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

public class RecodedLine
extends AbstractRecodedLegend<LineParameters>

Wrapper for lines made of a PenStroke where parameters are made of Recode instances on a common field or of Literal.

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
RecodedLine() Default constructor.
RecodedLine(LineSymbolizer sym) Builds a new RecodedLine instance from the given LineSymbolizer.

Method Summary

Methods

Modifier and Type	Method and Description
LineParameters	get(Object objKey) Gets the LineParameters that is used to build the line associated to key.
LineParameters	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.
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()
LineParameters	put(String key, LineParameters value) Puts the given line configuration in the unique values managed by this RecodedLine.
LineParameters	remove(Object objKey) Removes the mapping for the given key.
void	setFallbackParameters(LineParameters lps) Sets the fallback configuration according to the one given in argument.
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

RecodedLine

public RecodedLine()

Default constructor. Builds a RecodedLine from scratch using a constant LineSymbolizer that embeds a constant PenStroke.

RecodedLine

public RecodedLine(LineSymbolizer sym)

Builds a new RecodedLine instance from the given LineSymbolizer. Take care to validate the configuration of the symbolizer before calling this constructor.

Parameters:

sym - The original LineSymbolizer.

Throws:

ClassCastException

UnsupportedOperationException - If the inner stroke is not a PenStroke instance.

IllegalStateException - If the inner parameters have different analysis fields.

Method Detail

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

get

public LineParameters get(Object objKey)

Gets the LineParameters that is used to build the line associated to key.

Parameters:

objKey - The key of the map

Returns:

The LineParameters instance associated to key.

put

public LineParameters put(String key,
                 LineParameters value)

Puts the given line configuration in the unique values managed by this RecodedLine. If there was already a value associated to key, the former configuration is returned by the method.

Parameters:

key - Key with which the specified value is to be associated

value - Value to be associated with the specified key

Returns:

The former configuration associated to key, if any, null otherwise.

Throws:

NullPointerException - if key or value are null.

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,LineParameters>

Overrides:

hashCode in class Object

remove

public LineParameters remove(Object objKey)

Removes the mapping for the given key.

Parameters:

objKey - The key we want to remove from this unique value analysis. If it's not a String, a ClassCastException will be thrown.

Returns:

The value previously associated to the given key, or null if there was not.

getSymbolizer

public Symbolizer getSymbolizer()

Description copied from interface: Legend

Gets the associated Symbolizer.

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.

Returns:

getStrokeUom

public Uom getStrokeUom()

Description copied from interface: StrokeUom

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

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.

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.

Returns:

A list gathering the recoded parameters.

getFallbackParameters

public LineParameters 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,LineParameters>

Returns:

The fallback configuration.

setFallbackParameters

public void setFallbackParameters(LineParameters lps)

Description copied from class: MappedLegend

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

Specified by:

setFallbackParameters in class MappedLegend<String,LineParameters>

Parameters:

lps - The new basis for the fallback configuration.

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: