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

Class VectorialUniqueValueLegend

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

All Implemented Interfaces:

Cloneable, DrawingObservable, IClassifiedLegend, IClassifiedVectorLegend, ILegend, IVectorialUniqueValueLegend, IVectorLegend, Legend, Persistent

Direct Known Subclasses:

BarsChartLegend, BasePieChartLegend

public class VectorialUniqueValueLegend
extends AbstractClassifiedVectorLegend
implements IVectorialUniqueValueLegend

Vectorial legend for unique values

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	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, 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.IVectorialUniqueValueLegend

LEGEND_NAME

Constructor Summary

Constructors

Constructor and Description
VectorialUniqueValueLegend()
VectorialUniqueValueLegend(int shapeType) Constructor method

Method Summary

Modifier and Type	Method and Description
void	addSymbol(Object key, ISymbol symbol) Inserts a symbol.
void	clear() Deletes all the information of classification: intervals, values, or other classifying elements
Object	clone() Creates a copy of the object.
void	delSymbol(Object key) Deletes a symbol using for that its key which is the parameter of the method.
String	getClassName()
Color[]	getColorScheme()
ISymbol	getDefaultSymbol() Obtains the default symbol of the legend.
String[]	getDescriptions() Obtains the descriptions of the classes that are in the classification
int	getShapeType() Returns the type of the shape.
ISymbol	getSymbolByFeature(Feature feat) Devuelve un símbolo a partir de una IFeature.
ISymbol	getSymbolByValue(Object key) Returns the symbols starting from its key.
Object	getSymbolKey(ISymbol symbol) Returns the key related to a registered ISymbol or null if it is not registered.
ISymbol[]	getSymbols() Obtains the symbols of each class of the classification for the user.
Object[]	getValues() Obtains the values in relation with each class of the classification
boolean	isUseDefaultSymbol() Devuelve si se utiliza o no el resto de valores para representarse.
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	replace(ISymbol oldSymbol, ISymbol newSymbol) Removes oldSymbol from the Legend and substitutes it with the newSymbol
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setClassifyingFieldNames(String[] fNames) Inserts the name of the field
void	setColorScheme(Color[] cc)
void	setDefaultSymbol(ISymbol s) Establishes the default symbol of a legend.
void	setShapeType(int shapeType) Defines the type of the shape.
void	setValueSymbolByID(int id, ISymbol symbol) Establishes the symbol for the value which is the argument of the function.
void	useDefaultSymbol(boolean b)

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

getZSort, setZSort

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

VECTORIAL_UNIQUE_VALUE_LEGEND_PERSISTENCE_DEFINITION_NAME

public static final String VECTORIAL_UNIQUE_VALUE_LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

VectorialUniqueValueLegend

public VectorialUniqueValueLegend()

VectorialUniqueValueLegend

public VectorialUniqueValueLegend(int shapeType)

Constructor method

Parameters:

shapeType - Type of the shape.

Method Detail

setShapeType

public void setShapeType(int shapeType)

Description copied from interface: IVectorLegend

Defines the type of the shape.

Specified by:

setShapeType in interface IVectorLegend

Parameters:

shapeType - type of the shape.

setValueSymbolByID

public void setValueSymbolByID(int id,
                               ISymbol symbol)

Description copied from interface: IVectorialUniqueValueLegend

Establishes the symbol for the value which is the argument of the function.

Specified by:

setValueSymbolByID in interface IVectorialUniqueValueLegend

Parameters:

id - index.

symbol - symbol.

getValues

public Object[] getValues()

Description copied from interface: IClassifiedLegend

Obtains the values in relation with each class of the classification

Specified by:

getValues in interface IClassifiedLegend

Returns:

DOCUMENT ME!

addSymbol

public void addSymbol(Object key,
                      ISymbol symbol)

Description copied from interface: IClassifiedVectorLegend

Inserts a symbol.

Specified by:

addSymbol in interface IClassifiedVectorLegend

clear

public void clear()

Description copied from interface: IClassifiedVectorLegend

Deletes all the information of classification: intervals, values, or other classifying elements

Specified by:

clear in interface IClassifiedVectorLegend

getDescriptions

public String[] getDescriptions()

Description copied from interface: IClassifiedLegend

Obtains the descriptions of the classes that are in the classification

