org.gvsig.symbology.fmap.rendering

Class ProportionalSymbolsLegend

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

org.gvsig.symbology.fmap.rendering.ProportionalSymbolsLegend

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.IVectorialUniqueValueLegend, org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend, org.gvsig.tools.persistence.Persistent

public class ProportionalSymbolsLegend
extends org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialUniqueValueLegend

Implements a legend which represents the quantitative information (numeric values). This representation is possible thanks to a symbol whose size is different each time (depending on the numeric values and if we want to use normalization or not).

Author:

jaume dominguez faus - jaume.dominguez@iver.es, jldominguez

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROPORTIONAL_SYMBOL_LEGEND_NAME
static java.lang.String	PROPORTIONAL_SYMBOL_LEGEND_PERSISTENCE_DEFINITION_NAME

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

VECTORIAL_UNIQUE_VALUE_LEGEND_PERSISTENCE_DEFINITION_NAME

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

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

LEGEND_NAME

Constructor Summary

Constructors

Constructor and Description
ProportionalSymbolsLegend()

Method Summary

Methods

Modifier and Type	Method and Description
org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol	getBackgroundSymbol() Gets the background symbol which only can appear when the shapetype of the layer is polygonal
double	getMaxFeature() Obtains the variable which represents the maximum value of the classifying field that is used to calculate the size of the symbol
double	getMaxSize() Obtains the maximum size for the symbol
double	getMinFeature() Obtains the variable which represents the minimum value of the classifying field that is used to calculate the size of the symbol
double	getMinSize() Obtains the minimum size for the symbol
java.lang.String	getNormalizationField() Obtains the classifying field name to be used to calculate the size of the symbol when the user is doing it with a normalization value.
org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol	getSymbolByFeature(org.gvsig.fmap.dal.feature.Feature feat)
org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol	getSymbolByValue(java.lang.Object key)
org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol[]	getSymbols()
int	getTemplateShapeType() Obtains the shapetype of the template symbol
boolean	getUseNormalization() Obtains the boolean which is true if the user wants to calculate the size of the symbol using a normalization field.
java.lang.String	getValueField() Obtains the classifying field name to be used to calculate the size of the symbol
org.gvsig.fmap.mapcontext.rendering.legend.ZSort	getZSort()
static boolean	isLinear(int ty)
static boolean	isPoint(int ty)
static boolean	isPolygonal(int ty)
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 backgroundSymbol) Sets the background symbol which is used only when the shapetype of the layer is polygonal
void	setClassifyingFieldNames(java.lang.String[] fNames)
void	setMaxFeature(double maxFeature) Sets the variable which represents the maximum value of the classifying field that is used to calculate the size of the symbol
void	setMaxSize(double maxSize) Sets the maximum size for the symbol
void	setMinFeature(double minFeature) Sets the variable which represents the minimum value of the classifying field that is used to calculate the size of the symbol
void	setMinSize(double minSize) Sets the minimum size for the symbol
void	setNormalizationField(java.lang.String normalizationField) Sets the classifying field name to be used to calculate the size of the symbol when the user is doing it with a normalization value.
void	setTemplateShapeType(int tst) Sets the shapetype of the template symbol
void	setUseNormalization(boolean useNormalization) Sets the boolean which is true if the user wants to calculate the size of the symbol using a normalization field.
void	setValueField(java.lang.String valueField) Sets the classifying field name to be used to calculate the size of the symbol
void	setZSort(org.gvsig.fmap.mapcontext.rendering.legend.ZSort zSort)

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

addSymbol, clear, clone, delSymbol, getClassName, getColorScheme, getDefaultSymbol, getDescriptions, getShapeType, getSymbolKey, getValues, isUseDefaultSymbol, replace, setColorScheme, setDefaultSymbol, setShapeType, setValueSymbolByID, useDefaultSymbol

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

fireClassifiedSymbolChangeEvent, fireLegendClearEvent, getClassifyingFieldNames, getClassifyingFieldTypes, getRequiredFeatureAttributeNames, isSuitableForShapeType, setClassifyingFieldTypes

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

draw, draw, draw, internalDraw, print, print

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

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

draw, draw, isSuitableForShapeType, 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

PROPORTIONAL_SYMBOL_LEGEND_NAME

public static final java.lang.String PROPORTIONAL_SYMBOL_LEGEND_NAME

See Also:

Constant Field Values

PROPORTIONAL_SYMBOL_LEGEND_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String PROPORTIONAL_SYMBOL_LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

