QuantityByCategoryLegend (Vector legend: Quantity by category 1.0.1 API)

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.rendering.QuantityByCategoryLegend

All Implemented Interfaces:

java.lang.Cloneable, org.gvsig.fmap.mapcontext.rendering.legend.DrawingObservable, org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedLegend, org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend, org.gvsig.fmap.mapcontext.rendering.legend.ILegend, org.gvsig.fmap.mapcontext.rendering.legend.IVectorLegend, org.gvsig.tools.persistence.Persistent
```
public class QuantityByCategoryLegend
extends org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend
```
Implements a legend where the user can compare two different characteristics of a region in the map. These two "fields" will be compared, on one side, using a color for the region and , on the other side, using a graduated symbol. Both methods will change (the color or the size of the symbol) depending on the value of the fields.

Author:

jaume dominguez faus - jaume.dominguez@iver.es

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class QuantityByCategoryLegend.RegisterLegend

static class QuantityByCategoryLegend.RegisterPersistence

Nested Classes
Modifier and Type	Class and Description
`static class`	`QuantityByCategoryLegend.RegisterLegend`
`static class`	`QuantityByCategoryLegend.RegisterPersistence`

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String QUANTITY_BY_CATEGORY_LEGEND_NAME

static java.lang.String QUANTITY_BY_CATEGORY_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, zSort
- Fields inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractLegend
  LEGEND_PERSISTENCE_DEFINITION_NAME

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`QUANTITY_BY_CATEGORY_LEGEND_NAME`
`static java.lang.String`	`QUANTITY_BY_CATEGORY_LEGEND_PERSISTENCE_DEFINITION_NAME`

Constructor Summary

Constructors
Constructor and Description

QuantityByCategoryLegend()

Constructors
Constructor and Description
`QuantityByCategoryLegend()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSymbol(java.lang.Object key, org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol symbol)`
`void`	`clear()`
`java.lang.Object`	`clone()`
`void`	`delSymbol(java.lang.Object key)`
`java.lang.String[]`	`getClassifyingFieldNames()`
`int[]`	`getClassifyingFieldTypes()`
`java.lang.String`	`getClassName()`
`org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend`	`getColorRampLegend()` Obtains the VectorialIntervalLegend
`org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol`	`getDefaultSymbol()`
`java.lang.String[]`	`getDescriptions()`
`org.gvsig.symbology.fmap.rendering.GraduatedSymbolsLegend`	`getGraduatedSymbolsLegend()` Obtains the GraduatedSymbolLegend
`int`	`getShapeType()`
`org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol`	`getSymbolByFeature(org.gvsig.fmap.dal.feature.Feature feat)`
`org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol[]`	`getSymbols()`
`java.lang.Object[]`	`getValues()`
`static boolean`	`isPolygonal(int ty)`
`boolean`	`isUseDefaultSymbol()`
`void`	`loadFromState(org.gvsig.tools.persistence.PersistentState state)`
`void`	`replace(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol oldSymbol, org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol newSymbol)`
`void`	`saveToState(org.gvsig.tools.persistence.PersistentState state)`
`void`	`setClassifyingFieldNames(java.lang.String[] fieldNames)` Sets the field names required to build this legend.
`void`	`setClassifyingFieldTypes(int[] fieldTypes)`
`void`	`setColorRampLegend(org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend legend)`
`void`	`setDefaultSymbol(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol s)`
`void`	`setGraduateSymbolLegend(org.gvsig.symbology.fmap.rendering.GraduatedSymbolsLegend legend)`
`void`	`setShapeType(int shpt)`
`void`	`useDefaultSymbol(boolean b)`

Methods inherited from class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend
fireClassifiedSymbolChangeEvent, fireLegendClearEvent, getRequiredFeatureAttributeNames, isSuitableForShapeType

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.IVectorLegend
draw, draw, print, print

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
  - QUANTITY_BY_CATEGORY_LEGEND_NAME
```
public static final java.lang.String QUANTITY_BY_CATEGORY_LEGEND_NAME
```
    See Also:
    Constant Field Values
  - QUANTITY_BY_CATEGORY_LEGEND_PERSISTENCE_DEFINITION_NAME
```
public static final java.lang.String QUANTITY_BY_CATEGORY_LEGEND_PERSISTENCE_DEFINITION_NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - QuantityByCategoryLegend
```
public QuantityByCategoryLegend()
```
- Method Detail
  - addSymbol
```
public void addSymbol(java.lang.Object key,
             org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol symbol)
