org.orbisgis.legend.thematic.constant

Class UniqueSymbolPoint

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

org.orbisgis.legend.thematic.ConstantFormPoint

org.orbisgis.legend.thematic.constant.UniqueSymbolPoint

All Implemented Interfaces:

Legend, LegendStructure, IUniqueSymbolArea, IUniqueSymbolLine, UniqueSymbol, OnVertexOnInterior, StrokeUom, SymbolUom

public class UniqueSymbolPoint
extends ConstantFormPoint
implements IUniqueSymbolArea

We are dealing with a simple point symbolizer. If we succeeded in recognizing this thematic structure, we can say many things about the underlying PointSymbolize :

• It is a constant MarkGraphic instance, used with a well-known name rather than an external Graphic.
• Its contouring line is constant, made of a PenStroke with a SolidFill of fixed colour and width.
• It is filled with a SolidFill of fixed colour and opacity.
• the width and height of its ViewBox are constant.

Author:

Alexis Guéganno

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
UniqueSymbolPoint() Build a new UniqueSymbolPoint from scratch.
UniqueSymbolPoint(PointParameters pp) Builds a new UniqueSymbolPoint using the configuration given in argument
UniqueSymbolPoint(PointSymbolizer pointSymbolizer) Tries to build an instance of UniqueSymbolPoint using the given PointSymbolizer.
UniqueSymbolPoint(PointSymbolizer symbolizer, ConstantWKNLegend markGraphic) Create a new UniqueSymbolPoint.

Method Summary

Methods

Modifier and Type	Method and Description
ConstantSolidFill	getFillLegend() Gets the Fill analysis embedded in this IUniqueSymbolArea.
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.
ConstantFormWKN	getMarkGraphic() Gets the MarkGraphicLegend that must be associated to the inner PointSymbolizer.
ConstantPenStroke	getPenStroke() Gets the analysis associated to the inner PenStroke.
PointParameters	getPointParameters() Gets the configuration defining this point, uom excluded, as a PointParameters instance.
Double	getViewBoxHeight() Get the height of the ViewBox we are going to draw our symbol in.
Double	getViewBoxWidth() Get the width of the ViewBox we are going to draw our symbol in.
void	setFillLegend(ConstantSolidFill csf) Sets the Fill analysis embedded in this IUniqueSymbolArea.
void	setPenStroke(ConstantPenStroke cpsl) Sets the analysis associated to the inner PenStroke.
void	setViewBoxHeight(Double d) Set the height of the ViewBox we are going to draw our symbol in.
void	setViewBoxWidth(Double d) Set the width of the ViewBox we are going to draw our symbol in.

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

getStrokeUom, getSymbolizer, getSymbolUom, getWellKnownName, isOnVertex, setOnInterior, setOnVertex, setStrokeUom, setSymbolUom, setWellKnownName

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

UniqueSymbolPoint

public UniqueSymbolPoint()

Build a new UniqueSymbolPoint from scratch. It will instanciate the inner symbolizer as needed, as well as the underlying LegendStructure structure.

We basically instanciate a new default PointSymbolizer, and use it to compute our LegendStructure structure. That means we know everything but the colour about the Symbolizer. And we can be sure it is a constant.

UniqueSymbolPoint

public UniqueSymbolPoint(PointSymbolizer pointSymbolizer)

Tries to build an instance of UniqueSymbolPoint using the given PointSymbolizer.

Parameters:

pointSymbolizer - The original symbolizer

Throws:

IllegalArgumentException - If pointSymbolizer can't be recognized as a valid UniqueSymbolPoint.

UniqueSymbolPoint

public UniqueSymbolPoint(PointParameters pp)

Builds a new UniqueSymbolPoint using the configuration given in argument

Parameters:

pp - The point configuration with all parameters gathered in a PointParameters instance.

UniqueSymbolPoint

public UniqueSymbolPoint(PointSymbolizer symbolizer,
                 ConstantWKNLegend markGraphic)

Create a new UniqueSymbolPoint. As the associated analysis is given in parameter, it is up to the calling method to be sure that

Parameters:

symbolizer - the original symbolizer

markGraphic - its associated legend

Method Detail

getMarkGraphic

public ConstantFormWKN getMarkGraphic()

Description copied from class: ConstantFormPoint

Gets the MarkGraphicLegend that must be associated to the inner PointSymbolizer.

Specified by:

getMarkGraphic in class ConstantFormPoint

Returns:

An instance of MarkGraphicLegend.

getFillLegend

public ConstantSolidFill getFillLegend()

Description copied from interface: IUniqueSymbolArea

Gets the Fill analysis embedded in this IUniqueSymbolArea.

Specified by:

getFillLegend in interface IUniqueSymbolArea

Returns:

setFillLegend

public void setFillLegend(ConstantSolidFill csf)

Description copied from interface: IUniqueSymbolArea

Sets the Fill analysis embedded in this IUniqueSymbolArea.

Specified by:

setFillLegend in interface IUniqueSymbolArea

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

getViewBoxWidth

public Double getViewBoxWidth()

Get the width of the ViewBox we are going to draw our symbol in.

Returns:

A Double that can be null. A ViewBox can be defined with only one dimension set.

getViewBoxHeight

public Double getViewBoxHeight()

Get the height of the ViewBox we are going to draw our symbol in.

Returns:

A Double that can be null. A ViewBox can be defined with only one dimension set.

setViewBoxHeight

public void setViewBoxHeight(Double d)

Set the height of the ViewBox we are going to draw our symbol in.

Parameters:

d - A Double that can be null. A ViewBox can be defined with only one dimension set.

setViewBoxWidth

public void setViewBoxWidth(Double d)

Set the width of the ViewBox we are going to draw our symbol in.

Parameters:

d - A Double that can be null. A ViewBox can be defined with only one dimension set.

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:

getPointParameters

public PointParameters getPointParameters()

Gets the configuration defining this point, uom excluded, as a PointParameters instance.

Returns:

This point as a PointParameters.