org.orbisgis.legend.thematic.categorize

Class CategorizedLine

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

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

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

org.orbisgis.legend.thematic.categorize.CategorizedLine

All Implemented Interfaces:

Map<Double,LineParameters>, Legend, LegendStructure, LookupFieldName, StrokeUom

public class CategorizedLine
extends AbstractCategorizedLegend<LineParameters>

This class intends to propose an API that is useful to handle LineSymbolizer 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
CategorizedLine() Builds a new, empty, CategorizedLine.
CategorizedLine(LineSymbolizer ls) Build a new CategorizedLine from the given LineSymbolizer.

Method Summary

Methods

Modifier and Type	Method and Description
LineParameters	get(Object o)
List<CategorizedLegend>	getCategorizedLegend() Gets all the legends that are used to configure this Categorized symbol
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.
Uom	getStrokeUom() Gets the unit of measure used to compute the form of the stroke.
Symbolizer	getSymbolizer() Gets the associated Symbolizer.
LineParameters	put(Double d, LineParameters lp)
LineParameters	remove(Object o)
void	setFallbackParameters(LineParameters fallback) 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.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

CategorizedLine

public CategorizedLine()

Builds a new, empty, CategorizedLine.

CategorizedLine

public CategorizedLine(LineSymbolizer ls)

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

Parameters:

ls - The input LineSymbolizer

Throws:

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

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

Returns:

A list of CategorizedLegend instances.

setFallbackParameters

public void setFallbackParameters(LineParameters fallback)

Description copied from class: MappedLegend

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

Specified by:

setFallbackParameters in class MappedLegend<Double,LineParameters>

Parameters:

fallback - The new basis for the fallback configuration.

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

Returns:

The fallback configuration.

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:

get

public LineParameters get(Object o)

put

public LineParameters put(Double d,
                 LineParameters lp)

remove

public LineParameters remove(Object o)

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.

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: