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

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

public class CalculateAreas
extends AbstractGPTool

Calculates Area values for each feature in a polygon feature class. The Calculate Areas 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
CalculateAreas()
          Creates the Calculate Areas tool with defaults.
CalculateAreas(Object inputFeatureClass, Object outputFeatureClass)
          Creates the Calculate Areas tool with the required parameters.
 
Method Summary
 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.
 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 .
 
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

CalculateAreas

public CalculateAreas()
Creates the Calculate Areas tool with defaults.

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


CalculateAreas

public CalculateAreas(Object inputFeatureClass,
                      Object outputFeatureClass)
Creates the Calculate Areas 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 polygon features from which to calculate Area values.
outputFeatureClass - Feature Class, the feature class to contain the calculated Area values.
Method Detail

getInputFeatureClass

public Object getInputFeatureClass()
Returns the Input Feature Class parameter of this tool . This parameter is Feature Layer, the feature class containing polygon features from which to calculate Area values. 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 polygon features from which to calculate Area values. This is a required parameter.

Parameters:
inputFeatureClass - Feature Layer, the feature class containing polygon features from which to calculate Area values.

getOutputFeatureClass

public Object getOutputFeatureClass()
Returns the Output Feature Class parameter of this tool . This parameter is Feature Class, the feature class to contain the calculated Area values. 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 feature class to contain the calculated Area values. This is a required parameter.

Parameters:
outputFeatureClass - Feature Class, the feature class to contain the calculated Area values.

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