org.gvsig.project.documents.view.legend

Class BarsChartLegend

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

org.gvsig.project.documents.view.legend.BarsChartLegend

All Implemented Interfaces:

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

public class BarsChartLegend
extends VectorialUniqueValueLegend
implements IBarsChartLegend

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ISymbol	backgroundSymbol
static String	BARS_CHART_LEGEND_PERSISTENCE_DEFINITION_NAME
protected Color[]	colors
protected FeatureSelection	featSelection
protected String	fieldNormalize
protected String[]	fields
protected String	fieldSize
protected boolean	is3D
protected boolean	isActiveLimits
protected boolean	isOutlineShow
protected String[]	labels
protected double	maxFeature
protected double	minFeature
protected boolean	onlySelection
protected Color	outlineColor
protected int	outlineWidth
protected int	referenceSystem
protected int	size
protected int	sizeFrom
protected int	sizeOption
protected int	sizeTo
protected IChartSymbol	symbol
protected int	unit
protected ZSort	zSort

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

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

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

LEGEND_PERSISTENCE_DEFINITION_NAME

Fields inherited from interface org.gvsig.chart.legend.IChartLegend

BARSCHART_LEGEND_NAME, LINKED_LEGEND_NAME, PIECHART_LEGEND_NAME

Fields inherited from interface org.gvsig.fmap.mapcontext.rendering.legend.IVectorialUniqueValueLegend

LEGEND_NAME

Constructor Summary

Constructors

Constructor and Description
BarsChartLegend()
BarsChartLegend(int shapeType)

Method Summary

