org.gvsig.complexlegend.impl

Class DefaultVectorComplexLegend

java.lang.Object

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

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

org.gvsig.complexlegend.impl.DefaultVectorComplexLegend

All Implemented Interfaces:

java.lang.Cloneable, VectorComplexLegend, DrawingObservable, IClassifiedLegend, ILegend, IVectorLegend, Legend, Persistent

public class DefaultVectorComplexLegend
extends AbstractVectorialLegend
implements VectorComplexLegend, Persistent

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPLEX_LEGEND_FIELD
static java.lang.String	COMPLEX_LEGEND_NAME
static java.lang.String	COMPLEX_LEGEND_PERSISTENCE_DEFINITION_NAME

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

LOG, 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
DefaultVectorComplexLegend()

Method Summary

Modifier and Type	Method and Description
boolean	add(ComplexLegendItem legend)
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.
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.
boolean	getAllowOverlap()
ISymbol	getDefaultSymbol() Obtains the default symbol of the legend.
java.lang.String[]	getDescriptions() Obtains the descriptions of the classes that are in the classification
java.util.List<ComplexLegendItem>	getEditedLegends()
ComplexLegendItem	getLegend(double scale)
java.util.List<ComplexLegendItem>	getLegends()
java.util.List<ComplexLegendItem>	getLegendsInScale(double scale)
protected java.lang.String[]	getRequiredFeatureAttributeNames(FeatureStore featureStore) Returns the names of the Feature attributes required for the ILegend to operate.
int	getShapeType() Returns the type of the shape.
ISymbol	getSymbolByFeature(Feature feat) Returns a symbol starting from an IFeature.
ISymbol[]	getSymbols() Obtains the symbols of each class of the classification for the user.
java.lang.Object[]	getValues() Obtains the values in relation with each class of the classification
boolean	isOverlapped(ComplexLegendItem legend)
boolean	isSuitableForShapeType(int shapeType)
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	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)
boolean	remove(ComplexLegendItem legend)
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
void	setAllowOverlap(boolean allowOverlap)
void	setDefaultSymbol(ISymbol s) Establishes the default symbol of a legend.
void	setShapeType(int shapeType) Defines the type of the shape.
void	useDefaultSymbol(boolean b)

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

draw, drawFeatures, getZSort, internalDraw, isDrawSymbolInEeachPrimitive, setDrawSymbolInEeachPrimitive, 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.IVectorLegend

draw

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

addDrawingObserver, deleteDrawingObserver, deleteDrawingObservers

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

addLegendListener, cloneLegend, fireDefaultSymbolChangedEvent, getListeners, removeLegendListener

Methods inherited from interface org.gvsig.tools.lang.Cloneable

cloneQuietly, cloneQuietly

Field Detail

COMPLEX_LEGEND_PERSISTENCE_DEFINITION_NAME

public static final java.lang.String COMPLEX_LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

COMPLEX_LEGEND_NAME

public static final java.lang.String COMPLEX_LEGEND_NAME

See Also:

Constant Field Values

COMPLEX_LEGEND_FIELD

public static final java.lang.String COMPLEX_LEGEND_FIELD

See Also:

Constant Field Values

Constructor Detail

DefaultVectorComplexLegend

public DefaultVectorComplexLegend()

Method Detail

getLegends

public java.util.List<ComplexLegendItem> getLegends()

Specified by:

getLegends in interface VectorComplexLegend

getEditedLegends

public java.util.List<ComplexLegendItem> getEditedLegends()

isOverlapped

public boolean isOverlapped(ComplexLegendItem legend)

Specified by:

isOverlapped in interface VectorComplexLegend

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 AbstractVectorialLegend

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()}.

add

public boolean add(ComplexLegendItem legend)

Specified by:

add in interface VectorComplexLegend

remove

public boolean remove(ComplexLegendItem legend)

Specified by:

remove in interface VectorComplexLegend

getLegend

public ComplexLegendItem getLegend(double scale)

Specified by:

getLegend in interface VectorComplexLegend

getLegendsInScale

public java.util.List<ComplexLegendItem> getLegendsInScale(double scale)

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

Overrides:

print in class AbstractVectorialLegend

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

Overrides:

print in class AbstractVectorialLegend

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)
          throws LegendException

Description copied from interface: IVectorLegend

Draws the FeatureStore data using this legend simbology.

Specified by:

draw in interface IVectorLegend

Overrides:

draw in class AbstractVectorialLegend

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

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

Description copied from class: AbstractVectorialLegend

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

Overrides:

draw in class AbstractVectorialLegend

Throws:

LegendException

getAllowOverlap

public boolean getAllowOverlap()

Specified by:

getAllowOverlap in interface VectorComplexLegend

setAllowOverlap

public void setAllowOverlap(boolean allowOverlap)

Specified by:

setAllowOverlap in interface VectorComplexLegend

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

getSymbolByFeature

public ISymbol getSymbolByFeature(Feature feat)
                           throws MapContextException

Description copied from interface: IVectorLegend

Returns a symbol starting from an IFeature.

Specified by:

getSymbolByFeature in interface IVectorLegend

Parameters:

feat - IFeature.

Returns:

Símbolo.

Throws:

MapContextException

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.

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.

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.

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.

useDefaultSymbol

public void useDefaultSymbol(boolean b)

Specified by:

useDefaultSymbol in interface IVectorLegend

isSuitableForShapeType

public boolean isSuitableForShapeType(int shapeType)

Specified by:

isSuitableForShapeType in interface IVectorLegend

getDefaultSymbol

public ISymbol getDefaultSymbol()

Description copied from interface: IVectorLegend

Obtains the default symbol of the legend.

Specified by:

getDefaultSymbol in interface ILegend

Specified by:

getDefaultSymbol in interface IVectorLegend

Returns:

default symbol.

getRequiredFeatureAttributeNames

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

getDescriptions

public java.lang.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!

getValues

public java.lang.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!