com.esri.arcgis.geoprocessing.tools.analysistools
Class GenerateNearTable

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.analysistools.GenerateNearTable

All Implemented Interfaces:

GPTool

public class GenerateNearTable
extends AbstractGPTool

Determines the distances from each feature in the input features to one or more nearby features in the near features, within the search radius. The results are recorded in the output table. The Generate Near Table tool is contained in the Analysis Tools tool box.

Usage tips:

• This tool behaves the same as the tool. However, instead of updating the input features, it creates a new output table. Moreover, it can find as many near features as specified by the Maximum number of closest matches parameter.
• The output table contains three fields IN_FID, NEAR_FID and NEAR_DIST by default. Additional fields are added to output depending on the optional parameters selected as explained in the parameter entry.
• The output table can be joined back to the input feature class or a near feature class using the INPUT_FID or NEAR_FID fields.
• Both input features and near features and can be point, multipoint, line, or polygon.
• The default option for this tool is to find the distance from each input feature to the closest near feature. Choose the ALL option, that is uncheck the Find only closest feature parameter to create a table containing the distance between all input to all near features.
• The values for NEAR_FID and NEAR_DIST will be -1 if no feature is found within the search radius.
• If no Search Radius is specified, a radius large enough is used so that all Near Features can be incorporated in the distance calculation. If the default Search Radius is used (no radius is specified) the Output Table can be quite large. For example, calculating distances from 1,000 points in one feature class to 1,000 points in another feature class can produce an output table containing one million records. Use the search radius to limit the number of output records.
• Both the Input Features and Near Features can be the same dataset. In that case when the input and near features are the same record, that result will be skipped so as not to report that each feature is 0 units from itself.

Field Summary

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

vals

Constructor Summary

GenerateNearTable()
Creates the Generate Near Table tool with defaults.

GenerateNearTable(Object inFeatures, Object nearFeatures, Object outTable)
Creates the Generate Near Table tool with the required parameters.

Method Summary

String	getAngle() Returns the Angle parameter of this tool .
String	getClosest() Returns the Find only closest feature parameter of this tool .
int	getClosestCount() Returns the Maximum number of closest matches parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
String	getLocation() Returns the Location parameter of this tool .
Object	getNearFeatures() Returns the Near Features parameter of this tool .
Object	getOutTable() Returns the Output Table parameter of this tool .
Object	getSearchRadius() Returns the Search Radius 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	setAngle(String angle) Sets the Angle parameter of this tool .
void	setClosest(String closest) Sets the Find only closest feature parameter of this tool .
void	setClosestCount(int closestCount) Sets the Maximum number of closest matches parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setLocation(String location) Sets the Location parameter of this tool .
void	setNearFeatures(Object nearFeatures) Sets the Near Features parameter of this tool .
void	setOutTable(Object outTable) Sets the Output Table parameter of this tool .
void	setSearchRadius(Object searchRadius) Sets the Search Radius 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

GenerateNearTable

public GenerateNearTable()

Creates the Generate Near Table tool with defaults.

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

GenerateNearTable

public GenerateNearTable(Object inFeatures,
                         Object nearFeatures,
                         Object outTable)

Creates the Generate Near Table 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 features that can be point, polyline, polygon or multipoint type.

nearFeatures - the near features used to find the nearest features from input features. There can be one or more entries of near features; each entry can be of point, polyline, polygon or multipoint type. When multiple entries of near features are specified, a new field NEAR_FC is added to the input table to store the paths of the source feature class that contains the nearest features.

outTable - the output table that will contain the proximity information—such as IN_FID, NEAR_FID, NEAR_DIST—and other attributes—such as location (NEAR_X, NEAR_Y), angle (NEAR_ANGLE)—of the near feature and the NEAR_FC, if necessary.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is the input features that can be point, polyline, polygon or multipoint type. 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 features that can be point, polyline, polygon or multipoint type. This is a required parameter.

Parameters:

inFeatures - the input features that can be point, polyline, polygon or multipoint type.

getNearFeatures

public Object getNearFeatures()

Returns the Near Features parameter of this tool . This parameter is the near features used to find the nearest features from input features. There can be one or more entries of near features; each entry can be of point, polyline, polygon or multipoint type. When multiple entries of near features are specified, a new field NEAR_FC is added to the input table to store the paths of the source feature class that contains the nearest features. This is a required parameter.

Returns:

the Near Features

setNearFeatures

public void setNearFeatures(Object nearFeatures)

Sets the Near Features parameter of this tool . This parameter is the near features used to find the nearest features from input features. There can be one or more entries of near features; each entry can be of point, polyline, polygon or multipoint type. When multiple entries of near features are specified, a new field NEAR_FC is added to the input table to store the paths of the source feature class that contains the nearest features. This is a required parameter.

Parameters:

nearFeatures - the near features used to find the nearest features from input features. There can be one or more entries of near features; each entry can be of point, polyline, polygon or multipoint type. When multiple entries of near features are specified, a new field NEAR_FC is added to the input table to store the paths of the source feature class that contains the nearest features.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is the output table that will contain the proximity information—such as IN_FID, NEAR_FID, NEAR_DIST—and other attributes—such as location (NEAR_X, NEAR_Y), angle (NEAR_ANGLE)—of the near feature and the NEAR_FC, if necessary. 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 the output table that will contain the proximity information—such as IN_FID, NEAR_FID, NEAR_DIST—and other attributes—such as location (NEAR_X, NEAR_Y), angle (NEAR_ANGLE)—of the near feature and the NEAR_FC, if necessary. This is a required parameter.

Parameters:

outTable - the output table that will contain the proximity information—such as IN_FID, NEAR_FID, NEAR_DIST—and other attributes—such as location (NEAR_X, NEAR_Y), angle (NEAR_ANGLE)—of the near feature and the NEAR_FC, if necessary.

getSearchRadius

public Object getSearchRadius()

Returns the Search Radius parameter of this tool . This parameter is specifies the radius used to search for candidate near features. The near features within this radius are considered for calculating the nearest feature. If no value is specified, that is the default (empty)radius is used, all near features are considered for calculation. You can specify any distance unit replacing the default unit of the input features. This is an optional parameter.

Returns:

the Search Radius

setSearchRadius

public void setSearchRadius(Object searchRadius)

Sets the Search Radius parameter of this tool . This parameter is specifies the radius used to search for candidate near features. The near features within this radius are considered for calculating the nearest feature. If no value is specified, that is the default (empty)radius is used, all near features are considered for calculation. You can specify any distance unit replacing the default unit of the input features. This is an optional parameter.

Parameters:

searchRadius - specifies the radius used to search for candidate near features. The near features within this radius are considered for calculating the nearest feature. If no value is specified, that is the default (empty)radius is used, all near features are considered for calculation. You can specify any distance unit replacing the default unit of the input features.

getLocation

public String getLocation()

Returns the Location parameter of this tool . This parameter is specifies whether x and y coordinates of the nearest location of the near feature will be written to new fields NEAR_X and NEAR_Y respectively. This is an optional parameter.

Returns:

the Location

setLocation

public void setLocation(String location)

Sets the Location parameter of this tool . This parameter is specifies whether x and y coordinates of the nearest location of the near feature will be written to new fields NEAR_X and NEAR_Y respectively. This is an optional parameter.

Parameters:

location - specifies whether x and y coordinates of the nearest location of the near feature will be written to new fields NEAR_X and NEAR_Y respectively.

getAngle

public String getAngle()

Returns the Angle parameter of this tool . This parameter is specifies whether the near angle values in decimal degrees will be calculated and written to a new field, NEAR_ANGLE. A near angle measures from the x-axis (horizontal axis) to the direction of the line connecting an input feature to its nearest feature at their closest locations; and it is within the range of 0 to 180 or 0 to -180 decimal degrees. This is an optional parameter.

Returns:

the Angle

setAngle

public void setAngle(String angle)

Sets the Angle parameter of this tool . This parameter is specifies whether the near angle values in decimal degrees will be calculated and written to a new field, NEAR_ANGLE. A near angle measures from the x-axis (horizontal axis) to the direction of the line connecting an input feature to its nearest feature at their closest locations; and it is within the range of 0 to 180 or 0 to -180 decimal degrees. This is an optional parameter.

Parameters:

angle - specifies whether the near angle values in decimal degrees will be calculated and written to a new field, NEAR_ANGLE. A near angle measures from the x-axis (horizontal axis) to the direction of the line connecting an input feature to its nearest feature at their closest locations; and it is within the range of 0 to 180 or 0 to -180 decimal degrees.

getClosest

public String getClosest()

Returns the Find only closest feature parameter of this tool . This parameter is determines whether to locate and return only the closest features or return all the features within the search radius. This is an optional parameter.

Returns:

the Find only closest feature

setClosest

public void setClosest(String closest)

Sets the Find only closest feature parameter of this tool . This parameter is determines whether to locate and return only the closest features or return all the features within the search radius. This is an optional parameter.

Parameters:

closest - determines whether to locate and return only the closest features or return all the features within the search radius.

getClosestCount

public int getClosestCount()

Returns the Maximum number of closest matches parameter of this tool . This parameter is find only the specified number of closest features. This parameter will not be used if the Find only closest feature option is checked. This is an optional parameter.

Returns:

the Maximum number of closest matches

setClosestCount

public void setClosestCount(int closestCount)

Sets the Maximum number of closest matches parameter of this tool . This parameter is find only the specified number of closest features. This parameter will not be used if the Find only closest feature option is checked. This is an optional parameter.

Parameters:

closestCount - find only the specified number of closest features. This parameter will not be used if the Find only closest feature option is checked.

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