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

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

public class ClustersOutliersRendered
extends AbstractGPTool

Given a set of weighted data points, identifies those clusters of points with values similar in magnitude and those clusters of points with very heterogeneous values, then applies a cold-to-hot type of rendering. The Cluster/Outlier Analysis with 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
ClustersOutliersRendered()
          Creates the Cluster/Outlier Analysis with Rendering tool with defaults.
ClustersOutliersRendered(Object inputFeatureClass, Object inputField, Object outputLayerFile, Object outputFeatureClass)
          Creates the Cluster/Outlier Analysis with Rendering tool with the required parameters.
 
Method Summary
 Object getInputFeatureClass()
          Returns the Input Feature Class parameter of this tool .
 Object getInputField()
          Returns the Input Field parameter of this tool .
 Object getOutputFeatureClass()
          Returns the Output 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 setInputFeatureClass(Object inputFeatureClass)
          Sets the Input Feature Class parameter of this tool .
 void setInputField(Object inputField)
          Sets the Input Field parameter of this tool .
 void setOutputFeatureClass(Object outputFeatureClass)
          Sets the Output 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

ClustersOutliersRendered

public ClustersOutliersRendered()
Creates the Cluster/Outlier Analysis with Rendering tool with defaults.

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


ClustersOutliersRendered

public ClustersOutliersRendered(Object inputFeatureClass,
                                Object inputField,
                                Object outputLayerFile,
                                Object outputFeatureClass)
Creates the Cluster/Outlier Analysis with 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 for which cluster analysis will be performed.
inputField - Field, the field to be evaluated.
outputLayerFile - Layer File, the output layer file to store rendering information. You must include the .lyr extension as part of the file name.
outputFeatureClass - Feature Class, the output feature class to receive the results field and Z score.
Method Detail

getInputFeatureClass

public Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class for which cluster analysis will be performed. 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 for which cluster analysis will be performed. This is a required parameter.

Parameters:
inputFeatureClass - Feature Layer, the feature class for which cluster analysis will be performed.

getInputField

public Object getInputField()
Returns the Input Field parameter of this tool . This parameter is Field, the field to be evaluated. This is a required parameter.

Returns:
the Input Field

setInputField

public void setInputField(Object inputField)
Sets the Input Field parameter of this tool . This parameter is Field, the field to be evaluated. This is a required parameter.

Parameters:
inputField - Field, the field to be evaluated.

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.

getOutputFeatureClass

public Object getOutputFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the output feature class to receive the results field and Z score. This is a required parameter.

Returns:
the Output Feature Class

setOutputFeatureClass

public void setOutputFeatureClass(Object outputFeatureClass)
Sets the Output Feature Class parameter of this tool . This parameter is Feature Class, the output feature class to receive the results field and Z score. This is a required parameter.

Parameters:
outputFeatureClass - Feature Class, the output feature class to receive the results field and Z score.

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