Specified by:

getDescriptions in interface IClassifiedLegend

Returns:

DOCUMENT ME!

getSymbols

public ISymbol[] getSymbols()

Description copied from interface: IClassifiedLegend

Obtains the symbols of each class of the classification for the user.

Specified by:

getSymbols in interface IClassifiedLegend

Returns:

DOCUMENT ME!

setClassifyingFieldNames

public void setClassifyingFieldNames(String[] fNames)

Description copied from interface: IClassifiedVectorLegend

Inserts the name of the field

Specified by:

setClassifyingFieldNames in interface IClassifiedVectorLegend

Overrides:

setClassifyingFieldNames in class AbstractClassifiedVectorLegend

Parameters:

fNames - Names of the fields. TODO refactor to allow more than one field name

getSymbolByFeature

public ISymbol getSymbolByFeature(Feature feat)
                           throws MapContextException

Devuelve un símbolo a partir de una IFeature. OJO!! Cuando usamos un feature iterator de base de datos el único campo que vendrá rellenado es el de fieldID. Los demás vendrán a nulos para ahorra tiempo de creación.

Specified by:

getSymbolByFeature in interface IVectorLegend

Parameters:

feat - IFeature

Returns:

Símbolo.

Throws:

MapContextException

getDefaultSymbol

public ISymbol getDefaultSymbol()

Description copied from interface: ILegend

Obtains the default symbol of the legend.

Specified by:

getDefaultSymbol in interface ILegend

Specified by:

getDefaultSymbol in interface IVectorLegend

Returns:

default symbol.

setDefaultSymbol

public void setDefaultSymbol(ISymbol s)

Description copied from interface: IVectorLegend

Establishes the default symbol of a legend. In a SingleSymbolLegend the symbol is established by calling this method.

Specified by:

setDefaultSymbol in interface IVectorLegend

Parameters:

s - default symbol.

getSymbolByValue

public ISymbol getSymbolByValue(Object key)

Description copied from interface: IVectorialUniqueValueLegend

Returns the symbols starting from its key.

Specified by:

getSymbolByValue in interface IVectorialUniqueValueLegend

Parameters:

key - ID.

Returns:

symbol associated with the key.

getSymbolKey

public Object getSymbolKey(ISymbol symbol)

Description copied from interface: IVectorialUniqueValueLegend

Returns the key related to a registered ISymbol or null if it is not registered.

Specified by:

getSymbolKey in interface IVectorialUniqueValueLegend

Parameters:

symbol - to look for

Returns:

the related key

getShapeType

public int getShapeType()

Description copied from interface: IVectorLegend

Returns the type of the shape.

Specified by:

getShapeType in interface IVectorLegend

Returns:

Returns the type of the shapes that the legend is ready to use.

useDefaultSymbol

public void useDefaultSymbol(boolean b)

Specified by:

useDefaultSymbol in interface IVectorLegend

isUseDefaultSymbol

public boolean isUseDefaultSymbol()

Devuelve si se utiliza o no el resto de valores para representarse.

Specified by:

isUseDefaultSymbol in interface IVectorLegend

Returns:

True si se utiliza el resto de valores.

delSymbol

public void delSymbol(Object key)

Description copied from interface: IClassifiedVectorLegend

Deletes a symbol using for that its key which is the parameter of the method.

Specified by:

delSymbol in interface IClassifiedVectorLegend

Parameters:

key - clave.

getClassName

public String getClassName()

replace

public void replace(ISymbol oldSymbol,
                    ISymbol newSymbol)

Description copied from interface: IClassifiedVectorLegend

Removes oldSymbol from the Legend and substitutes it with the newSymbol

Specified by:

replace in interface IClassifiedVectorLegend

getColorScheme

public Color[] getColorScheme()

Specified by:

getColorScheme in interface IVectorialUniqueValueLegend

setColorScheme

public void setColorScheme(Color[] cc)

Specified by:

setColorScheme in interface IVectorialUniqueValueLegend

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractClassifiedVectorLegend

Returns:

a copy of the object

Throws:

CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Overrides:

loadFromState in class AbstractClassifiedVectorLegend

Throws:

PersistenceException

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Overrides:

saveToState in class AbstractClassifiedVectorLegend

Throws:

PersistenceException