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

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

public class ZRenderer
extends AbstractGPTool

Applies a cold (blue) to hot (red) color rendering scheme for a field of z-scores. The ZScore Rendering tool is contained in the Spatial Statistics Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
ZRenderer()
          Creates the ZScore Rendering tool with defaults.
ZRenderer(Object inputFeatureClass, Object fieldToRender, Object outputLayerFile)
          Creates the ZScore 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 .
 Object getOutputLayerFile()
          Returns the Output Layer File 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 setOutputLayerFile(Object outputLayerFile)
          Sets the Output Layer File 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

ZRenderer

public ZRenderer()
Creates the ZScore Rendering tool with defaults.

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


ZRenderer

public ZRenderer(Object inputFeatureClass,
                 Object fieldToRender,
                 Object outputLayerFile)
Creates the ZScore 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 - null
fieldToRender - null
outputLayerFile - null
Method Detail

getInputFeatureClass

public Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . 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 is a required parameter.

Parameters:
inputFeatureClass - null

getFieldToRender

public Object getFieldToRender()
Returns the Field to Render parameter of this tool . 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 is a required parameter.

Parameters:
fieldToRender - null

getOutputLayerFile

public Object getOutputLayerFile()
Returns the Output Layer File parameter of this tool . 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 is a required parameter.

Parameters:
outputLayerFile - null

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