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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialstatisticstools.CountRenderer
All Implemented Interfaces:
GPTool

public class CountRenderer
extends AbstractGPTool

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

Software restrictions: none

Illustration:

Usage tips:


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 to Render parameter of this tool .
 Object getInputFeatureClass()
          Returns the Input Feature Class 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 File 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 to Render parameter of this tool .
 void setInputFeatureClass(Object inputFeatureClass)
          Sets the Input Feature Class 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 File 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 - Feature Layer, the feature class containing count data to be rendered.
fieldToRender - Field, the name of the field containing count data.
outputLayerFile - Layer File, the output layer file to store rendering information. You must include the .lyr extension as part of the file name.
numberOfClasses - Long, the number of classes into which the input feature class will be classified.
symbolColor - String, the color of the graduated circles.
Method Detail

getInputFeatureClass

public Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class containing count data to be rendered. This is a required parameter.

Returns:
the Input Feature Class

setInputFeatureClass

public void setInputFeatureClass(Object inputFeatureClass)
Sets the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class containing count data to be rendered. This is a required parameter.

Parameters:
inputFeatureClass - Feature Layer, the feature class containing count data to be rendered.

getFieldToRender

public Object getFieldToRender()
Returns the Field to Render parameter of this tool . This parameter is Field, the name of the field containing count data. This is a required parameter.

Returns:
the Field to Render

setFieldToRender

public void setFieldToRender(Object fieldToRender)
Sets the Field to Render parameter of this tool . This parameter is Field, the name of the field containing count data. This is a required parameter.

Parameters:
fieldToRender - Field, the name of the field containing count data.

getOutputLayerFile

public Object getOutputLayerFile()
Returns the Output Layer File parameter of this tool . This parameter is Layer File, the output layer file to store rendering information. You must include the .lyr extension as part of the file name. This is a required parameter.

Returns:
the Output Layer File

setOutputLayerFile

public void setOutputLayerFile(Object outputLayerFile)
Sets the Output Layer File parameter of this tool . This parameter is Layer File, the output layer file to store rendering information. You must include the .lyr extension as part of the file name. This is a required parameter.

Parameters:
outputLayerFile - Layer File, the output layer file to store rendering information. You must include the .lyr extension as part of the file name.

getNumberOfClasses

public int getNumberOfClasses()
Returns the Number of Classes parameter of this tool . This parameter is Long, 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 Long, the number of classes into which the input feature class will be classified. This is a required parameter.

Parameters:
numberOfClasses - Long, 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 String, 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 String, the color of the graduated circles. This is a required parameter.

Parameters:
symbolColor - String, the color of the graduated circles.

getMaximumFieldValue

public double getMaximumFieldValue()
Returns the Maximum Field Value parameter of this tool . This parameter is Double, 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 Double, 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 - Double, 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