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

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.coveragetools.Near

All Implemented Interfaces:

GPTool

public class Near
extends AbstractGPTool

This tool only works with an ArcInfo license and will only be available in ArcToolbox if you have installed ArcInfo Workstation. Near computes the distance from each point in a coverage to the nearest arc, point, or node in another coverage. The search radius is the maximum distance in coverage units a feature can be from the current point for consideration as the closest feature. The default is the width or height of the near coverage BND divided by 100, whichever is larger. The results are recorded in the Output coverage point attribute table (PAT). Items for DISTANCE and the internal number of the closest feature are added or updated; items for x and y coordinates are added when Record x,y coordinates of nearest feature are checked. All item values are set to zero if no feature is found within the search radius. The Near tool is contained in the Coverage Tools tool box.
Learn more about how Near works

Software restrictions: ArcInfo only

Illustration:

Usage tips:

• DISTANCE values are recalculated if this item already exists in the input coverage. If the DISTANCE item is added, it will be in the same precision as the coverage. Items output by NEAR include:
  
  These items are added to the input coverage PAT. If an item named DISTANCE already exists, the values will be recalculated. If the DISTANCE item is added, it will be in the same precision as the coverage. The values for both items will be zero if no match is found within the search_radius for a particular input coverage point.
• The calculated distance from point to arc will be from the point to the nearest location along the arc. The calculated distance from point to node will be between the nearest node locations on the arcs.
• The distance and the internal number of the closest feature are saved as new items in the input coverage's feature attribute table.
• NEAR skips duplicate node numbers to increase operation time.
• The coordinate precision of input coverage is not affected by NEAR.
• NEAR is useful for assigning point attributes to nearest arcs, or vice versa. This operation is helpful in assigning address ranges to arcs; associating point attributes to nodes, such as DIME node numbers; or finding the nearest available line in a network (for example, determining which sewer line a property might connect with).
• Common uses for Near include:
• The following environments affect this tool: derivedPrecision; newPrecision; projectCompare; scratchWorkspace; , and workspace;

Field Summary

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

vals

Constructor Summary

Near()
Creates the Near tool with defaults.

Near(Object inCover, Object nearCover, Object outCover)
Creates the Near tool with the required parameters.

Method Summary

String	getFeatureType() Returns the Feature Type parameter of this tool .
Object	getInCover() Returns the Input Coverage parameter of this tool .
String	getLocation() Returns the Save location of nearest feature parameter of this tool .
Object	getNearCover() Returns the Near Coverage parameter of this tool .
Object	getOutCover() Returns the Output Coverage parameter of this tool .
double	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	setFeatureType(String featureType) Sets the Feature Type parameter of this tool .
void	setInCover(Object inCover) Sets the Input Coverage parameter of this tool .
void	setLocation(String location) Sets the Save location of nearest feature parameter of this tool .
void	setNearCover(Object nearCover) Sets the Near Coverage parameter of this tool .
void	setOutCover(Object outCover) Sets the Output Coverage parameter of this tool .
void	setSearchRadius(double 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

Near

public Near()

Creates the Near tool with defaults.

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

Near

public Near(Object inCover,
            Object nearCover,
            Object outCover)

Creates the Near 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 points from which distances are calculated to each closest arc, point, or node in the .

nearCover - Coverage, the line or point coverage whose features are used to calculate distances from each point. The must be different from the .

outCover - Coverage, the coverage to be created. The is copied to the , then NEAR is performed on the .

Method Detail

getInCover

public Object getInCover()

Returns the Input Coverage parameter of this tool . This parameter is Coverage, the coverage containing points from which distances are calculated to each closest arc, point, or node in the . 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 points from which distances are calculated to each closest arc, point, or node in the . This is a required parameter.

Parameters:

inCover - Coverage, the coverage containing points from which distances are calculated to each closest arc, point, or node in the .

getNearCover

public Object getNearCover()

Returns the Near Coverage parameter of this tool . This parameter is Coverage, the line or point coverage whose features are used to calculate distances from each point. The must be different from the . This is a required parameter.

Returns:

the Near Coverage

setNearCover

public void setNearCover(Object nearCover)

Sets the Near Coverage parameter of this tool . This parameter is Coverage, the line or point coverage whose features are used to calculate distances from each point. The must be different from the . This is a required parameter.

Parameters:

nearCover - Coverage, the line or point coverage whose features are used to calculate distances from each point. The must be different from the .

getOutCover

public Object getOutCover()

Returns the Output Coverage parameter of this tool . This parameter is Coverage, the coverage to be created. The is copied to the , then NEAR is performed on the . 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 coverage to be created. The is copied to the , then NEAR is performed on the . This is a required parameter.

Parameters:

outCover - Coverage, the coverage to be created. The is copied to the , then NEAR is performed on the .

getFeatureType

public String getFeatureType()

Returns the Feature Type parameter of this tool . This parameter is String, the type of feature that will be searched from points to find the nearest feature and calculate the distance between them. This is an optional parameter.

Returns:

the Feature Type

setFeatureType

public void setFeatureType(String featureType)

Sets the Feature Type parameter of this tool . This parameter is String, the type of feature that will be searched from points to find the nearest feature and calculate the distance between them. This is an optional parameter.

Parameters:

featureType - String, the type of feature that will be searched from points to find the nearest feature and calculate the distance between them.

getSearchRadius

public double getSearchRadius()

Returns the Search Radius parameter of this tool . This parameter is Double, the default search radius is the width or height of the near coverage BND divided by 100, whichever is larger. This default search radius is used whenever the search radius argument is set to zero or skipped. This is an optional parameter.

Returns:

the Search Radius

setSearchRadius

public void setSearchRadius(double searchRadius)

Sets the Search Radius parameter of this tool . This parameter is Double, the default search radius is the width or height of the near coverage BND divided by 100, whichever is larger. This default search radius is used whenever the search radius argument is set to zero or skipped. This is an optional parameter.

Parameters:

searchRadius - Double, the default search radius is the width or height of the near coverage BND divided by 100, whichever is larger. This default search radius is used whenever the search radius argument is set to zero or skipped.

getLocation

public String getLocation()

Returns the Save location of nearest feature parameter of this tool . This parameter is String, determines whether the x,y coordinates of the "nearest point" of the closest arc, point, or node are to be saved as well as the cover# and distance. The new items are X-COORD and Y-COORD. This is an optional parameter.

Returns:

the Save location of nearest feature

setLocation

public void setLocation(String location)

Sets the Save location of nearest feature parameter of this tool . This parameter is String, determines whether the x,y coordinates of the "nearest point" of the closest arc, point, or node are to be saved as well as the cover# and distance. The new items are X-COORD and Y-COORD. This is an optional parameter.

Parameters:

location - String, determines whether the x,y coordinates of the "nearest point" of the closest arc, point, or node are to be saved as well as the cover# and distance. The new items are X-COORD and Y-COORD.

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