com.esri.arcgis.geoprocessing.tools.coveragetools
Class AggregatePolygons

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

public class AggregatePolygons
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Combines disjoint and adjacent polygons into new area features based on a distance. The Aggregate Polygons tool is contained in the Coverage Tools tool box.
Learn more about how Aggregate Polygons works

Software restrictions: ArcInfo only

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AggregatePolygons()
          Creates the Aggregate Polygons tool with defaults.
AggregatePolygons(Object inCover, Object outCover, double cellSize, double distance)
          Creates the Aggregate Polygons tool with the required parameters.
 
Method Summary
 double getCellSize()
          Returns the Cell Size parameter of this tool .
 double getDistance()
          Returns the Aggregation Distance parameter of this tool .
 Object getInCover()
          Returns the Input Coverage parameter of this tool .
 String getOrthogonalOption()
          Returns the Preserve orthogonal shape parameter of this tool .
 Object getOutCover()
          Returns the Output Coverage parameter of this tool .
 Object getOutInfoTable()
          Returns the Output Info Table parameter of this tool (Read only).
 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 setCellSize(double cellSize)
          Sets the Cell Size parameter of this tool .
 void setDistance(double distance)
          Sets the Aggregation Distance parameter of this tool .
 void setInCover(Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setOrthogonalOption(String orthogonalOption)
          Sets the Preserve orthogonal shape parameter of this tool .
 void setOutCover(Object outCover)
          Sets the Output Coverage 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

AggregatePolygons

public AggregatePolygons()
Creates the Aggregate Polygons tool with defaults.

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


AggregatePolygons

public AggregatePolygons(Object inCover,
                         Object outCover,
                         double cellSize,
                         double distance)
Creates the Aggregate Polygons 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:
inCover - Coverage, the coverage containing polygons to be aggregated.
outCover - Coverage, the output coverage containing aggregated features as preliminary regions with a subclass AREAAGG. The output coverage name must be different from the input coverage name.
cellSize - Double, sets cell size in coverage units for grid conversion. Cell size must be greater than 0.
distance - Double, sets the aggregation distance in coverage units. A distance must be equal to or greater than the cell size.
Method Detail

getInCover

public Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is Coverage, the coverage containing polygons to be aggregated. This is a required parameter.

Returns:
the Input Coverage

setInCover

public void setInCover(Object inCover)
Sets the Input Coverage parameter of this tool . This parameter is Coverage, the coverage containing polygons to be aggregated. This is a required parameter.

Parameters:
inCover - Coverage, the coverage containing polygons to be aggregated.

getOutCover

public Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is Coverage, the output coverage containing aggregated features as preliminary regions with a subclass AREAAGG. The output coverage name must be different from the input coverage name. This is a required parameter.

Returns:
the Output Coverage

setOutCover

public void setOutCover(Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is Coverage, the output coverage containing aggregated features as preliminary regions with a subclass AREAAGG. The output coverage name must be different from the input coverage name. This is a required parameter.

Parameters:
outCover - Coverage, the output coverage containing aggregated features as preliminary regions with a subclass AREAAGG. The output coverage name must be different from the input coverage name.

getCellSize

public double getCellSize()
Returns the Cell Size parameter of this tool . This parameter is Double, sets cell size in coverage units for grid conversion. Cell size must be greater than 0. This is a required parameter.

Returns:
the Cell Size

setCellSize

public void setCellSize(double cellSize)
Sets the Cell Size parameter of this tool . This parameter is Double, sets cell size in coverage units for grid conversion. Cell size must be greater than 0. This is a required parameter.

Parameters:
cellSize - Double, sets cell size in coverage units for grid conversion. Cell size must be greater than 0.

getDistance

public double getDistance()
Returns the Aggregation Distance parameter of this tool . This parameter is Double, sets the aggregation distance in coverage units. A distance must be equal to or greater than the cell size. This is a required parameter.

Returns:
the Aggregation Distance

setDistance

public void setDistance(double distance)
Sets the Aggregation Distance parameter of this tool . This parameter is Double, sets the aggregation distance in coverage units. A distance must be equal to or greater than the cell size. This is a required parameter.

Parameters:
distance - Double, sets the aggregation distance in coverage units. A distance must be equal to or greater than the cell size.

getOrthogonalOption

public String getOrthogonalOption()
Returns the Preserve orthogonal shape parameter of this tool . This parameter is String, specifies the characteristic of the input features that will be preserved when constructing the aggregated boundaries. This is an optional parameter.

Returns:
the Preserve orthogonal shape

setOrthogonalOption

public void setOrthogonalOption(String orthogonalOption)
Sets the Preserve orthogonal shape parameter of this tool . This parameter is String, specifies the characteristic of the input features that will be preserved when constructing the aggregated boundaries. This is an optional parameter.

Parameters:
orthogonalOption - String, specifies the characteristic of the input features that will be preserved when constructing the aggregated boundaries.

getOutInfoTable

public Object getOutInfoTable()
Returns the Output Info Table parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Info Table

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