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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      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.

Usage tips:

• Thefield created in the Output Feature Class will be populated with values for the area of each polygon feature in square units of the .
• There are alternative methods for creating an Area field for polygon features including: and the .
• The Output Feature Class is a copy of the Input Feature Class with the additional (or updated)field containing polygon areas.
• This tool is useful for determining a weight for .
• This tool can be used to calculate an Area value for a study area polygon. The tool, for example, has an Area parameter.
• The F_AREA field is created in the Output Feature Class to store calculated Area values. If a field of this name already exists in the Input Feature Class, it will be overwritten in the Output Feature Class.
• When using shapefiles, keep in mind that they cannot store null values. Tools or other procedures that create shapefiles from non-shapefile inputs may store or interpret null values as zero. This can lead to unexpected results. See also .

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 - the input polygon feature class.

outputFeatureClass - the output feature class. This feature class is a copy of the input feature class with field F_AREA added (or updated). The F_AREA field contains the polygon area.

Method Detail

getInputFeatureClass

public Object getInputFeatureClass()

Returns the Input Feature Class parameter of this tool . This parameter is the input polygon feature class. 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 the input polygon feature class. This is a required parameter.

Parameters:

inputFeatureClass - the input polygon feature class.

getOutputFeatureClass

public Object getOutputFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class. This feature class is a copy of the input feature class with field F_AREA added (or updated). The F_AREA field contains the polygon area. 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 the output feature class. This feature class is a copy of the input feature class with field F_AREA added (or updated). The F_AREA field contains the polygon area. This is a required parameter.

Parameters:

outputFeatureClass - the output feature class. This feature class is a copy of the input feature class with field F_AREA added (or updated). The F_AREA field contains the polygon area.

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