org.orbisgis.legend

Interface Legend

All Superinterfaces:

LegendStructure

All Known Subinterfaces:

IUniqueSymbolArea, IUniqueSymbolLine, UniqueSymbol

All Known Implementing Classes:

AbstractCategorizedLegend, AbstractRecodedLegend, CategorizedArea, CategorizedLine, CategorizedPoint, ConstantColorAndDashesLine, ConstantFormPoint, ConstantStrokeArea, MappedLegend, ProportionalLine, ProportionalPoint, RecodedArea, RecodedLine, RecodedPoint, SymbolizerLegend, UniqueSymbolArea, UniqueSymbolLine, UniqueSymbolPoint

public interface Legend
extends LegendStructure

Legend realizations represent patterns that can be found in a SE style, and that match well-known configuration as described in the geographic and cartographic literatures.

Author:

Alexis Guéganno

Method Summary

Methods

Modifier and Type	Method and Description
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.
Double	getMaxScale() Get the maximum scale this Legend will be rendered for.
Double	getMinScale() Get the minimum scale this Legend will be rendered for.
String	getName() Get the name of the underlying Symbolizer.
Symbolizer	getSymbolizer() Gets the associated Symbolizer.
void	setMaxScale(Double scale) Set the maximum scale this Legend will be rendered for.
void	setMinScale(Double scale) Set the minimum scale this Legend will be rendered for.
void	setName(String name) Set the name of the underlying Symbolizer.

Method Detail

getSymbolizer

Symbolizer getSymbolizer()

Gets the associated Symbolizer.

Returns:

getName

String getName()

Get the name of the underlying Symbolizer.

Returns:

setName

void setName(String name)

Set the name of the underlying Symbolizer.

Parameters:

name -

getMinScale

Double getMinScale()

Get the minimum scale this Legend will be rendered for.

Returns:

setMinScale

void setMinScale(Double scale)

Set the minimum scale this Legend will be rendered for.

Parameters:

scale -

getMaxScale

Double getMaxScale()

Get the maximum scale this Legend will be rendered for.

Returns:

setMaxScale

void setMaxScale(Double scale)

Set the maximum scale this Legend will be rendered for.

Parameters:

scale -

getLegendTypeId

String getLegendTypeId()

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

Returns:

getLegendTypeName

String getLegendTypeName()

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

Returns: