com.esri.adf.web.data.renderer
Class WebClassBreaksRenderer

java.lang.Object
  com.esri.adf.web.data.renderer.WebClassBreaksRenderer

All Implemented Interfaces:

WebActiveRenderer, WebRenderer, Serializable

public class WebClassBreaksRenderer
extends Object
implements WebActiveRenderer

WebClassBreaksRenderer is used for rendering features differently depending on the value of a numeric field. WebClassBreaksRenderer holds a list of WebClassBreakInfos that are used for expressing the mapping between the range of an attribute value and a WebSymbol that should be used for rendering.

  For example,
    WebClassBreaksRenderer wcbr = new WebClassBreaksRenderer();
    wcbr.setDefaultSymbol(new WebSimpleMarkerSymbol());
    wcbr.setField("POPULATION");
    wcbr.setMinimumValue(100000);
    
    ArrayList<WebClassBreakInfo> infos = new ArrayList<WebClassBreakInfo>(2);
    
    WebSimpleMarkerSymbol redMS = new WebSimpleMarkerSymbol();
    redMS.setColor("255,0,0");
    redMS.setWidth(15);
    redMS.setMarkerType(WebSimpleMarkerSymbol.STAR);
    WebClassBreakInfo cbi = new WebClassBreakInfo("Red Color", "Red Color", 200000, redMS);
    infos.add(cbi);
  
    WebSimpleMarkerSymbol greenMS = new WebSimpleMarkerSymbol();
    greenMS.setColor("0,255,0");
    greenMS.setWidth(25);
    greenMS.setMarkerType(WebSimpleMarkerSymbol.STAR);
    cbi = new WebClassBreakInfo("Green Color", "Green Color", 300000, greenMS);
    infos.add(cbi);
    
    wcbr.setClassBreakInfos(infos);
 

When features of a GraphicsLayer are rendered using the WebClassBreaksRenderer shown above, all the features with value of "POPULATION" field with the range from 100,000 to 200,000 are shown as red stars, while all the features in the range from 200,001 to 300,000 are shown as green stars.

See Also:

Serialized Form

Constructor Summary

WebClassBreaksRenderer()

Method Summary

void	addValues(List<Double> values) Add the values to the existing list if available.
void	clearValues() Clear the values.
List<WebClassBreakInfo>	getClassBreakInfos() Returns the list of WebClassBreakInfos.
String	getDefaultLabel() Returns the default label.
WebSymbol	getDefaultSymbol() Returns the default symbol.
String	getField() Returns the field name.
double	getMinimumValue() Returns the minimum value.
String	getType() Returns the type of the renderer as "Class Breaks Renderer"
void	render(List<? extends WebGeometry> geometries, WebElementConverter converter) Applies the rendering strategy of this renderer to the passed geometries.
void	setClassBreakInfos(List<? extends WebClassBreakInfo> classBreakInfos) Sets the list of WebClassBreakInfos.
void	setDefaultLabel(String defaultLabel) Sets the default label.
void	setDefaultSymbol(WebSymbol defaultSymbol) Sets the default symbol.
void	setField(String field) Sets the field name.
void	setMinimumValue(double minimumValue) Sets the minimum value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebClassBreaksRenderer

public WebClassBreaksRenderer()

Method Detail

getType

public String getType()

Returns the type of the renderer as "Class Breaks Renderer"

Specified by:

getType in interface WebRenderer

Returns:

the string representation of renderer type

setClassBreakInfos

public void setClassBreakInfos(List<? extends WebClassBreakInfo> classBreakInfos)

Sets the list of WebClassBreakInfos.

Parameters:

classBreakInfos - he list of WebClassBreakInfos.

getClassBreakInfos

public List<WebClassBreakInfo> getClassBreakInfos()

Returns the list of WebClassBreakInfos.

Returns:

the list of WebClassBreakInfos

setDefaultLabel

public void setDefaultLabel(String defaultLabel)

Sets the default label.

Parameters:

defaultLabel - the default label to be used in TOC

getDefaultLabel

public String getDefaultLabel()

Returns the default label.

Returns:

the default label

setDefaultSymbol

public void setDefaultSymbol(WebSymbol defaultSymbol)

Sets the default symbol.

Parameters:

defaultSymbol - the default symbol.

getMinimumValue

public double getMinimumValue()

Returns the minimum value.

Returns:

the minimum value

setField

public void setField(String field)

Sets the field name.

Parameters:

field - the field name used for creating class breaks

getField

public String getField()

Returns the field name.

Returns:

the field name used for creating class breaks

getDefaultSymbol

public WebSymbol getDefaultSymbol()

Returns the default symbol.

Returns:

the default symbol

setMinimumValue

public void setMinimumValue(double minimumValue)

Sets the minimum value.

Parameters:

minimumValue - the minimum value

clearValues

public void clearValues()

Clear the values.

addValues

public void addValues(List<Double> values)

Add the values to the existing list if available.

Parameters:

values - the list of values that are used to retrieve the symbol from class break information.

render

public void render(List<? extends WebGeometry> geometries,
                   WebElementConverter converter)
            throws Exception

Description copied from interface: WebActiveRenderer

Applies the rendering strategy of this renderer to the passed geometries.

Specified by:

render in interface WebActiveRenderer

Parameters:

geometries - a list of geometries to be rendered

converter - a converter to be used for rendering geometries

Throws:

Exception - is thrown if something goes wrong