org.orbisgis.legend.thematic.constant

Class UniqueSymbolLine

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

org.orbisgis.legend.thematic.ConstantColorAndDashesLine

org.orbisgis.legend.thematic.constant.UniqueSymbolLine

All Implemented Interfaces:

Legend, LegendStructure, IUniqueSymbolLine, UniqueSymbol, StrokeUom

public class UniqueSymbolLine
extends ConstantColorAndDashesLine
implements IUniqueSymbolLine

Represents a LineSymbolizer whose parameters are constant, whatever the input data are. We expect from it :

• 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.

Author:

Alexis Guéganno

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
UniqueSymbolLine() Build a new default UniqueSymbolLine from scratch.
UniqueSymbolLine(LineParameters lp) Builds a new UniqueSymbolLine using the needed parameters gathered in the given LineParameters instance.
UniqueSymbolLine(LineSymbolizer symbolizer) Build a new UniqueSymbolLine from the given symbolizer.
UniqueSymbolLine(LineSymbolizer symbolizer, ConstantPenStrokeLegend legend) Build a new UniqueSymbolLine instance from the given symbolizer and legend.

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.
LineParameters	getLineParameters() Gets the representation of this UniqueSymbolLine with the equivalent LineParameters instance.
ConstantPenStroke	getPenStroke() Gets the analysis associated to the inner PenStroke.
LegendStructure	getStrokeLegend() Gets the LegendStructure associated to this UniqueSymbolLine.
void	setPenStroke(ConstantPenStroke penStroke) Sets the analysis associated to the inner PenStroke.

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

getLineColor, getStrokeUom, getSymbolizer, setLineColor, 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

UniqueSymbolLine

public UniqueSymbolLine()

Build a new default UniqueSymbolLine from scratch. It contains a default LineSymbolizer, which is consequently constant. The associated LegendStructure structure is built during initialization.

UniqueSymbolLine

public UniqueSymbolLine(LineSymbolizer symbolizer)

Build a new UniqueSymbolLine from the given symbolizer. Note that symbolizer must really be a unique symbol. Otherwise, you'll face ClassCastException.

Parameters:

symbolizer - The input symbolizer.

Throws:

ClassCastException - If the Stroke contained in symbolizer can't be recognized as a ConstantPenStrokeLegend.

UniqueSymbolLine

public UniqueSymbolLine(LineParameters lp)

Builds a new UniqueSymbolLine using the needed parameters gathered in the given LineParameters instance.

Parameters:

lp - The LineParameters instance we'll use to configure our symbol.

UniqueSymbolLine

public UniqueSymbolLine(LineSymbolizer symbolizer,
                ConstantPenStrokeLegend legend)

Build a new UniqueSymbolLine instance from the given symbolizer and legend. As the inner analysis is given directly with the symbolizer, we won't check they match. It is up to the caller to check they do.

Parameters:

symbolizer - The input symbolizer

legend - The associated legend

Method Detail

getStrokeLegend

public LegendStructure getStrokeLegend()

Gets the LegendStructure associated to this UniqueSymbolLine.

Specified by:

getStrokeLegend in class ConstantColorAndDashesLine

Returns:

The LegendStructure describing the inner stroke.

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 penStroke)

Description copied from interface: IUniqueSymbolLine

Sets the analysis associated to the inner PenStroke.

Specified by:

setPenStroke in interface IUniqueSymbolLine

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:

getLineParameters

public LineParameters getLineParameters()

Gets the representation of this UniqueSymbolLine with the equivalent LineParameters instance.

Returns:

A LineParameters instance equivalent to this UniqueSymbolLine.