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

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

public class Near
extends AbstractGPTool

Computes the distance from each point in a coverage to the nearest arc, point, or node in another coverage. The Near tool is contained in the Coverage 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(java.lang.Object inCover, java.lang.Object nearCover, java.lang.Object outCover)
          Creates the Near tool with the required parameters.
 
Method Summary
 java.lang.String getFeatureType()
          Returns the Feature Type parameter of this tool .
 java.lang.Object getInCover()
          Returns the Input Coverage parameter of this tool .
 java.lang.String getLocation()
          Returns the Save location of nearest feature parameter of this tool .
 java.lang.Object getNearCover()
          Returns the Near Coverage parameter of this tool .
 java.lang.Object getOutCover()
          Returns the Output Coverage parameter of this tool .
 double getSearchRadius()
          Returns the Search Radius parameter of this tool .
 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 setFeatureType(java.lang.String featureType)
          Sets the Feature Type parameter of this tool .
 void setInCover(java.lang.Object inCover)
          Sets the Input Coverage parameter of this tool .
 void setLocation(java.lang.String location)
          Sets the Save location of nearest feature parameter of this tool .
 void setNearCover(java.lang.Object nearCover)
          Sets the Near Coverage parameter of this tool .
 void setOutCover(java.lang.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(java.lang.Object inCover,
            java.lang.Object nearCover,
            java.lang.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 - the coverage containing points from which distances are calculated to each closest arc, point, or node in the .
nearCover - the line or point coverage whose features are used to calculate distances from each input cover point. This must be different from the input cover.
outCover - the coverage to be created. The is copied to the , then NEAR is performed on the .
Method Detail

getInCover

public java.lang.Object getInCover()
Returns the Input Coverage parameter of this tool . This parameter is 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(java.lang.Object inCover)
Sets the Input Coverage parameter of this tool . This parameter is 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 - the coverage containing points from which distances are calculated to each closest arc, point, or node in the .

getNearCover

public java.lang.Object getNearCover()
Returns the Near Coverage parameter of this tool . This parameter is the line or point coverage whose features are used to calculate distances from each input cover point. This must be different from the input cover. This is a required parameter.

Returns:
the Near Coverage

setNearCover

public void setNearCover(java.lang.Object nearCover)
Sets the Near Coverage parameter of this tool . This parameter is the line or point coverage whose features are used to calculate distances from each input cover point. This must be different from the input cover. This is a required parameter.

Parameters:
nearCover - the line or point coverage whose features are used to calculate distances from each input cover point. This must be different from the input cover.

getOutCover

public java.lang.Object getOutCover()
Returns the Output Coverage parameter of this tool . This parameter is 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(java.lang.Object outCover)
Sets the Output Coverage parameter of this tool . This parameter is the coverage to be created. The is copied to the , then NEAR is performed on the . This is a required parameter.

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

getFeatureType

public java.lang.String getFeatureType()
Returns the Feature Type parameter of this tool . This parameter is 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(java.lang.String featureType)
Sets the Feature Type parameter of this tool . This parameter is 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 - 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 the maximum distance in coverage units between input cover features and near cover features for which distance and near cover internal number will be determined. if no near cover feature is within the search radius of a given input cover point or line, both the internal number and distance output by NEAR will be zero. 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 the maximum distance in coverage units between input cover features and near cover features for which distance and near cover internal number will be determined. if no near cover feature is within the search radius of a given input cover point or line, both the internal number and distance output by NEAR will be zero. 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 - the maximum distance in coverage units between input cover features and near cover features for which distance and near cover internal number will be determined. if no near cover feature is within the search radius of a given input cover point or line, both the internal number and distance output by NEAR will be zero. 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 java.lang.String getLocation()
Returns the Save location of nearest feature parameter of this tool . This parameter is 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(java.lang.String location)
Sets the Save location of nearest feature parameter of this tool . This parameter is 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 - 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 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