org.orbisgis.legend.thematic.recode

Class RecodedPoint

java.lang.Object

org.orbisgis.legend.thematic.SymbolizerLegend

org.orbisgis.legend.thematic.map.MappedLegend<String,U>

org.orbisgis.legend.thematic.recode.AbstractRecodedLegend<PointParameters>

org.orbisgis.legend.thematic.recode.RecodedPoint

All Implemented Interfaces:

Map<String,PointParameters>, Legend, LegendStructure, LookupFieldName, RecodedLegendStructure, EnablesStroke, OnVertexOnInterior, StrokeUom, SymbolUom

public class RecodedPoint
extends AbstractRecodedLegend<PointParameters>
implements SymbolUom, EnablesStroke, OnVertexOnInterior

Wrapper for unique value classification that are made on PointSymbolizer instances.

Author:

Alexis Guéganno

Nested Class Summary

Nested classes/interfaces inherited from class org.orbisgis.legend.thematic.map.MappedLegend

MappedLegend.MappedLegendEntry, MappedLegend.NumComparator

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
RecodedPoint() Default constructor : builds an empty classification based on the default PointSymbolizer.
RecodedPoint(PointSymbolizer symbolizer) Builds a new RecodedPoint considering that sym matches the configuration constraints expected by this class.

Method Summary

Methods

Modifier and Type	Method and Description
PointParameters	get(Object objKey)
PointParameters	getFallbackParameters() Gets the configuration used to draw features we can't get a value for in the map in the style .
org.orbisgis.legend.structure.recode.RecodedColor	getFillColor() Gets the wrapper that manages the color of the fill.
org.orbisgis.legend.structure.recode.RecodedReal	getFillOpacity() Gets the wrapper that manages the opacity of 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.
org.orbisgis.legend.structure.recode.RecodedColor	getLineColor() Gets the wrapper that manages the color of the line.
org.orbisgis.legend.structure.recode.RecodedString	getLineDash() Gets the wrapper that manages the dash pattern of the line.
org.orbisgis.legend.structure.recode.RecodedReal	getLineOpacity() Gets the wrapper that manages the opacity of the line.
org.orbisgis.legend.structure.recode.RecodedReal	getLineWidth() Gets the wrapper that manages the width of the line.
List<org.orbisgis.legend.structure.recode.RecodedLegend>	getRecodedLegends() Get all the instances of RecodedLegend that are needed to configure this legend.
Uom	getStrokeUom() Gets the unit of measure used to compute the form of the stroke.
org.orbisgis.legend.structure.recode.RecodedReal	getSymbolHeight() Gets the wrapper that manages height of the symbol.
Symbolizer	getSymbolizer() Gets the associated Symbolizer.
Uom	getSymbolUom() Gets the unit of measure used to size the associated Stroke.
org.orbisgis.legend.structure.recode.RecodedReal	getSymbolWidth() Gets the wrapper that manages width of the symbol.
org.orbisgis.legend.structure.recode.RecodedString	getWkn() Gets the wrapper that manages the well-known name that determines the form of the symbol.
int	hashCode()
boolean	isOnVertex() Gets whether symbols must be drawn on vertices or on interior point.
boolean	isStrokeEnabled() Returns true if the stroke of the associated symbolizer.
PointParameters	put(String key, PointParameters value)
PointParameters	remove(Object objKey)
void	replaceMarkHeight(SeParameter sp) Replace the RealParameter embedded in the inner MarkGraphic with sp.
void	replaceMarkWidth(SeParameter sp) Replace the RealParameter embedded in the inner MarkGraphic with sp.
void	replaceWkn(SeParameter sp) Replace the StringParameter embedded in the inner MarkGraphic with sp.
void	setFallbackParameters(PointParameters ap) Sets the fallback configuration according to the one given in argument.
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	setStrokeEnabled(boolean enable) Enables or disables the usage of a stroke for the drawn geometries.
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.

Methods inherited from class org.orbisgis.legend.thematic.recode.AbstractRecodedLegend

applyGlobalVisitor, applyGlobalVisitor, getComparator, getNotUsedKey

Methods inherited from class org.orbisgis.legend.thematic.map.MappedLegend

clear, containsKey, containsValue, entrySet, equals, getLookupFieldName, isEmpty, keySet, putAll, setComparator, setLookupFieldName, size, values

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

getMaxScale, getMinScale, getName, setMaxScale, setMinScale, setName

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Constructor Detail

RecodedPoint

public RecodedPoint()

Default constructor : builds an empty classification based on the default PointSymbolizer.

RecodedPoint

public RecodedPoint(PointSymbolizer symbolizer)

Builds a new RecodedPoint considering that sym matches the configuration constraints expected by this class. That means it must be made of a MarkGraphic containing a PenStroke and a SolidFill and whose shape is configured with a WellKnownName

