org.gvsig.symbology.fmap.rendering

Class GraduatedSymbolsLegend

java.lang.Object

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractIntervalLegend

org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend

org.gvsig.symbology.fmap.rendering.GraduatedSymbolsLegend

All Implemented Interfaces:

java.lang.Cloneable, org.gvsig.fmap.mapcontext.rendering.legend.DrawingObservable, org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedLegend, org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend, org.gvsig.fmap.mapcontext.rendering.legend.ILegend, org.gvsig.fmap.mapcontext.rendering.legend.IVectorialIntervalLegend, org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend, org.gvsig.tools.persistence.Persistent

public class GraduatedSymbolsLegend
extends org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend

GraduatedSymbolLegend is a legend that allows to classify ranges of values using a value with symbol sizes.

The symbol size will be calculated according the min size, the max size and the amount of intervals. So for a min size of 1, a max size of 5, and 5 intervals, symbol sizes will be [1, 2, 3, 4, 5].

Author:

jaume dominguez faus - jaume.dominguez@iver.es

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraduatedSymbolsLegend.RegisterLegend
static class	GraduatedSymbolsLegend.RegisterPersistence

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GRADUATED_SYMBOL_LEGEND_NAME
static java.lang.String	GRADUATED_SYMBOL_LEGEND_PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend

VECTORIAL_INTERVAL_LEGEND_PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractIntervalLegend

defaultSymbol, EQUAL_INTERVALS, INTERVAL_LEGEND_PERSISTENCE_DEFINITION_NAME, intervalType, keys, NATURAL_INTERVALS, QUANTILE_INTERVALS, symbols, useDefaultSymbol

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend

CLASSIFIED_VECTOR_LEGEND_PERSISTENCE_DEFINITION_NAME

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

VECTORIAL_LEGEND_PERSISTENCE_DEFINITION_NAME, zSort

Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend

LEGEND_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorialIntervalLegend

LEGEND_NAME

Constructor Summary

Constructors

Constructor and Description
GraduatedSymbolsLegend() DefaultConstructor
GraduatedSymbolsLegend(org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend leg) Convenience constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	areSameBasicType(int ta, int tb)
org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol	getBackgroundSymbol() Obtains the background symbol
org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol	getDefaultSymbol()
double	getMaxSymbolSize() Returns the max symbol size.
double	getMinSymbolSize() Returns the min symbol size.
org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol	getSymbolByFeature(org.gvsig.fmap.dal.feature.Feature feat)
org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol	getSymbolByInterval(org.gvsig.fmap.mapcontext.rendering.legend.IInterval key)
int	getTemplateShapeType() Obtains the shapetype of the background symbol
static boolean	isLinear(int ty)
static boolean	isPoint(int ty)
static boolean	isPolygonal(int ty)
boolean	isSuitableForShapeType(int st)
void	loadFromState(org.gvsig.tools.persistence.PersistentState state)
void	saveToState(org.gvsig.tools.persistence.PersistentState state)
void	setBackgroundSymbol(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol symbol) Sets the background symbol.
void	setMaxSymbolSize(double size) Sets the max symbol size.
void	setMinSymbolSize(double size) Sets the min symbol size.
void	setTemplateShapeType(int tst) Sets the shapetype of the background symbol
static org.gvsig.symbology.fmap.mapcontext.rendering.symbol.fill.IFillSymbol	toFillSymbol(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol sym)

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend

clone, createInterval, getClassName, getEndColor, getShapeType, getStartColor, setEndColor, setShapeType, setStartColor

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractIntervalLegend

addSymbol, calculateIntervals, clear, delSymbol, getDescriptions, getInterval, getIntervalType, getSymbol, getSymbols, getValues, isUseDefaultSymbol, replace, setDefaultSymbol, setIntervalType, useDefaultSymbol

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend

fireClassifiedSymbolChangeEvent, fireLegendClearEvent, getClassifyingFieldNames, getClassifyingFieldTypes, getRequiredFeatureAttributeNames, setClassifyingFieldNames, setClassifyingFieldTypes

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

draw, draw, draw, getZSort, internalDraw, print, print, setZSort

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend

addDrawingObserver, addLegendListener, addObserver, beginComplexNotification, cloneLegend, countObservers, deleteDrawingObserver, deleteDrawingObservers, deleteObserver, disableNotifications, enableNotifications, endComplexNotification, fireDefaultSymbolChangedEvent, getListeners, getManager, getSymbolManager, inComplex, isEnabledNotifications, notifyObservers, notifyObservers, removeLegendListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend

