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

Class AbstractVectorialLegend

java.lang.Object

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

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

All Implemented Interfaces:

java.lang.Cloneable, DrawingObservable, ILegend, IVectorLegend, Persistent

Direct Known Subclasses:

AbstractClassifiedVectorLegend, DefaultVectorComplexLegend, SingleSymbolLegend

public abstract class AbstractVectorialLegend
extends AbstractLegend
implements IVectorLegend

Base implementation for Vectorial data Legends. Provides a draw method implementation which loads the Features and uses the ISymbol objects to draw the Geometry objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractVectorialLegend.RegisterPersistence

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VECTORIAL_LEGEND_PERSISTENCE_DEFINITION_NAME
protected ZSort	zSort

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

LEGEND_PERSISTENCE_DEFINITION_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractVectorialLegend()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a copy of the object.
void	draw(java.awt.image.BufferedImage image, java.awt.Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, java.util.Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore) Draws the FeatureStore data using this legend simbology.
void	draw(java.awt.image.BufferedImage image, java.awt.Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, java.util.Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, FeatureQuery featureQuery) Draws the FeatureStore data using this legend simbology.
protected void	draw(java.awt.image.BufferedImage image, java.awt.Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, java.util.Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, FeatureQuery featureQuery, double dpi) Draws the features from the FeatureStore, filtered with the scale and the query parameters, with the symbols of the legend.
protected abstract java.lang.String[]	getRequiredFeatureAttributeNames(FeatureStore featureStore) Returns the names of the Feature attributes required for the ILegend to operate.
ZSort	getZSort()
protected void	internalDraw(java.awt.image.BufferedImage image, java.awt.Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, java.util.Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, FeatureQuery featureQuery, double dpi, SimpleTaskStatus taskStatus)
void	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	print(java.awt.Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, java.util.Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, FeatureQuery fquery, PrintAttributes properties)
void	print(java.awt.Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, java.util.Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, PrintAttributes properties)
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setZSort(ZSort zSort)

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

getShapeType, getSymbolByFeature, isSuitableForShapeType, isUseDefaultSymbol, 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

VECTORIAL_LEGEND_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String VECTORIAL_LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

zSort

protected ZSort zSort

Constructor Detail

AbstractVectorialLegend

public AbstractVectorialLegend()

Method Detail

getZSort

public ZSort getZSort()

setZSort

public void setZSort(ZSort zSort)

draw

public void draw(java.awt.image.BufferedImage image,
        java.awt.Graphics2D g,
        ViewPort viewPort,
        Cancellable cancel,
        double scale,
        java.util.Map queryParameters,
        ICoordTrans coordTrans,
        FeatureStore featureStore)
          throws LegendException

Description copied from interface: IVectorLegend

Draws the FeatureStore data using this legend simbology.

Specified by:

draw in interface IVectorLegend

Parameters:

image - the base image to draw over

g - the Graphics2D to draw to

viewPort - the ViewPort to use

cancel - the Cancellable delegate object

scale - the scale of the view

queryParameters - the query parameters

coordTrans - the transformation coordinates to use for reprojection

featureStore - FeatureStore to load the data to draw from

Throws:

LegendException

draw

public void draw(java.awt.image.BufferedImage image,
        java.awt.Graphics2D g,
        ViewPort viewPort,
        Cancellable cancel,
        double scale,
        java.util.Map queryParameters,
        ICoordTrans coordTrans,
        FeatureStore featureStore,
        FeatureQuery featureQuery)
          throws LegendException

Description copied from interface: IVectorLegend

Draws the FeatureStore data using this legend simbology.

Specified by:

draw in interface IVectorLegend

Parameters:

image - the base image to draw over

g - the Graphics2D to draw to

viewPort - the ViewPort to use

cancel - the Cancellable delegate object

scale - the scale of the view

queryParameters - the query parameters

coordTrans - the transformation coordinates to use for reprojection

featureStore - FeatureStore to load the data to draw from

featureQuery - the query used to filter the features.

Throws:

LegendException

print

public void print(java.awt.Graphics2D g,
         ViewPort viewPort,
         Cancellable cancel,
         double scale,
         java.util.Map queryParameters,
         ICoordTrans coordTrans,
         FeatureStore featureStore,
         PrintAttributes properties)
           throws LegendException

Specified by:

print in interface IVectorLegend

Throws:

LegendException

print

public void print(java.awt.Graphics2D g,
         ViewPort viewPort,
         Cancellable cancel,
         double scale,
         java.util.Map queryParameters,
         ICoordTrans coordTrans,
         FeatureStore featureStore,
         FeatureQuery fquery,
         PrintAttributes properties)
           throws LegendException

Specified by:

print in interface IVectorLegend

Throws:

LegendException

draw

protected void draw(java.awt.image.BufferedImage image,
        java.awt.Graphics2D g,
        ViewPort viewPort,
        Cancellable cancel,
        double scale,
        java.util.Map queryParameters,
        ICoordTrans coordTrans,
        FeatureStore featureStore,
        FeatureQuery featureQuery,
        double dpi)
             throws LegendException

Draws the features from the FeatureStore, filtered with the scale and the query parameters, with the symbols of the legend.

Throws:

LegendException

internalDraw

protected void internalDraw(java.awt.image.BufferedImage image,
                java.awt.Graphics2D g,
                ViewPort viewPort,
                Cancellable cancel,
                double scale,
                java.util.Map queryParameters,
                ICoordTrans coordTrans,
                FeatureStore featureStore,
                FeatureQuery featureQuery,
                double dpi,
                SimpleTaskStatus taskStatus)
                     throws LegendDrawingException

Throws:

LegendDrawingException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Overrides:

clone in class AbstractLegend

Returns:

a copy of the object

Throws:

java.lang.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 AbstractLegend

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 AbstractLegend

Throws:

PersistenceException

getRequiredFeatureAttributeNames

protected abstract java.lang.String[] getRequiredFeatureAttributeNames(FeatureStore featureStore)
                                                                throws DataException

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

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