All of them them must be built with literals or recode instances containing only literals, and that the recode instances are all built with the same analysis field. Use the analyzer dedicated to area to check that automatically.

Parameters:

symbolizer - The base Symbolizer

Method Detail

replaceWkn

public void replaceWkn(SeParameter sp)

Replace the StringParameter embedded in the inner MarkGraphic with sp. This method is called when a type change occurs in the associated RecodedString happens.

Parameters:

sp - The new StringParameter

Throws:

ClassCastException - if sp is not a StringParameter

replaceMarkWidth

public void replaceMarkWidth(SeParameter sp)

Replace the RealParameter embedded in the inner MarkGraphic with sp. This method is called when a type change occurs in the associated RecodedReal happens.

Parameters:

sp - The new RealParameter

Throws:

ClassCastException - if sp is not a RealParameter

replaceMarkHeight

public void replaceMarkHeight(SeParameter sp)

Replace the RealParameter embedded in the inner MarkGraphic with sp. This method is called when a type change occurs in the associated RecodedReal happens.

Parameters:

sp - The new RealParameter

Throws:

ClassCastException - if sp is not a RealParameter

getSymbolizer

public Symbolizer getSymbolizer()

Description copied from interface: Legend

Gets the associated Symbolizer.

Specified by:

getSymbolizer in interface Legend

Returns:

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:

getLineWidth

public org.orbisgis.legend.structure.recode.RecodedReal getLineWidth()

Gets the wrapper that manages the width of the line.

Returns:

the recoded width

getLineOpacity

public org.orbisgis.legend.structure.recode.RecodedReal getLineOpacity()

Gets the wrapper that manages the opacity of the line.

Returns:

the recoded opacity

getLineColor

public org.orbisgis.legend.structure.recode.RecodedColor getLineColor()

Gets the wrapper that manages the color of the line.

Returns:

the recoded color

getLineDash

public org.orbisgis.legend.structure.recode.RecodedString getLineDash()

Gets the wrapper that manages the dash pattern of the line.

Returns:

the recoded dash

getFillOpacity

public org.orbisgis.legend.structure.recode.RecodedReal getFillOpacity()

Gets the wrapper that manages the opacity of the fill.

Returns:

the recoded opacity

getFillColor

public org.orbisgis.legend.structure.recode.RecodedColor getFillColor()

Gets the wrapper that manages the color of the fill.

Returns:

the recoded color

getWkn

public org.orbisgis.legend.structure.recode.RecodedString getWkn()

Gets the wrapper that manages the well-known name that determines the form of the symbol.

Returns:

the recoded string

getSymbolWidth

public org.orbisgis.legend.structure.recode.RecodedReal getSymbolWidth()

Gets the wrapper that manages width of the symbol.

Returns:

the recoded real

getSymbolHeight

public org.orbisgis.legend.structure.recode.RecodedReal getSymbolHeight()

Gets the wrapper that manages height of the symbol.

Returns:

the recoded real

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

get

public PointParameters get(Object objKey)

Specified by:

get in interface Map<String,PointParameters>

put

public PointParameters put(String key,
                  PointParameters value)

Specified by:

put in interface Map<String,PointParameters>

remove

public PointParameters remove(Object objKey)

Specified by:

remove in interface Map<String,PointParameters>

getRecodedLegends

public List<org.orbisgis.legend.structure.recode.RecodedLegend> getRecodedLegends()

Description copied from interface: RecodedLegendStructure

Get all the instances of RecodedLegend that are needed to configure this legend.

Specified by:

getRecodedLegends in interface RecodedLegendStructure

Returns:

A list gathering the recoded parameters.

getFallbackParameters

public PointParameters getFallbackParameters()

Description copied from class: MappedLegend

Gets the configuration used to draw features we can't get a value for in the map in the style .

Specified by:

getFallbackParameters in class MappedLegend<String,PointParameters>

Returns:

The fallback configuration.

setFallbackParameters

public void setFallbackParameters(PointParameters ap)

Description copied from class: MappedLegend

Sets the fallback configuration according to the one given in argument.

Specified by:

setFallbackParameters in class MappedLegend<String,PointParameters>

Parameters:

ap - The new basis for the fallback configuration.

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,PointParameters>

Overrides:

hashCode in class Object

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:

isStrokeEnabled

public boolean isStrokeEnabled()

Description copied from interface: EnablesStroke

Returns true if the stroke of the associated symbolizer.

Specified by:

isStrokeEnabled in interface EnablesStroke

Returns:

true if the geometries can be stroked by the associated symbolizer, ie its inner PenStroke is not null.

setStrokeEnabled

public void setStrokeEnabled(boolean enable)

Description copied from interface: EnablesStroke

Enables or disables the usage of a stroke for the drawn geometries.

Specified by:

setStrokeEnabled in interface EnablesStroke

Parameters:

enable - If true, the stroke will be drawn. If false, it won't be drawn.

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

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:

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