com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class TabulateArea

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

public class TabulateArea
extends AbstractGPTool

Calculates cross-tabulated areas between two datasets and outputs a table. The Tabulate Area tool is contained in the Spatial Analyst Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
TabulateArea()
          Creates the Tabulate Area tool with defaults.
TabulateArea(Object inZoneData, Object zoneField, Object inClassData, Object classField, Object outTable)
          Creates the Tabulate Area tool with the required parameters.
 
Method Summary
 Object getClassField()
          Returns the Class field parameter of this tool .
 Object getInClassData()
          Returns the Input raster or feature class data parameter of this tool .
 Object getInZoneData()
          Returns the Input raster or feature zone data parameter of this tool .
 Object getOutTable()
          Returns the Output table parameter of this tool .
 Object getProcessingCellSize()
          Returns the Processing cell size 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 getZoneField()
          Returns the Zone field parameter of this tool .
 void setClassField(Object classField)
          Sets the Class field parameter of this tool .
 void setInClassData(Object inClassData)
          Sets the Input raster or feature class data parameter of this tool .
 void setInZoneData(Object inZoneData)
          Sets the Input raster or feature zone data parameter of this tool .
 void setOutTable(Object outTable)
          Sets the Output table parameter of this tool .
 void setProcessingCellSize(Object processingCellSize)
          Sets the Processing cell size parameter of this tool .
 void setZoneField(Object zoneField)
          Sets the Zone 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

TabulateArea

public TabulateArea()
Creates the Tabulate Area tool with defaults.

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


TabulateArea

public TabulateArea(Object inZoneData,
                    Object zoneField,
                    Object inClassData,
                    Object classField,
                    Object outTable)
Creates the Tabulate Area 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:
inZoneData - dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer.
zoneField - field that holds the values that define each zone. it can be an integer or a string field of the zone dataset.
inClassData - the dataset that defines the classes that will have their area summarized within each zone. the class input can be an integer raster layer or a feature layer.
classField - the field that holds the class values. it can be an integer or a string field of the input class data.
outTable - output table that will contain the summary of the area of each class in each zone.
Method Detail

getInZoneData

public Object getInZoneData()
Returns the Input raster or feature zone data parameter of this tool . This parameter is dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer. This is a required parameter.

Returns:
the Input raster or feature zone data

setInZoneData

public void setInZoneData(Object inZoneData)
Sets the Input raster or feature zone data parameter of this tool . This parameter is dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer. This is a required parameter.

Parameters:
inZoneData - dataset that defines the zones. the zones can be defined by an integer raster or a polygon feature layer.

getZoneField

public Object getZoneField()
Returns the Zone field parameter of this tool . This parameter is field that holds the values that define each zone. it can be an integer or a string field of the zone dataset. This is a required parameter.

Returns:
the Zone field

setZoneField

public void setZoneField(Object zoneField)
Sets the Zone field parameter of this tool . This parameter is field that holds the values that define each zone. it can be an integer or a string field of the zone dataset. This is a required parameter.

Parameters:
zoneField - field that holds the values that define each zone. it can be an integer or a string field of the zone dataset.

getInClassData

public Object getInClassData()
Returns the Input raster or feature class data parameter of this tool . This parameter is the dataset that defines the classes that will have their area summarized within each zone. the class input can be an integer raster layer or a feature layer. This is a required parameter.

Returns:
the Input raster or feature class data

setInClassData

public void setInClassData(Object inClassData)
Sets the Input raster or feature class data parameter of this tool . This parameter is the dataset that defines the classes that will have their area summarized within each zone. the class input can be an integer raster layer or a feature layer. This is a required parameter.

Parameters:
inClassData - the dataset that defines the classes that will have their area summarized within each zone. the class input can be an integer raster layer or a feature layer.

getClassField

public Object getClassField()
Returns the Class field parameter of this tool . This parameter is the field that holds the class values. it can be an integer or a string field of the input class data. This is a required parameter.

Returns:
the Class field

setClassField

public void setClassField(Object classField)
Sets the Class field parameter of this tool . This parameter is the field that holds the class values. it can be an integer or a string field of the input class data. This is a required parameter.

Parameters:
classField - the field that holds the class values. it can be an integer or a string field of the input class data.

getOutTable

public Object getOutTable()
Returns the Output table parameter of this tool . This parameter is output table that will contain the summary of the area of each class in each zone. This is a required parameter.

Returns:
the Output table

setOutTable

public void setOutTable(Object outTable)
Sets the Output table parameter of this tool . This parameter is output table that will contain the summary of the area of each class in each zone. This is a required parameter.

Parameters:
outTable - output table that will contain the summary of the area of each class in each zone.

getProcessingCellSize

public Object getProcessingCellSize()
Returns the Processing cell size parameter of this tool . This parameter is the processing cell size for the zonal operation. this is the value in the environment if specifically set. If the environment is not set, the default for the cell size is determined by the type of the zone data as follows: This is an optional parameter.

Returns:
the Processing cell size

setProcessingCellSize

public void setProcessingCellSize(Object processingCellSize)
Sets the Processing cell size parameter of this tool . This parameter is the processing cell size for the zonal operation. this is the value in the environment if specifically set. If the environment is not set, the default for the cell size is determined by the type of the zone data as follows: This is an optional parameter.

Parameters:
processingCellSize - the processing cell size for the zonal operation. this is the value in the environment if specifically set. If the environment is not set, the default for the cell size is determined by the type of the zone data as follows:
  • If the zone dataset is a raster, the cell size is the same as the zone raster.
  • If zone dataset is feature, the cell size is the shorter of the width or height of the extent of zone feature dataset in the output spatial reference, divided by 250.

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