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

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

public class MeanCenter
extends AbstractGPTool

Identifies the geographic center (or the center of concentration) for a set of features. The Mean Center tool is contained in the Spatial Statistics Tools tool box.
Learn about how Mean Center works

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
MeanCenter()
          Creates the Mean Center tool with defaults.
MeanCenter(Object inputFeatureClass, Object outputFeatureClass)
          Creates the Mean Center tool with the required parameters.
 
Method Summary
 Object getCaseField()
          Returns the Case Field parameter of this tool .
 Object getDimensionField()
          Returns the Dimension Field parameter of this tool .
 Object getInputFeatureClass()
          Returns the Input Feature Class parameter of this tool .
 Object getOutputFeatureClass()
          Returns the Output Feature Class 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.
 Object getWeightField()
          Returns the Weight Field parameter of this tool .
 void setCaseField(Object caseField)
          Sets the Case Field parameter of this tool .
 void setDimensionField(Object dimensionField)
          Sets the Dimension Field parameter of this tool .
 void setInputFeatureClass(Object inputFeatureClass)
          Sets the Input Feature Class parameter of this tool .
 void setOutputFeatureClass(Object outputFeatureClass)
          Sets the Output Feature Class parameter of this tool .
 void setWeightField(Object weightField)
          Sets the Weight Field 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

MeanCenter

public MeanCenter()
Creates the Mean Center tool with defaults.

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


MeanCenter

public MeanCenter(Object inputFeatureClass,
                  Object outputFeatureClass)
Creates the Mean Center 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, a feature class for which the mean center will be calculated.
outputFeatureClass - Feature Class, a point feature class that will contain the features representing the mean centers of the input feature class.
Method Detail

getInputFeatureClass

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

Parameters:
inputFeatureClass - Feature Layer, a feature class for which the mean center will be calculated.

getOutputFeatureClass

public Object getOutputFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, a point feature class that will contain the features representing the mean centers of the input feature class. 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, a point feature class that will contain the features representing the mean centers of the input feature class. This is a required parameter.

Parameters:
outputFeatureClass - Feature Class, a point feature class that will contain the features representing the mean centers of the input feature class.

getWeightField

public Object getWeightField()
Returns the Weight Field parameter of this tool . This parameter is Field, the numeric field used to create a weighted mean center. This is an optional parameter.

Returns:
the Weight Field

setWeightField

public void setWeightField(Object weightField)
Sets the Weight Field parameter of this tool . This parameter is Field, the numeric field used to create a weighted mean center. This is an optional parameter.

Parameters:
weightField - Field, the numeric field used to create a weighted mean center.

getCaseField

public Object getCaseField()
Returns the Case Field parameter of this tool . This parameter is Field, field used to group features for separate mean center calculations. The case field can be of numeric, date, or string type. This is an optional parameter.

Returns:
the Case Field

setCaseField

public void setCaseField(Object caseField)
Sets the Case Field parameter of this tool . This parameter is Field, field used to group features for separate mean center calculations. The case field can be of numeric, date, or string type. This is an optional parameter.

Parameters:
caseField - Field, field used to group features for separate mean center calculations. The case field can be of numeric, date, or string type.

getDimensionField

public Object getDimensionField()
Returns the Dimension Field parameter of this tool . This parameter is Field, a numeric field containing attribute values from which an average value will be calculated. This is an optional parameter.

Returns:
the Dimension Field

setDimensionField

public void setDimensionField(Object dimensionField)
Sets the Dimension Field parameter of this tool . This parameter is Field, a numeric field containing attribute values from which an average value will be calculated. This is an optional parameter.

Parameters:
dimensionField - Field, a numeric field containing attribute values from which an average value will be calculated.

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