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

Class AbstractClassifiedVectorLegend

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractIntervalLegend, VectorialUniqueValueLegend

public abstract class AbstractClassifiedVectorLegend
extends AbstractVectorialLegend
implements IClassifiedVectorLegend

Abstract class that implements the interface for legends composed by classified symbols.It will have two methods that will be executed depending on the action that had been done with the legend (addition of a new symbol or clear the legend).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractClassifiedVectorLegend.RegisterPersistence

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractClassifiedVectorLegend()

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Creates a copy of the object.
void	fireClassifiedSymbolChangeEvent(SymbolLegendEvent event) Looks for a change in a classified symbol of a legend.
void	fireLegendClearEvent(LegendClearEvent event) Looks for a change in a legend of classified symbols.
String[]	getClassifyingFieldNames() Returns the name of the field
int[]	getClassifyingFieldTypes()
protected String[]	getRequiredFeatureAttributeNames(FeatureStore featureStore) Returns the names of the Feature attributes required for the ILegend to operate.
boolean	isSuitableForShapeType(int shapeType)
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setClassifyingFieldNames(String[] fieldNames) Inserts the name of the field
void	setClassifyingFieldTypes(int[] fieldTypes)

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

addSymbol, clear, delSymbol, replace

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

getDescriptions, getSymbols, getValues

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

draw, draw, getShapeType, getSymbolByFeature, isUseDefaultSymbol, print, print, setDefaultSymbol, setShapeType, useDefaultSymbol

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

addLegendListener, cloneLegend, fireDefaultSymbolChangedEvent, getDefaultSymbol, getListeners, removeLegendListener

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

addDrawingObserver, deleteDrawingObserver, deleteDrawingObservers

Field Detail

CLASSIFIED_VECTOR_LEGEND_PERSISTENCE_DEFINITION_NAME

public static final String CLASSIFIED_VECTOR_LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

Constructor Detail

AbstractClassifiedVectorLegend

public AbstractClassifiedVectorLegend()

Method Detail

fireClassifiedSymbolChangeEvent

public void fireClassifiedSymbolChangeEvent(SymbolLegendEvent event)

Looks for a change in a classified symbol of a legend. To perform it, the Array of LegendListeners is scaned and when the corresponding listener is true, the method is invoked and the change will be done.

Parameters:

event -

fireLegendClearEvent

public void fireLegendClearEvent(LegendClearEvent event)

Looks for a change in a legend of classified symbols. In this case if the specific legend is cleared.

Parameters:

event -

getClassifyingFieldNames

public String[] getClassifyingFieldNames()

Description copied from interface: IClassifiedVectorLegend

Returns the name of the field

Specified by:

getClassifyingFieldNames in interface IClassifiedVectorLegend

Returns:

Name of the field. TODO refactor to allow more than one field name

setClassifyingFieldNames

public void setClassifyingFieldNames(String[] fieldNames)

Description copied from interface: IClassifiedVectorLegend

Inserts the name of the field

Specified by:

setClassifyingFieldNames in interface IClassifiedVectorLegend

Parameters:

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

getClassifyingFieldTypes

public int[] getClassifyingFieldTypes()

Specified by:

getClassifyingFieldTypes in interface IClassifiedVectorLegend

setClassifyingFieldTypes

public void setClassifyingFieldTypes(int[] fieldTypes)

Specified by:

setClassifyingFieldTypes in interface IClassifiedVectorLegend

isSuitableForShapeType

public boolean isSuitableForShapeType(int shapeType)

Specified by:

isSuitableForShapeType in interface IVectorLegend

getRequiredFeatureAttributeNames

protected String[] getRequiredFeatureAttributeNames(FeatureStore featureStore)
                                             throws DataException

Description copied from class: AbstractVectorialLegend

Returns the names of the Feature attributes required for the ILegend to operate.

Specified by:

getRequiredFeatureAttributeNames in class AbstractVectorialLegend

Parameters:

featureStore - the store where the Features belong to

Returns:

the names of required Feature attribute names

Throws:

DataException - if there is an error getting the attribute names

clone

public Object clone()
             throws CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractVectorialLegend

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 AbstractVectorialLegend

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 AbstractVectorialLegend

Throws:

PersistenceException