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

Class AbstractIntervalLegend

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

All Implemented Interfaces:

Cloneable, DrawingObservable, IClassifiedLegend, IClassifiedVectorLegend, ILegend, IVectorialIntervalLegend, IVectorLegend, Persistent

Direct Known Subclasses:

VectorialIntervalLegend

public abstract class AbstractIntervalLegend
extends AbstractClassifiedVectorLegend
implements IVectorialIntervalLegend

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractIntervalLegend.RegisterPersistence

Field Summary

Fields

Modifier and Type	Field and Description
protected ISymbol	defaultSymbol
static int	EQUAL_INTERVALS
static String	INTERVAL_LEGEND_PERSISTENCE_DEFINITION_NAME
protected int	intervalType
protected List<Object>	keys
static int	NATURAL_INTERVALS
static int	QUANTILE_INTERVALS
protected Map<Object,ISymbol>	symbols
protected boolean	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
AbstractIntervalLegend()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSymbol(Object key, ISymbol symbol) Inserts a symbol.
IInterval[]	calculateIntervals(FeatureStore featureStore, String fieldName, int numIntervalos, int shapeType)
void	clear() Deletes all the information of classification: intervals, values, or other classifying elements
Object	clone() Creates a copy of the object.
Map<IInterval,ISymbol>	createSymbols(IInterval[] intervals)
void	delSymbol(Object obj) Deletes a symbol using for that its key which is the parameter of the method.
ISymbol	getDefaultSymbol() Obtains the default symbol of the legend.
String[]	getDescriptions() Obtains the descriptions of the classes that are in the classification
IInterval	getInterval(Object v)
int	getIntervalType()
ISymbol	getSymbol(FeatureReference featureID)
ISymbol	getSymbolByFeature(Feature feat) Returns a symbol starting from an IFeature.
ISymbol	getSymbolByInterval(IInterval key) Returns the symbol starting from an interval
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() Returns true or false depending on if the rest of values are used.
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	setDefaultSymbol(ISymbol s) Establishes the default symbol of a legend.
void	setIntervals(IInterval[] intervals)
void	setIntervalType(int intervalType) Inserts the type of the classification of the intervals.
void	useDefaultSymbol(boolean b)

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

fireClassifiedSymbolChangeEvent, fireLegendClearEvent, getClassifyingFieldNames, getClassifyingFieldTypes, getRequiredFeatureAttributeNames, isSuitableForShapeType, 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.IVectorialIntervalLegend

getEndColor, getStartColor, setEndColor, setStartColor

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, getShapeType, isSuitableForShapeType, print, print, setShapeType

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

INTERVAL_LEGEND_PERSISTENCE_DEFINITION_NAME

public static final String INTERVAL_LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

keys

protected List<Object> keys

defaultSymbol

protected ISymbol defaultSymbol

intervalType

protected int intervalType

useDefaultSymbol

protected boolean useDefaultSymbol

EQUAL_INTERVALS

public static final int EQUAL_INTERVALS

See Also:

Constant Field Values

NATURAL_INTERVALS

public static final int NATURAL_INTERVALS

See Also:

Constant Field Values

QUANTILE_INTERVALS

public static final int QUANTILE_INTERVALS

See Also:

Constant Field Values

symbols

protected Map<Object,ISymbol> symbols

Constructor Detail

AbstractIntervalLegend

public AbstractIntervalLegend()

Method Detail

addSymbol

public void addSymbol(Object key,
             ISymbol symbol)

Description copied from interface: IClassifiedVectorLegend

Inserts a symbol.

Specified by:

addSymbol in interface IClassifiedVectorLegend

getSymbol

public ISymbol getSymbol(FeatureReference featureID)
                  throws MapContextException,
                         DataException

Throws:

MapContextException

DataException

getSymbolByFeature

public ISymbol getSymbolByFeature(Feature feat)
                           throws MapContextException

Description copied from interface: IVectorLegend

Returns a symbol starting from an IFeature. TAKE CARE!! When we are using a feature iterator as a database the only field that will be filled is the fieldID. The rest of fields will be null to reduce the time of creation

Specified by:

getSymbolByFeature in interface IVectorLegend

Parameters:

feat - IFeature.

Returns:

Símbolo.

Throws:

MapContextException

calculateIntervals

public IInterval[] calculateIntervals(FeatureStore featureStore,
                             String fieldName,
                             int numIntervalos,
                             int shapeType)
                               throws DataException

Specified by:

calculateIntervals in interface IVectorialIntervalLegend

Throws:

DataException

getSymbolByInterval

public ISymbol getSymbolByInterval(IInterval key)

Description copied from interface: IVectorialIntervalLegend

Returns the symbol starting from an interval

Specified by:

getSymbolByInterval in interface IVectorialIntervalLegend

Parameters:

key - interval.

Returns:

symbol.

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!

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!

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

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!

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 IVectorialIntervalLegend

Specified by:

setDefaultSymbol in interface IVectorLegend

Parameters:

s - default symbol.

getDefaultSymbol

public ISymbol getDefaultSymbol()

Description copied from interface: ILegend

Obtains the default symbol of the legend.

Specified by:

getDefaultSymbol in interface ILegend

Returns:

default symbol.

getInterval

public IInterval getInterval(Object v)

Specified by:

getInterval in interface IVectorialIntervalLegend

setIntervalType

public void setIntervalType(int intervalType)

Description copied from interface: IVectorialIntervalLegend

Inserts the type of the classification of the intervals.

Specified by:

setIntervalType in interface IVectorialIntervalLegend

Parameters:

intervalType - type of the classification.

getIntervalType

public int getIntervalType()

Specified by:

getIntervalType in interface IVectorialIntervalLegend

useDefaultSymbol

public void useDefaultSymbol(boolean b)

Specified by:

useDefaultSymbol in interface IVectorLegend

isUseDefaultSymbol

public boolean isUseDefaultSymbol()

Description copied from interface: IVectorLegend

Returns true or false depending on if the rest of values are used.

Specified by:

isUseDefaultSymbol in interface IVectorLegend

Returns:

True if the rest of values are used.

delSymbol

public void delSymbol(Object obj)

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:

obj - clave.

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

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

createSymbols

public Map<IInterval,ISymbol> createSymbols(IInterval[] intervals)

Specified by:

createSymbols in interface IVectorialIntervalLegend

setIntervals

public void setIntervals(IInterval[] intervals)

Specified by:

setIntervals in interface IVectorialIntervalLegend