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 distance from each feature in the Input Features to the nearest 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.
Learn more about how Generate Near Table works

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• This tool behaves the same as NEAR but it will be required to create a new output table. The table will contain the INPUT_FID, NEAR_FID and other attributes such as NEAR_XY, NEAR_ANGLE, NEAR_FC if necessary. The input features will not be updated with this tool.
• The output table can be joined back to the input feature class or a near feature class using the original FIDs.
• The and support any geometry type: feature types:
• The default option for this tool is to output only the closest features. However, the user can choose the ALL option to create the table containing all the near features within the search radius.
• The values for NEAR_DIST will be -1 if no match is found within the Search Radius.
• The values for NEAR_FID will be -1 if no match is found within the specified Search Radius.
• If the fields NEAR_DIST and NEAR_FID already exist, the values will be recalculated.
• If no Search Radius is specified, a radius large enough to calculate a distance from each input feature to the closest near feature will be used.
• If the Near Features are polylines, the distance is calculated from the location on the polyline closest to the Input Feature. If a polyline in the Near Features touches or intersects a feature from the Input Features, the distance will be zero.
• If the Near Features is a Polygon feature class, the distance is calculated from a point on the boundary of the polygon closest to the Input Feature. If a polygon in the Near Features contains or intersects a feature from the Input Features, the distance will be zero.
• The distances calculated by Near are determined by the units of the Input Features. If the linear units of the input feature class are in Meters, the Search Radius will default to Meters. The units of the Search Radius can be changed. Specifying one kilometer is the same as entering one thousand meters. However, the value for the NEAR_DIST will based on the units of the input.
• Angles are measured in degrees, where one degree represents 1/360 of a circle, and fractions of a degree are represented as decimal points. Angles are measured from 180 to -180; 0 to the east, 90 to the north, 180 (-180) to the west, and -90 to the south.
• Both the Input Features and Near Features can be the same dataset. In any instance where the Input Feature & Near feature are the same, the result will be calculated to -1.
• The following environment affects this tool: Extent;

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 Maxinum 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 Maxinum 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 - Feature Layer, the feature class or layer containing features from which near distances are calculated to each feature in the Near Features.

nearFeatures - Feature Layer, the feature class or layer containing features from which distances are calculated to the closest feature in the Input Features. If multiple feature classes or layers are specified, an extra field named NEAR_FC will be added to the output table to identify which near feature class contains the closest feature.

outTable - Table, the output table that will contain the proximity information such as INPUT_FID, NEAR_FID, NEAR_DIST and other attributes such as NEAR_XY, NEAR_ANGLE, NEAR_FC if necessary.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is Feature Layer, the feature class or layer containing features from which near distances are calculated to each feature in the Near Features. 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 Feature Layer, the feature class or layer containing features from which near distances are calculated to each feature in the Near Features. This is a required parameter.

Parameters:

inFeatures - Feature Layer, the feature class or layer containing features from which near distances are calculated to each feature in the Near Features.

getNearFeatures

public Object getNearFeatures()

Returns the Near Features parameter of this tool . This parameter is Feature Layer, the feature class or layer containing features from which distances are calculated to the closest feature in the Input Features. If multiple feature classes or layers are specified, an extra field named NEAR_FC will be added to the output table to identify which near feature class contains the closest feature. 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 Feature Layer, the feature class or layer containing features from which distances are calculated to the closest feature in the Input Features. If multiple feature classes or layers are specified, an extra field named NEAR_FC will be added to the output table to identify which near feature class contains the closest feature. This is a required parameter.

Parameters:

nearFeatures - Feature Layer, the feature class or layer containing features from which distances are calculated to the closest feature in the Input Features. If multiple feature classes or layers are specified, an extra field named NEAR_FC will be added to the output table to identify which near feature class contains the closest feature.

getOutTable

public Object getOutTable()

