org.orbisgis.legend.thematic.constant

Class UniqueSymbolArea

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

org.orbisgis.legend.thematic.ConstantStrokeArea

org.orbisgis.legend.thematic.constant.UniqueSymbolArea

All Implemented Interfaces:

Legend, LegendStructure, IUniqueSymbolArea, IUniqueSymbolLine, UniqueSymbol, StrokeUom

public class UniqueSymbolArea
extends ConstantStrokeArea
implements IUniqueSymbolArea

Represents a AreaSymbolizer whose parameters are constant, whatever the input data are. We expect from its Stroke :

• To be defined with a PenStroke
• To have a constant dash array structure
• To have a constant width
• To be filled with a constant SolidFill, and consequently with a constant Color.

We expect from its Fill to be a constant SolidFill instance.

Author:

Alexis Guéganno

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
UniqueSymbolArea() Builds a new default UniqueSymbolArea from scratch.
UniqueSymbolArea(AreaParameters ap) Builds a new UniqueSymbolArea from the given AreaParameters.
UniqueSymbolArea(AreaSymbolizer symbolizer) Builds a new UniqueSymbolArea directly from the given AreaSymbolizer.

Method Summary

Methods

Modifier and Type	Method and Description
AreaParameters	getAreaParameters() Gets the representation of this symbol as a AreaParameters instance.
ConstantSolidFill	getFillLegend() Exposes the inner LegendStructure that represents the analysis made on the Fill.
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.
ConstantPenStroke	getPenStroke() Gets the analysis associated to the inner PenStroke.
void	setFillLegend(ConstantSolidFill cfl) Sets the legend describing the structure of the fill contained in the inner AreaSymbolizer.
void	setPenStroke(ConstantPenStroke cpsl) Sets the analysis associated to the inner PenStroke.

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

getDashArray, getLineColor, getLineWidth, getStrokeLegend, getStrokeUom, getSymbolizer, setDashArray, setLineColor, setLineWidth, setStrokeLegend, setStrokeUom

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

getMaxScale, getMinScale, getName, setMaxScale, setMinScale, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orbisgis.legend.Legend

getMaxScale, getMinScale, getName, getSymbolizer, setMaxScale, setMinScale, setName

Field Detail

NAME

public static final String NAME

Constructor Detail

UniqueSymbolArea

public UniqueSymbolArea()

Builds a new default UniqueSymbolArea from scratch. It contains a default AreaSymbolizer, which is consequently constant. The associated LegendStructure structure is built during initialization.

UniqueSymbolArea

public UniqueSymbolArea(AreaSymbolizer symbolizer)

Builds a new UniqueSymbolArea directly from the given AreaSymbolizer.

Parameters:

symbolizer - The original symbolizer

UniqueSymbolArea

public UniqueSymbolArea(AreaParameters ap)

Builds a new UniqueSymbolArea from the given AreaParameters.

Parameters:

ap - The unique symbol configuration.

Method Detail

getFillLegend

public ConstantSolidFill getFillLegend()

Exposes the inner LegendStructure that represents the analysis made on the Fill.

Specified by:

getFillLegend in interface IUniqueSymbolArea

Returns:

The fill legend associated to the AreaSymbolizer's fill.

getPenStroke

public ConstantPenStroke getPenStroke()

Description copied from interface: IUniqueSymbolLine

Gets the analysis associated to the inner PenStroke.

Specified by:

getPenStroke in interface IUniqueSymbolLine

Returns:

setPenStroke

public void setPenStroke(ConstantPenStroke cpsl)

Description copied from interface: IUniqueSymbolLine

Sets the analysis associated to the inner PenStroke.

Specified by:

setPenStroke in interface IUniqueSymbolLine

setFillLegend

public void setFillLegend(ConstantSolidFill cfl)

Sets the legend describing the structure of the fill contained in the inner AreaSymbolizer. This will update the fill of the AreaSymbolizer in question.

Specified by:

setFillLegend in interface IUniqueSymbolArea

Parameters:

cfl - The new fill legend that is associated to this unique symbol. Will replace the fill of the inner symbolizer.

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:

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:

getAreaParameters

public AreaParameters getAreaParameters()

Gets the representation of this symbol as a AreaParameters instance.

Returns:

This symbol as an AreaParameters.