com.esri.arcgis.geoprocessing.tools.cartographytools
Class AggregatePoints

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.cartographytools.AggregatePoints

All Implemented Interfaces:

GPTool

public class AggregatePoints
extends AbstractGPTool

Creates polygon features around clusters of proximate point features. The Aggregate Points tool is contained in the Cartography Tools tool box.

Usage tips:

• Polygons are created around clusters of three or more points within the aggregation distance.
• Point aggregation may introduce polygon holes or areas where adjacent polygon boundaries meet at one vertex.

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

AggregatePoints()
Creates the Aggregate Points tool with defaults.

AggregatePoints(Object inFeatures, Object outFeatureClass, Object aggregationDistance)
Creates the Aggregate Points tool with the required parameters.

Method Summary

Object	getAggregationDistance() Returns the Aggregation Distance parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getOutTable() Returns the Output 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	setAggregationDistance(Object aggregationDistance) Sets the Aggregation Distance parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) 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

AggregatePoints

public AggregatePoints()

Creates the Aggregate Points tool with defaults.

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

AggregatePoints

public AggregatePoints(Object inFeatures,
                       Object outFeatureClass,
                       Object aggregationDistance)

Creates the Aggregate Points 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:

inFeatures - the input point features that will be assessed for proximity and clustering.

outFeatureClass - the feature class created to hold the polygons that represent the point clusters.

aggregationDistance - the distance between points that will be clustered.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input point features that will be assessed for proximity and clustering. This is a required parameter.

Returns:

the Input Features

setInFeatures

public void setInFeatures(Object inFeatures)

Sets the Input Features parameter of this tool . This parameter is the input point features that will be assessed for proximity and clustering. This is a required parameter.

Parameters:

inFeatures - the input point features that will be assessed for proximity and clustering.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the feature class created to hold the polygons that represent the point clusters. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the feature class created to hold the polygons that represent the point clusters. This is a required parameter.

Parameters:

outFeatureClass - the feature class created to hold the polygons that represent the point clusters.

getAggregationDistance

public Object getAggregationDistance()

Returns the Aggregation Distance parameter of this tool . This parameter is the distance between points that will be clustered. This is a required parameter.

Returns:

the Aggregation Distance

setAggregationDistance

public void setAggregationDistance(Object aggregationDistance)

Sets the Aggregation Distance parameter of this tool . This parameter is the distance between points that will be clustered. This is a required parameter.

Parameters:

aggregationDistance - the distance between points that will be clustered.

getOutTable

public Object getOutTable()

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

Returns:

the Output 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