```
  - clear
```
public void clear()
```
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Overrides:
    
    clone in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend
    
    Throws:
    
    java.lang.CloneNotSupportedException
  - delSymbol
```
public void delSymbol(java.lang.Object key)
```
  - getClassifyingFieldNames
```
public java.lang.String[] getClassifyingFieldNames()
```
    Specified by:
    
    getClassifyingFieldNames in interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend
    
    Overrides:
    
    getClassifyingFieldNames in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend
  - getClassifyingFieldTypes
```
public int[] getClassifyingFieldTypes()
```
    Specified by:
    
    getClassifyingFieldTypes in interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend
    
    Overrides:
    
    getClassifyingFieldTypes in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend
  - getClassName
```
public java.lang.String getClassName()
```
  - getColorRampLegend
```
public org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend getColorRampLegend()
```
    Obtains the VectorialIntervalLegend
    
    Returns:
    VectorialIntervalLegend
  - getDefaultSymbol
```
public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol getDefaultSymbol()
```
  - getDescriptions
```
public java.lang.String[] getDescriptions()
```
  - getGraduatedSymbolsLegend
```
public org.gvsig.symbology.fmap.rendering.GraduatedSymbolsLegend getGraduatedSymbolsLegend()
```
    Obtains the GraduatedSymbolLegend
    
    Returns:
    GraduatedSymbolLegend
  - getShapeType
```
public int getShapeType()
```
  - getSymbolByFeature
```
public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol getSymbolByFeature(org.gvsig.fmap.dal.feature.Feature feat)
                                                                       throws org.gvsig.fmap.mapcontext.MapContextException
```
    Throws:
    
    org.gvsig.fmap.mapcontext.MapContextException
  - getSymbols
```
public org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol[] getSymbols()
```
  - getValues
```
public java.lang.Object[] getValues()
```
  - isPolygonal
```
public static boolean isPolygonal(int ty)
```
  - isUseDefaultSymbol
```
public boolean isUseDefaultSymbol()
```
  - loadFromState
```
public void loadFromState(org.gvsig.tools.persistence.PersistentState state)
                   throws org.gvsig.tools.persistence.exception.PersistenceException
```
    Specified by:
    
    loadFromState in interface org.gvsig.tools.persistence.Persistent
    
    Overrides:
    
    loadFromState in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend
    
    Throws:
    
    org.gvsig.tools.persistence.exception.PersistenceException
  - replace
```
public void replace(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol oldSymbol,
           org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol newSymbol)
```
  - saveToState
```
public void saveToState(org.gvsig.tools.persistence.PersistentState state)
                 throws org.gvsig.tools.persistence.exception.PersistenceException
```
    Specified by:
    
    saveToState in interface org.gvsig.tools.persistence.Persistent
    
    Overrides:
    
    saveToState in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend
    
    Throws:
    
    org.gvsig.tools.persistence.exception.PersistenceException
  - setClassifyingFieldNames
```
public void setClassifyingFieldNames(java.lang.String[] fieldNames)
```
    Sets the field names required to build this legend. In this case fieldNames is an array of length 2 where the first element is the field name for the embedded GraduatedSymbolLegend, and the second is the field name for the embedded colorRamp (VectorialIntervalLegend) legend.
    
    Specified by:
    
    setClassifyingFieldNames in interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend
    
    Overrides:
    
    setClassifyingFieldNames in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend
  - setClassifyingFieldTypes
```
public void setClassifyingFieldTypes(int[] fieldTypes)
```
    Specified by:
    
    setClassifyingFieldTypes in interface org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend
    
    Overrides:
    
    setClassifyingFieldTypes in class org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.AbstractClassifiedVectorLegend
  - setColorRampLegend
```
public void setColorRampLegend(org.gvsig.symbology.fmap.mapcontext.rendering.legend.impl.VectorialIntervalLegend legend)
```
  - setDefaultSymbol
```
public void setDefaultSymbol(org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol s)
```
  - setGraduateSymbolLegend
```
public void setGraduateSymbolLegend(org.gvsig.symbology.fmap.rendering.GraduatedSymbolsLegend legend)
```
  - setShapeType
```
public void setShapeType(int shpt)
```
  - useDefaultSymbol
```
public void useDefaultSymbol(boolean b)
```

Class QuantityByCategoryLegend

Nested Class Summary

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

QUANTITY_BY_CATEGORY_LEGEND_NAME

QUANTITY_BY_CATEGORY_LEGEND_PERSISTENCE_DEFINITION_NAME

Constructor Detail

QuantityByCategoryLegend

Method Detail

addSymbol

clear

clone

delSymbol

getClassifyingFieldNames

getClassifyingFieldTypes

getClassName

getColorRampLegend

getDefaultSymbol

getDescriptions

getGraduatedSymbolsLegend

getShapeType

getSymbolByFeature

getSymbols

getValues

isPolygonal

isUseDefaultSymbol

loadFromState

replace

saveToState

setClassifyingFieldNames

setClassifyingFieldTypes

setColorRampLegend

setDefaultSymbol

setGraduateSymbolLegend

setShapeType

useDefaultSymbol