com.esri.arcgis.geoprocessing.tools.spatialstatisticstools
Class CountRenderer

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.CountRenderer

All Implemented Interfaces:

GPTool

public class CountRenderer
extends AbstractGPTool

Applies graduated circle rendering to a numeric field in a feature class. The Count Rendering tool is contained in the Spatial Statistics Tools tool box.

Usage tips:

• The Count Rendering tool renders quantities as circles; circle size reflects value magnitudes. Tool output is a new layer file (.lyr).
• Rendering features quantitatively may reveal spatial patterns in the input count data.
• If no Maximum Field Value is provided, it is set to the largest value found in the Field to Render. Use the Maximum Field Value parameter when you want to compare several graduated circle maps; setting the same Maximum Field Value for a series of maps imposes a fixed circle size scaling even when the data ranges vary.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

CountRenderer()
Creates the Count Rendering tool with defaults.

CountRenderer(Object inputFeatureClass, Object fieldToRender, Object outputLayerFile, int numberOfClasses, String symbolColor)
Creates the Count Rendering tool with the required parameters.

Method Summary

Object	getFieldToRender() Returns the Field Name parameter of this tool .
Object	getInputFeatureClass() Returns the Input Features parameter of this tool .
double	getMaximumFieldValue() Returns the Maximum Field Value parameter of this tool .
int	getNumberOfClasses() Returns the Number of Classes parameter of this tool .
Object	getOutputLayerFile() Returns the Output Layer parameter of this tool .
String	getSymbolColor() Returns the Symbol Color parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
void	setFieldToRender(Object fieldToRender) Sets the Field Name parameter of this tool .
void	setInputFeatureClass(Object inputFeatureClass) Sets the Input Features parameter of this tool .
void	setMaximumFieldValue(double maximumFieldValue) Sets the Maximum Field Value parameter of this tool .
void	setNumberOfClasses(int numberOfClasses) Sets the Number of Classes parameter of this tool .
void	setOutputLayerFile(Object outputLayerFile) Sets the Output Layer parameter of this tool .
void	setSymbolColor(String symbolColor) Sets the Symbol Color parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CountRenderer

public CountRenderer()

Creates the Count Rendering tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

CountRenderer

public CountRenderer(Object inputFeatureClass,
                     Object fieldToRender,
                     Object outputLayerFile,
                     int numberOfClasses,
                     String symbolColor)

Creates the Count Rendering tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inputFeatureClass - the feature layer containing count data to be rendered.

fieldToRender - the name of the field containing count data.

outputLayerFile - null

numberOfClasses - the number of classes into which the input feature class will be classified.

symbolColor - the color of the graduated circles.

Method Detail

getInputFeatureClass

public Object getInputFeatureClass()

Returns the Input Features parameter of this tool . This parameter is the feature layer containing count data to be rendered. This is a required parameter.

Returns:

the Input Features

setInputFeatureClass

public void setInputFeatureClass(Object inputFeatureClass)

Sets the Input Features parameter of this tool . This parameter is the feature layer containing count data to be rendered. This is a required parameter.

Parameters:

inputFeatureClass - the feature layer containing count data to be rendered.

getFieldToRender

public Object getFieldToRender()

Returns the Field Name parameter of this tool . This parameter is the name of the field containing count data. This is a required parameter.

Returns:

the Field Name

setFieldToRender

public void setFieldToRender(Object fieldToRender)

Sets the Field Name parameter of this tool . This parameter is the name of the field containing count data. This is a required parameter.

Parameters:

fieldToRender - the name of the field containing count data.

getOutputLayerFile

public Object getOutputLayerFile()

Returns the Output Layer parameter of this tool . This is a required parameter.

Returns:

the Output Layer

setOutputLayerFile

public void setOutputLayerFile(Object outputLayerFile)

Sets the Output Layer parameter of this tool . This is a required parameter.

Parameters:

outputLayerFile - null

getNumberOfClasses

public int getNumberOfClasses()

Returns the Number of Classes parameter of this tool . This parameter is the number of classes into which the input feature class will be classified. This is a required parameter.

Returns:

the Number of Classes

setNumberOfClasses

public void setNumberOfClasses(int numberOfClasses)

Sets the Number of Classes parameter of this tool . This parameter is the number of classes into which the input feature class will be classified. This is a required parameter.

Parameters:

numberOfClasses - the number of classes into which the input feature class will be classified.

getSymbolColor

public String getSymbolColor()

Returns the Symbol Color parameter of this tool . This parameter is the color of the graduated circles. This is a required parameter.

Returns:

the Symbol Color

setSymbolColor

public void setSymbolColor(String symbolColor)

Sets the Symbol Color parameter of this tool . This parameter is the color of the graduated circles. This is a required parameter.

Parameters:

symbolColor - the color of the graduated circles.

getMaximumFieldValue

public double getMaximumFieldValue()

Returns the Maximum Field Value parameter of this tool . This parameter is the maximum attribute value that will be rendered. Features with field values greater than this maximum value will not be drawn. This is an optional parameter.

Returns:

the Maximum Field Value

setMaximumFieldValue

public void setMaximumFieldValue(double maximumFieldValue)

Sets the Maximum Field Value parameter of this tool . This parameter is the maximum attribute value that will be rendered. Features with field values greater than this maximum value will not be drawn. This is an optional parameter.

Parameters:

maximumFieldValue - the maximum attribute value that will be rendered. Features with field values greater than this maximum value will not be drawn.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias