org.orbisgis.legend.thematic

Class ConstantFormPoint

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

org.orbisgis.legend.thematic.ConstantFormPoint

All Implemented Interfaces:

Legend, LegendStructure, OnVertexOnInterior, StrokeUom, SymbolUom

Direct Known Subclasses:

ProportionalPoint, UniqueSymbolPoint

public abstract class ConstantFormPoint
extends SymbolizerLegend
implements OnVertexOnInterior, SymbolUom

This class gathers methods that are common to thematic analysis where the Stroke, Fill and well-known name are constant.

Author:

Alexis Guéganno

Constructor Summary

Constructors

Constructor and Description
ConstantFormPoint() Builds a new ConstantFormPoint that just have a default PointSymbolizer in it.
ConstantFormPoint(PointSymbolizer symbolizer) Basically set the associated PointSymbolizer.

Method Summary

Methods

Modifier and Type	Method and Description
abstract ConstantFormWKN	getMarkGraphic() Gets the MarkGraphicLegend that must be associated to the inner PointSymbolizer.
Uom	getStrokeUom() Gets the unit of measure used to compute the form of the stroke.
Symbolizer	getSymbolizer() Gets the associated PointSymbolizer instance.
Uom	getSymbolUom() Gets the unit of measure used to size the associated Stroke.
String	getWellKnownName() Gets the well-known name that describes the shape of the inner MarkGraphic.
boolean	isOnVertex() Gets whether symbols must be drawn on vertices or on interior point.
void	setOnInterior() Sets that symbols must be drawn on vertices or on interior point.
void	setOnVertex() Sets that symbols must be drawn on vertices or on interior point.
void	setStrokeUom(Uom u) Sets the unit of measure used to compute the form of the stroke.
void	setSymbolUom(Uom u) Sets the unit of measure used to size the associated Stroke.
void	setWellKnownName(String str) Sets the well-known name that describes the shape of the inner MarkGraphic.

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

getLegendTypeId, 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

getLegendTypeName

Constructor Detail

ConstantFormPoint

public ConstantFormPoint()

Builds a new ConstantFormPoint that just have a default PointSymbolizer in it.

ConstantFormPoint

public ConstantFormPoint(PointSymbolizer symbolizer)

Basically set the associated PointSymbolizer.

Parameters:

symbolizer -

Method Detail

getSymbolizer

public Symbolizer getSymbolizer()

Gets the associated PointSymbolizer instance.

Specified by:

getSymbolizer in interface Legend

Returns:

getMarkGraphic

public abstract ConstantFormWKN getMarkGraphic()

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

Returns:

An instance of MarkGraphicLegend.

getWellKnownName

public String getWellKnownName()

Gets the well-known name that describes the shape of the inner MarkGraphic.

Returns:

setWellKnownName

public void setWellKnownName(String str)

Sets the well-known name that describes the shape of the inner MarkGraphic.

Parameters:

str - The new WellKnownName.

isOnVertex

public boolean isOnVertex()

Description copied from interface: OnVertexOnInterior

Gets whether symbols must be drawn on vertices or on interior point.

Specified by:

isOnVertex in interface OnVertexOnInterior

Returns:

setOnVertex

public void setOnVertex()

Description copied from interface: OnVertexOnInterior

Sets that symbols must be drawn on vertices or on interior point.

Specified by:

setOnVertex in interface OnVertexOnInterior

setOnInterior

public void setOnInterior()

Description copied from interface: OnVertexOnInterior

Sets that symbols must be drawn on vertices or on interior point.

Specified by:

setOnInterior in interface OnVertexOnInterior

getStrokeUom

public Uom getStrokeUom()

Description copied from interface: StrokeUom

Gets the unit of measure used to compute the form of the stroke.

Specified by:

getStrokeUom in interface StrokeUom

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.

Specified by:

setStrokeUom in interface StrokeUom

getSymbolUom

public Uom getSymbolUom()

Description copied from interface: SymbolUom

Gets the unit of measure used to size the associated Stroke.

Specified by:

getSymbolUom in interface SymbolUom

Returns:

The current Uom

setSymbolUom

public void setSymbolUom(Uom u)

Description copied from interface: SymbolUom

Sets the unit of measure used to size the associated Stroke.

Specified by:

setSymbolUom in interface SymbolUom

Parameters:

u - The new Uom