Returns the Output Table parameter of this tool . This parameter is Table, the output table that will contain the proximity information such as INPUT_FID, NEAR_FID, NEAR_DIST and other attributes such as NEAR_XY, NEAR_ANGLE, 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 Table, the output table that will contain the proximity information such as INPUT_FID, NEAR_FID, NEAR_DIST and other attributes such as NEAR_XY, NEAR_ANGLE, NEAR_FC if necessary. This is a required parameter.

Parameters:

outTable - Table, the output table that will contain the proximity information such as INPUT_FID, NEAR_FID, NEAR_DIST and other attributes such as NEAR_XY, NEAR_ANGLE, NEAR_FC if necessary.

getSearchRadius

public Object getSearchRadius()

Returns the Search Radius parameter of this tool . This parameter is Linear unit, the maximum distance between Input Features and Near Features for which distance and FID's will be determined. If no Search Radius is specified, all Near Features will be used. 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 Linear unit, the maximum distance between Input Features and Near Features for which distance and FID's will be determined. If no Search Radius is specified, all Near Features will be used. This is an optional parameter.

Parameters:

searchRadius - Linear unit, the maximum distance between Input Features and Near Features for which distance and FID's will be determined. If no Search Radius is specified, all Near Features will be used.

getLocation

public String getLocation()

Returns the Location parameter of this tool . This parameter is String, determines whether the x,y coordinates of the nearest feature are added to the output table, as well as NEAR_FID and NEAR_DIST. The new fields are NEAR_X and NEAR_Y. This is an optional parameter.

Returns:

the Location

setLocation

public void setLocation(String location)

Sets the Location parameter of this tool . This parameter is String, determines whether the x,y coordinates of the nearest feature are added to the output table, as well as NEAR_FID and NEAR_DIST. The new fields are NEAR_X and NEAR_Y. This is an optional parameter.

Parameters:

location - String, determines whether the x,y coordinates of the nearest feature are added to the output table, as well as NEAR_FID and NEAR_DIST. The new fields are NEAR_X and NEAR_Y.

getAngle

public String getAngle()

Returns the Angle parameter of this tool . This parameter is String, determines whether the angle between the near feature will calculated, and stored into the NEAR_ANGLE field. The angle value is measured in degrees, where one degree represents 1/360 of a circle, and fractions of a degree are represented as decimal points. Angles are measured from 180 to -180; 0 to the east, 90 to the north, 180 (-180) to the west, and -90 to the south. This is an optional parameter.

Returns:

the Angle

setAngle

public void setAngle(String angle)

Sets the Angle parameter of this tool . This parameter is String, determines whether the angle between the near feature will calculated, and stored into the NEAR_ANGLE field. The angle value is measured in degrees, where one degree represents 1/360 of a circle, and fractions of a degree are represented as decimal points. Angles are measured from 180 to -180; 0 to the east, 90 to the north, 180 (-180) to the west, and -90 to the south. This is an optional parameter.

Parameters:

angle - String, determines whether the angle between the near feature will calculated, and stored into the NEAR_ANGLE field. The angle value is measured in degrees, where one degree represents 1/360 of a circle, and fractions of a degree are represented as decimal points. Angles are measured from 180 to -180; 0 to the east, 90 to the north, 180 (-180) to the west, and -90 to the south.

getClosest

public String getClosest()

Returns the Find only closest feature parameter of this tool . This parameter is String, 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 String, 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 - String, 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 Maxinum number of closest matches parameter of this tool . This parameter is Long, finds only the specified number of closest features. This parameter is disabled if Find only closest feature is selected. This is an optional parameter.

Returns:

the Maxinum number of closest matches

setClosestCount

public void setClosestCount(int closestCount)

Sets the Maxinum number of closest matches parameter of this tool . This parameter is Long, finds only the specified number of closest features. This parameter is disabled if Find only closest feature is selected. This is an optional parameter.

Parameters:

closestCount - Long, finds only the specified number of closest features. This parameter is disabled if Find only closest feature is selected.

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