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

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

All Implemented Interfaces:

GPTool

public class ZRenderer
extends AbstractGPTool

Applies a cold-to-hot graduated color rendering to a field of z scores. The Z Score Rendering tool is contained in the Spatial Statistics Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• The Z Renderer creates a layer file with z scores rendered in the following manner:Z scores below 2 standard deviations are rendered dark blue. Z scores between 2 and 1 standard deviations are light blue. Z scores between 1 and +1 standard deviations are neutral.Z scores between 1 and 2 standard deviations are pink.Z scores above 2 standard deviations are bright red.
• The Z Renderer is appropriate for rendering output from both Hot Spot Analysis and Cluster and Outlier Analysis; tools.
• This tool will only work on the windows operating system.

Field Summary

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

vals

Constructor Summary

ZRenderer()
Creates the Z Score Rendering tool with defaults.

ZRenderer(Object inputFeatureClass, Object fieldToRender, Object outputLayerFile)
Creates the Z Score 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 Z Score 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 Z Score 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 a file with standardized Z scores.

fieldToRender - Field, the name of the field containing the z scores.

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

Method Detail

getInputFeatureClass

public Object getInputFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class containing a file with standardized Z scores. 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 a file with standardized Z scores. This is a required parameter.

Parameters:

inputFeatureClass - Feature Layer, the feature class containing a file with standardized Z scores.

getFieldToRender

public Object getFieldToRender()

Returns the Field to Render parameter of this tool . This parameter is Field, the name of the field containing the z scores. 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 the z scores. This is a required parameter.

Parameters:

fieldToRender - Field, the name of the field containing the z scores.

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.

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