ProportionalSymbolsLegend

public ProportionalSymbolsLegend()

Method Detail

getBackgroundSymbol

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

Gets the background symbol which only can appear when the shapetype of the layer is polygonal

Returns:

ISymbol the symbol for the background

getMaxFeature

public double getMaxFeature()

Obtains the variable which represents the maximum value of the classifying field that is used to calculate the size of the symbol

Returns:

double the maximum value of the classifying field

getMaxSize

public double getMaxSize()

Obtains the maximum size for the symbol

Returns:

double the minimum size for the symbol

getMinFeature

public double getMinFeature()

Obtains the variable which represents the minimum value of the classifying field that is used to calculate the size of the symbol

Returns:

double the minimum value of the classifying field

getMinSize

public double getMinSize()

Obtains the minimum size for the symbol

Returns:

double the minimum size for the symbol

getNormalizationField

public java.lang.String getNormalizationField()

Obtains the classifying field name to be used to calculate the size of the symbol when the user is doing it with a normalization value.

Returns:

String the name of the field

getSymbolByFeature

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

Specified by:

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

Overrides:

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

getSymbolByValue

public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol getSymbolByValue(java.lang.Object key)

Specified by:

getSymbolByValue in interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorialUniqueValueLegend

Overrides:

getSymbolByValue in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialUniqueValueLegend

getSymbols

public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol[] getSymbols()

Specified by:

getSymbols in interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedLegend

Overrides:

getSymbols in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialUniqueValueLegend

getTemplateShapeType

public int getTemplateShapeType()

Obtains the shapetype of the template symbol

Returns:

int shape type for the template symbol

getUseNormalization

public boolean getUseNormalization()

Obtains the boolean which is true if the user wants to calculate the size of the symbol using a normalization field.

Returns:

boolean true if the user wants normalization.Otherwise, false.

getValueField

public java.lang.String getValueField()

Obtains the classifying field name to be used to calculate the size of the symbol

Returns:

String the name of the field

Throws:

ReadDriverException

getZSort

public org.gvsig.fmap.mapcontext.rendering.legend.ZSort getZSort()

Specified by:

getZSort in interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorialUniqueValueLegend

Overrides:

getZSort in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend

isLinear

public static boolean isLinear(int ty)

isPoint

public static boolean isPoint(int ty)

isPolygonal

public static boolean isPolygonal(int ty)

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

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

Throws:

org.gvsig.tools.persistence.exception.PersistenceException

setBackgroundSymbol

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

Sets the background symbol which is used only when the shapetype of the layer is polygonal

Parameters:

backgroundSymbol - the symbol for the background

setClassifyingFieldNames

public void setClassifyingFieldNames(java.lang.String[] fNames)

Specified by:

setClassifyingFieldNames in interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend

Overrides:

setClassifyingFieldNames in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialUniqueValueLegend

setMaxFeature

public void setMaxFeature(double maxFeature)

Sets the variable which represents the maximum value of the classifying field that is used to calculate the size of the symbol

Parameters:

maxFeature -

setMaxSize

public void setMaxSize(double maxSize)

Sets the maximum size for the symbol

Parameters:

maxSize - the minimum size for the symbol

setMinFeature

public void setMinFeature(double minFeature)

Sets the variable which represents the minimum value of the classifying field that is used to calculate the size of the symbol

Parameters:

minFeature -

setMinSize

public void setMinSize(double minSize)

Sets the minimum size for the symbol

Parameters:

minSize - the minimum size for the symbol

setNormalizationField

public void setNormalizationField(java.lang.String normalizationField)

Sets the classifying field name to be used to calculate the size of the symbol when the user is doing it with a normalization value.

Parameters:

String - the name of the field

setTemplateShapeType

public void setTemplateShapeType(int tst)

Sets the shapetype of the template symbol

Parameters:

templateShapeType - shape type for the template symbol

setUseNormalization

public void setUseNormalization(boolean useNormalization)

Sets the boolean which is true if the user wants to calculate the size of the symbol using a normalization field.

Parameters:

useNormalization - true if the user wants normalization.Otherwise, false.

setValueField

public void setValueField(java.lang.String valueField)

Sets the classifying field name to be used to calculate the size of the symbol

Parameters:

String - the name of the field

setZSort

public void setZSort(org.gvsig.fmap.mapcontext.rendering.legend.ZSort zSort)

Specified by:

setZSort in interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorialUniqueValueLegend

Overrides:

setZSort in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractVectorialLegend