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

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


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
AggregatePoints()
          Creates the Aggregate Points tool with defaults.
AggregatePoints(java.lang.Object inFeatures, java.lang.Object outFeatureClass, java.lang.Object aggregationDistance)
          Creates the Aggregate Points tool with the required parameters.
 
Method Summary
 java.lang.Object getAggregationDistance()
          Returns the Aggregation Distance parameter of this tool .
 java.lang.Object getInFeatures()
          Returns the Input Features parameter of this tool .
 java.lang.Object getOutFeatureClass()
          Returns the Output Feature Class parameter of this tool .
 java.lang.Object getOutTable()
          Returns the Output Table parameter of this tool (Read only).
 java.lang.String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 java.lang.String getToolboxName()
          Returns the name of the tool box containing this tool.
 java.lang.String getToolName()
          Returns the name of this tool.
 void setAggregationDistance(java.lang.Object aggregationDistance)
          Sets the Aggregation Distance parameter of this tool .
 void setInFeatures(java.lang.Object inFeatures)
          Sets the Input Features parameter of this tool .
 void setOutFeatureClass(java.lang.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(java.lang.Object inFeatures,
                       java.lang.Object outFeatureClass,
                       java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.Object getOutTable()
Returns the Output Table parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Table

getToolName

public java.lang.String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public java.lang.String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias