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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.analysistools.Near
All Implemented Interfaces:
GPTool

public class Near
extends AbstractGPTool

Determines the distance from each feature in the input features to the nearest feature in the near features, within the search radius. The Near tool is contained in the Analysis Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
Near()
          Creates the Near tool with defaults.
Near(Object inFeatures, Object nearFeatures)
          Creates the Near tool with the required parameters.
 
Method Summary
 String getAngle()
          Returns the Angle 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 getOutFeatureClass()
          Returns the Output Feature Class parameter of this tool (Read only).
 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 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 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

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 inFeatures,
            Object nearFeatures)
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:
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.
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.

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.

getOutFeatureClass

public Object getOutFeatureClass()
Returns the Output Feature Class parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Feature Class

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