Modifier and Type	Method and Description
void	draw(BufferedImage image, Graphics2D g, ViewPort viewPort, Cancellable cancel, double scale, Map queryParameters, ICoordTrans coordTrans, FeatureStore featureStore, FeatureQuery featureQuery) Draws the FeatureStore data using this legend simbology.
ISymbol	getBackgroundSymbol() Gets the background symbol of this legend
Color[]	getColors() Gets the colors of represent different parts of chart symbol
String[]	getFieldLabels() Gets the field's labels of the chart.
String[]	getFieldNames()
String	getFieldNormalize() Gets the field to represent the normalize size of chart.
String	getFieldSize() Gets the field to represent the size of chart.
Color	getOutlineColor() Return the color of the outline
int	getOutlineWidth() Return the width of the outline
int	getReferenceSystem()
int	getSize() Return the size of symbol
int	getSizeFrom() Gets the limit size minimum of chart.
int	getSizeOption() Gets the size option: IPieSymbol.SIZEFIXED, IPieSymbol.SIZESUM or IPieSymbol.SIZEFIELD
int	getSizeTo() Gets the limit size maximum of chart.
ISymbol	getSymbolByFeature(Feature feat) Devuelve un símbolo a partir de una IFeature.
int	getUnit() Gets the selected unit, the default selected is in pixels.
boolean	is3D() Return true if the chart is 3D.
boolean	isActiveLimits() Gets if the limits of size chart are active.
boolean	isOnlySelection() Gets if draw only diagrams of selection.
boolean	isOutlineShow() Return true if the chart show outline
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	setActiveLimits(boolean b) Sets if the limits of size chart are active.
void	setBackgroundSymbol(ISymbol backgroundSymbol) Sets the background symbol of this legend
void	setColors(Color[] colors) Sets the colors of represent different parts of chart symbol
void	setFieldNormalize(String f) Sets the field to represent the normalize size of chart.
void	setFields(String[] fields) Only the fields that will be used inside the Chart (you don't have to include here getFieldSize or getFieldNormalize)
void	setFieldSize(String f) Sets the field to represent the size of chart.
void	setIs3D(boolean b) Sets if the chart is 3D
void	setLabels(String[] fields)
void	setMaxFeature(double max)
void	setMinFeature(double min)
void	setOnlySelection(boolean onlySelection) Draw only the diagram of selection.
void	setOutlineColor(Color outlineColor) Sets the color of outline
void	setOutlineShow(boolean isOutlineShow) Sets if the chart show outline
void	setOutlineWidth(int outlineWidth) Sets the width of outline
void	setReferenceSystem(int rs)
void	setSize(int size) Sets size of symbols with the fixed size selected
void	setSizeFrom(int s) Sets the limit size minimum of chart.
void	setSizeOption(int option) Sets the size option: IPieSymbol.SIZEFIXED, IPieSymbol.SIZESUM or IPieSymbol.SIZEFIELD
void	setSizeTo(int s) Sets the limit size maximum of chart.
void	setUnit(int unit) Sets the selected unit, the default selected is in pixels.

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

addSymbol, clear, clone, delSymbol, getClassName, getColorScheme, getDefaultSymbol, getDescriptions, getShapeType, getSymbolByValue, getSymbolKey, getSymbols, getValues, isUseDefaultSymbol, replace, setClassifyingFieldNames, setColorScheme, setDefaultSymbol, setShapeType, setValueSymbolByID, useDefaultSymbol

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, 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

getColorScheme, getSymbolByValue, getSymbolKey, getZSort, setColorScheme, setValueSymbolByID, setZSort

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

addSymbol, clear, delSymbol, getClassifyingFieldNames, getClassifyingFieldTypes, replace, setClassifyingFieldNames, setClassifyingFieldTypes

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, getDefaultSymbol, getShapeType, isSuitableForShapeType, isUseDefaultSymbol, print, print, setDefaultSymbol, setShapeType, useDefaultSymbol

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

clone

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

addDrawingObserver, deleteDrawingObserver, deleteDrawingObservers

Field Detail

BARS_CHART_LEGEND_PERSISTENCE_DEFINITION_NAME

public static final String BARS_CHART_LEGEND_PERSISTENCE_DEFINITION_NAME

See Also:

Constant Field Values

backgroundSymbol

protected ISymbol backgroundSymbol

fields

protected String[] fields

labels

protected String[] labels

size

protected int size

is3D

protected boolean is3D

isOutlineShow

protected boolean isOutlineShow

outlineColor

protected Color outlineColor

outlineWidth

protected int outlineWidth

onlySelection

protected boolean onlySelection

referenceSystem

protected int referenceSystem

fieldSize

protected String fieldSize

fieldNormalize

protected String fieldNormalize

sizeFrom

protected int sizeFrom

sizeTo

protected int sizeTo

unit

protected int unit

sizeOption

protected int sizeOption

zSort

protected ZSort zSort

isActiveLimits

protected boolean isActiveLimits

minFeature

protected double minFeature

maxFeature

protected double maxFeature

colors

protected Color[] colors

symbol

protected IChartSymbol symbol

featSelection

protected FeatureSelection featSelection

Constructor Detail

BarsChartLegend

public BarsChartLegend()

BarsChartLegend

public BarsChartLegend(int shapeType)

Method Detail

draw

public void draw(BufferedImage image,
                 Graphics2D g,
                 ViewPort viewPort,
                 Cancellable cancel,
                 double scale,
                 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

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

featureQuery - the query used to filter the features.

Throws:

LegendException

is3D

public boolean is3D()

Description copied from interface: IChartLegend

Return true if the chart is 3D.

Specified by:

is3D in interface IChartLegend

Returns:

boolean if the chart is 3D

setIs3D

public void setIs3D(boolean b)

Description copied from interface: IChartLegend

Sets if the chart is 3D

Specified by:

setIs3D in interface IChartLegend

getSize

public int getSize()

Description copied from interface: IChartLegend

Return the size of symbol

Specified by:

getSize in interface IChartLegend

Returns:

int Size of symbol

setSize

public void setSize(int size)

Description copied from interface: IChartLegend

Sets size of symbols with the fixed size selected

Specified by:

setSize in interface IChartLegend

isOutlineShow

public boolean isOutlineShow()

Description copied from interface: IChartLegend

Return true if the chart show outline

Specified by:

isOutlineShow in interface IChartLegend

Returns:

boolean if chart show outline

setOutlineShow

public void setOutlineShow(boolean isOutlineShow)

Description copied from interface: IChartLegend

Sets if the chart show outline

Specified by:

setOutlineShow in interface IChartLegend

getOutlineColor

public Color getOutlineColor()

Description copied from interface: IChartLegend

Return the color of the outline

Specified by:

getOutlineColor in interface IChartLegend

Returns:

Color of outline

setOutlineColor

public void setOutlineColor(Color outlineColor)

Description copied from interface: IChartLegend

Sets the color of outline

Specified by:

setOutlineColor in interface IChartLegend

getOutlineWidth

public int getOutlineWidth()

Description copied from interface: IChartLegend

Return the width of the outline

Specified by:

getOutlineWidth in interface IChartLegend

Returns:

int width of outline

setOutlineWidth

public void setOutlineWidth(int outlineWidth)

Description copied from interface: IChartLegend

Sets the width of outline

Specified by:

setOutlineWidth in interface IChartLegend

setOnlySelection

public void setOnlySelection(boolean onlySelection)

Description copied from interface: IChartLegend

Draw only the diagram of selection.

Specified by:

setOnlySelection in interface IChartLegend

isOnlySelection

public boolean isOnlySelection()

Description copied from interface: IChartLegend

Gets if draw only diagrams of selection.

Specified by:

isOnlySelection in interface IChartLegend

Returns:

boolean true if draw only selection.

getBackgroundSymbol

public ISymbol getBackgroundSymbol()

Description copied from interface: IChartLegend

Gets the background symbol of this legend

Specified by:

getBackgroundSymbol in interface IChartLegend

Returns:

ISymbol the symbol for the background

setBackgroundSymbol

public void setBackgroundSymbol(ISymbol backgroundSymbol)

Description copied from interface: IChartLegend

Sets the background symbol of this legend

Specified by:

setBackgroundSymbol in interface IChartLegend

Parameters:

backgroundSymbol - the symbol for the background

getSizeOption

public int getSizeOption()

Description copied from interface: IChartLegend

Gets the size option: IPieSymbol.SIZEFIXED, IPieSymbol.SIZESUM or IPieSymbol.SIZEFIELD

Specified by:

getSizeOption in interface IChartLegend

Returns:

integer to represents the option.

getFieldSize

public String getFieldSize()

Description copied from interface: IChartLegend

Gets the field to represent the size of chart.

Specified by:

getFieldSize in interface IChartLegend

Returns:

String field of size.

getFieldNormalize

public String getFieldNormalize()

Description copied from interface: IChartLegend

Gets the field to represent the normalize size of chart.

Specified by:

getFieldNormalize in interface IChartLegend

Returns:

String field of normalize size.

getSizeFrom

public int getSizeFrom()

Description copied from interface: IChartLegend

Gets the limit size minimum of chart.

Specified by:

getSizeFrom in interface IChartLegend

Returns:

integer minimum size.

getSizeTo

public int getSizeTo()

Description copied from interface: IChartLegend

Gets the limit size maximum of chart.

Specified by:

getSizeTo in interface IChartLegend

Returns:

integer maximum size.

getUnit

public int getUnit()

Description copied from interface: IChartLegend

Gets the selected unit, the default selected is in pixels.

Specified by:

getUnit in interface IChartLegend

Returns:

integer unit selected.

setSizeFrom

public void setSizeFrom(int s)

Description copied from interface: IChartLegend

Sets the limit size minimum of chart.

Specified by:

setSizeFrom in interface IChartLegend

Parameters:

s - minimum size.

setSizeTo

public void setSizeTo(int s)

Description copied from interface: IChartLegend

Sets the limit size maximum of chart.

Specified by:

setSizeTo in interface IChartLegend

Parameters:

s - maximum size.

setUnit

public void setUnit(int unit)

Description copied from interface: IChartLegend

Sets the selected unit, the default selected is in pixels.

Specified by:

setUnit in interface IChartLegend

setFieldSize

public void setFieldSize(String f)

Description copied from interface: IChartLegend

Sets the field to represent the size of chart.

Specified by:

setFieldSize in interface IChartLegend

setFieldNormalize

public void setFieldNormalize(String f)

Description copied from interface: IChartLegend

Sets the field to represent the normalize size of chart.

Specified by:

setFieldNormalize in interface IChartLegend

setSizeOption

public void setSizeOption(int option)

Description copied from interface: IChartLegend

Sets the size option: IPieSymbol.SIZEFIXED, IPieSymbol.SIZESUM or IPieSymbol.SIZEFIELD

Specified by:

setSizeOption in interface IChartLegend

isActiveLimits

public boolean isActiveLimits()

Description copied from interface: IChartLegend

Gets if the limits of size chart are active.

Specified by:

isActiveLimits in interface IChartLegend

Returns:

boolean true if the limits of size are active.

setActiveLimits

public void setActiveLimits(boolean b)

Description copied from interface: IChartLegend

Sets if the limits of size chart are active.

Specified by:

setActiveLimits in interface IChartLegend

getColors

public Color[] getColors()

Description copied from interface: IChartLegend

Gets the colors of represent different parts of chart symbol

Specified by:

getColors in interface IChartLegend

Returns:

Color[] colors of parts

setColors

public void setColors(Color[] colors)

Description copied from interface: IChartLegend

Sets the colors of represent different parts of chart symbol

Specified by:

setColors in interface IChartLegend

getReferenceSystem

public int getReferenceSystem()

Specified by:

getReferenceSystem in interface IChartLegend

setReferenceSystem

public void setReferenceSystem(int rs)

Specified by:

setReferenceSystem in interface IChartLegend

setMinFeature

public void setMinFeature(double min)

Specified by:

setMinFeature in interface IChartLegend

setMaxFeature

public void setMaxFeature(double max)

Specified by:

setMaxFeature in interface IChartLegend

getSymbolByFeature

public ISymbol getSymbolByFeature(Feature feat)
                           throws MapContextException

Description copied from class: VectorialUniqueValueLegend

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

Overrides:

getSymbolByFeature in class VectorialUniqueValueLegend

Parameters:

feat - IFeature

Returns:

Símbolo.

Throws:

MapContextException

getFieldNames

public String[] getFieldNames()

getFieldLabels

public String[] getFieldLabels()

Description copied from interface: IChartLegend

Gets the field's labels of the chart.

Specified by:

getFieldLabels in interface IChartLegend

Returns:

String labels of the fields.

setFields

public void setFields(String[] fields)

Description copied from interface: IChartLegend

Only the fields that will be used inside the Chart (you don't have to include here getFieldSize or getFieldNormalize)

Specified by:

setFields in interface IChartLegend

setLabels

public void setLabels(String[] fields)

Specified by:

setLabels in interface IChartLegend

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 VectorialUniqueValueLegend

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 VectorialUniqueValueLegend

Throws:

PersistenceException