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

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

public class MedianCenter
extends AbstractGPTool

Identifies the location that minimizes overall Euclidean distance to the features in a dataset. The Median Center 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
MedianCenter()
          Creates the Median Center tool with defaults.
MedianCenter(java.lang.Object inputFeatureClass, java.lang.Object outputFeatureClass)
          Creates the Median Center tool with the required parameters.
 
Method Summary
 java.lang.Object getAttributeField()
          Returns the Attribute Field parameter of this tool .
 java.lang.Object getCaseField()
          Returns the Case Field parameter of this tool .
 java.lang.Object getInputFeatureClass()
          Returns the Input Feature Class parameter of this tool .
 java.lang.Object getOutputFeatureClass()
          Returns the Output Feature Class parameter of this tool .
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 java.lang.Object getWeightField()
          Returns the Weight Field parameter of this tool .
 void setAttributeField(java.lang.Object attributeField)
          Sets the Attribute Field parameter of this tool .
 void setCaseField(java.lang.Object caseField)
          Sets the Case Field parameter of this tool .
 void setInputFeatureClass(java.lang.Object inputFeatureClass)
          Sets the Input Feature Class parameter of this tool .
 void setOutputFeatureClass(java.lang.Object outputFeatureClass)
          Sets the Output Feature Class parameter of this tool .
 void setWeightField(java.lang.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

MedianCenter

public MedianCenter()
Creates the Median Center tool with defaults.

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


MedianCenter

public MedianCenter(java.lang.Object inputFeatureClass,
                    java.lang.Object outputFeatureClass)
Creates the Median 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 - a feature class for which the median center will be calculated.
outputFeatureClass - a point feature class that will contain the features representing the median centers of the input feature class.
Method Detail

getInputFeatureClass

public java.lang.Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is a feature class for which the median center will be calculated. This is a required parameter.

Returns:
the Input Feature Class

setInputFeatureClass

public void setInputFeatureClass(java.lang.Object inputFeatureClass)
Sets the Input Feature Class parameter of this tool . This parameter is a feature class for which the median center will be calculated. This is a required parameter.

Parameters:
inputFeatureClass - a feature class for which the median center will be calculated.

getOutputFeatureClass

public java.lang.Object getOutputFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is a point feature class that will contain the features representing the median centers of the input feature class. This is a required parameter.

Returns:
the Output Feature Class

setOutputFeatureClass

public void setOutputFeatureClass(java.lang.Object outputFeatureClass)
Sets the Output Feature Class parameter of this tool . This parameter is a point feature class that will contain the features representing the median centers of the input feature class. This is a required parameter.

Parameters:
outputFeatureClass - a point feature class that will contain the features representing the median centers of the input feature class.

getWeightField

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

Returns:
the Weight Field

setWeightField

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

Parameters:
weightField - the numeric field used to create a weighted median center.

getCaseField

public java.lang.Object getCaseField()
Returns the Case Field parameter of this tool . This parameter is field used to group features for separate median 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(java.lang.Object caseField)
Sets the Case Field parameter of this tool . This parameter is field used to group features for separate median center calculations. The case field can be of numeric, date, or string type. This is an optional parameter.

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

getAttributeField

public java.lang.Object getAttributeField()
Returns the Attribute Field parameter of this tool . This parameter is numeric field(s) for which the data median value will be computed. This is an optional parameter.

Returns:
the Attribute Field

setAttributeField

public void setAttributeField(java.lang.Object attributeField)
Sets the Attribute Field parameter of this tool . This parameter is numeric field(s) for which the data median value will be computed. This is an optional parameter.

Parameters:
attributeField - numeric field(s) for which the data median value will be computed.

getToolName

public java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias