com.esri.arcgis.geoprocessing.tools.geocodingtools
Class ReverseGeocode

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.geocodingtools.ReverseGeocode

All Implemented Interfaces:

GPTool

public class ReverseGeocode
extends AbstractGPTool

Creates addresses from point locations in a feature class. The reverse geocoding process searches for the nearest address or intersection for the point location based on the specified search distance. The Reverse Geocode tool is contained in the Geocoding Tools tool box.

Usage tips:

• The input feature class must contain point shapes with valid XY coordinates. Addresses will not be returned on points with null coordinates.
• The output feature class will contain the same number of records as in the input feature class. Additional fields containing the result addresses are added to the feature class. The names of the fields are prefixed with "REV_". If an address cannot be found, the fields will contain empty values.
• If the spatial reference of the input feature class is different from the address locator, the address locator will transform the coordinates on the fly and try to find the match. The output feature class will be saved in the same spatial reference as the input feature class. Changing the spatial reference of the output feature class is possible by setting a different in the tool's .
• If a point in the input feature class fails to return an address, it means there are no features in the address locator that can be associated with the input point. Here are a few common causes for the unmatched points:
  • The search distance is too small that the point cannot find any nearest features.
  • The point contains null coordinates.
  • The point's coordinates are incorrect and cannot be transformed to the spatial reference used in the address locator.
  • The address locator does not contain reference features in the area that can be associated with the point.
  You may increase the search distance so that the chance to find the nearest address is higher, or use a different address locator that contains more features or covers a bigger area to match the input points.

Field Summary

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

vals

Constructor Summary

ReverseGeocode()
Creates the Reverse Geocode tool with defaults.

ReverseGeocode(Object inFeatures, Object inAddressLocator, Object outFeatureClass, Object searchDistance)
Creates the Reverse Geocode tool with the required parameters.

Method Summary

String	getAddressType() Returns the Address Type parameter of this tool .
Object	getInAddressLocator() Returns the Input Address Locator parameter of this tool .
Object	getInFeatures() Returns the Input Features parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
Object	getSearchDistance() Returns the Within 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	setAddressType(String addressType) Sets the Address Type parameter of this tool .
void	setInAddressLocator(Object inAddressLocator) Sets the Input Address Locator parameter of this tool .
void	setInFeatures(Object inFeatures) Sets the Input Features parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setSearchDistance(Object searchDistance) Sets the Within 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

ReverseGeocode

public ReverseGeocode()

Creates the Reverse Geocode tool with defaults.

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

ReverseGeocode

public ReverseGeocode(Object inFeatures,
                      Object inAddressLocator,
                      Object outFeatureClass,
                      Object searchDistance)

Creates the Reverse Geocode 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 - a point feature class or layer from which addresses are returned based on the features' point location.

inAddressLocator - the address locator to use to reverse geocode the input feature class.

outFeatureClass - the output feature class.

searchDistance - the distance used to search for the nearest address or intersection for the point location.

Method Detail

getInFeatures

public Object getInFeatures()

Returns the Input Features parameter of this tool . This parameter is a point feature class or layer from which addresses are returned based on the features' point location. 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 a point feature class or layer from which addresses are returned based on the features' point location. This is a required parameter.

Parameters:

inFeatures - a point feature class or layer from which addresses are returned based on the features' point location.

getInAddressLocator

public Object getInAddressLocator()

Returns the Input Address Locator parameter of this tool . This parameter is the address locator to use to reverse geocode the input feature class. This is a required parameter.

Returns:

the Input Address Locator

setInAddressLocator

public void setInAddressLocator(Object inAddressLocator)

Sets the Input Address Locator parameter of this tool . This parameter is the address locator to use to reverse geocode the input feature class. This is a required parameter.

Parameters:

inAddressLocator - the address locator to use to reverse geocode the input feature class.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output feature class. This is a required parameter.

Returns:

the Output Feature Class

setOutFeatureClass

public void setOutFeatureClass(Object outFeatureClass)

Sets the Output Feature Class parameter of this tool . This parameter is the output feature class. This is a required parameter.

Parameters:

outFeatureClass - the output feature class.

getAddressType

public String getAddressType()

Returns the Address Type parameter of this tool . This parameter is indicates whether to return addresses for the points as street addresses or intersection addresses if the address locator supports intersection matching. This is an optional parameter.

Returns:

the Address Type

setAddressType

public void setAddressType(String addressType)

Sets the Address Type parameter of this tool . This parameter is indicates whether to return addresses for the points as street addresses or intersection addresses if the address locator supports intersection matching. This is an optional parameter.

Parameters:

addressType - indicates whether to return addresses for the points as street addresses or intersection addresses if the address locator supports intersection matching.

getSearchDistance

public Object getSearchDistance()

Returns the Within parameter of this tool . This parameter is the distance used to search for the nearest address or intersection for the point location. This is a required parameter.

Returns:

the Within

setSearchDistance

public void setSearchDistance(Object searchDistance)

Sets the Within parameter of this tool . This parameter is the distance used to search for the nearest address or intersection for the point location. This is a required parameter.

Parameters:

searchDistance - the distance used to search for the nearest address or intersection for the point location.

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