getClassifyingFieldNames, getClassifyingFieldTypes, setClassifyingFieldNames, setClassifyingFieldTypes

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend

draw, draw, print, print

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.ILegend

addLegendListener, cloneLegend, fireDefaultSymbolChangedEvent, getListeners, removeLegendListener

Methods inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.DrawingObservable

addDrawingObserver, deleteDrawingObserver, deleteDrawingObservers

Field Detail

GRADUATED_SYMBOL_LEGEND_NAME

public static final java.lang.String GRADUATED_SYMBOL_LEGEND_NAME

See Also:

Constant Field Values

GRADUATED_SYMBOL_LEGEND_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String GRADUATED_SYMBOL_LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

GraduatedSymbolsLegend

public GraduatedSymbolsLegend()

DefaultConstructor

GraduatedSymbolsLegend

public GraduatedSymbolsLegend(org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend leg)

Convenience constructor. Creates a new instance of GraduatedSymbolLegend from a VectorialIntervalLegend by taking the same fields.

Parameters:

leg -

Method Detail

areSameBasicType

public static boolean areSameBasicType(int ta,
                       int tb)

getBackgroundSymbol

public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol getBackgroundSymbol()

Obtains the background symbol

getDefaultSymbol

public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol getDefaultSymbol()

Specified by:

getDefaultSymbol in interface org.gvsig.fmap.mapcontext.rendering.legend.ILegend

Overrides:

getDefaultSymbol in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractIntervalLegend

getMaxSymbolSize

public double getMaxSymbolSize()

Returns the max symbol size. Combined with the min symbol size and the interval count, will produce the symbol sizes.

Returns:

double, the max size.

getMinSymbolSize

public double getMinSymbolSize()

Returns the min symbol size. Combined with the max symbol size and the interval count, will produce the symbol sizes.

Returns:

double, the min size.

getSymbolByFeature

public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol getSymbolByFeature(org.gvsig.fmap.dal.feature.Feature feat)
                                                                       throws org.gvsig.fmap.mapcontext.MapContextException

Specified by:

getSymbolByFeature in interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend

Overrides:

getSymbolByFeature in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractIntervalLegend

Throws:

org.gvsig.fmap.mapcontext.MapContextException

getSymbolByInterval

public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol getSymbolByInterval(org.gvsig.fmap.mapcontext.rendering.legend.IInterval key)

Specified by:

getSymbolByInterval in interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorialIntervalLegend

Overrides:

getSymbolByInterval in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractIntervalLegend

getTemplateShapeType

public int getTemplateShapeType()

Obtains the shapetype of the background symbol

isLinear

public static boolean isLinear(int ty)

isPoint

public static boolean isPoint(int ty)

isPolygonal

public static boolean isPolygonal(int ty)

isSuitableForShapeType

public boolean isSuitableForShapeType(int st)

Specified by:

isSuitableForShapeType in interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend

Overrides:

isSuitableForShapeType in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend

loadFromState

public void loadFromState(org.gvsig.tools.persistence.PersistentState state)
                   throws org.gvsig.tools.persistence.exception.PersistenceException

Specified by:

loadFromState in interface org.gvsig.tools.persistence.Persistent

Overrides:

loadFromState in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend

Throws:

org.gvsig.tools.persistence.exception.PersistenceException

saveToState

public void saveToState(org.gvsig.tools.persistence.PersistentState state)
                 throws org.gvsig.tools.persistence.exception.PersistenceException

Specified by:

saveToState in interface org.gvsig.tools.persistence.Persistent

Overrides:

saveToState in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend

Throws:

org.gvsig.tools.persistence.exception.PersistenceException

setBackgroundSymbol

public void setBackgroundSymbol(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol symbol)

Sets the background symbol.

Parameters:

symbol -

setMaxSymbolSize

public void setMaxSymbolSize(double size)

Sets the max symbol size. Combined with the min symbol size and the interval count, will produce the symbol sizes.

setMinSymbolSize

public void setMinSymbolSize(double size)

Sets the min symbol size. Combined with the max symbol size and the interval count, will produce the symbol sizes.

setTemplateShapeType

public void setTemplateShapeType(int tst)

Sets the shapetype of the background symbol

toFillSymbol

public static org.gvsig.symbology.fmap.mapcontext.rendering.symbol.fill.IFillSymbol toFillSymbol(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol sym)