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

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

public class RebuildAddressLocator
extends AbstractGPTool

Rebuilds an address locator to update the locator with the current reference data. Since an address locator contains a snapshot of the reference data when it was created, it will not geocode addresses against the updated data when the geometry and attributes of the reference data are changed. To geocode addresses against the current version of the reference data, the address locator must be rebuilt if you want to update the changes in the locator. The Rebuild Address Locator tool is contained in the Geocoding Tools tool box.

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
RebuildAddressLocator()
          Creates the Rebuild Address Locator tool with defaults.
RebuildAddressLocator(Object inAddressLocator)
          Creates the Rebuild Address Locator tool with the required parameters.
 
Method Summary
 Object getInAddressLocator()
          Returns the Input Address Locator parameter of this tool .
 Object getOutAddressLocator()
          Returns the Output Address Locator parameter of this tool (Read only).
 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 setInAddressLocator(Object inAddressLocator)
          Sets the Input Address Locator 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

RebuildAddressLocator

public RebuildAddressLocator()
Creates the Rebuild Address Locator tool with defaults.

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


RebuildAddressLocator

public RebuildAddressLocator(Object inAddressLocator)
Creates the Rebuild Address Locator 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:
inAddressLocator - the address locator to rebuild.
Method Detail

getInAddressLocator

public Object getInAddressLocator()
Returns the Input Address Locator parameter of this tool . This parameter is the address locator to rebuild. 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 rebuild. This is a required parameter.

Parameters:
inAddressLocator - the address locator to rebuild.

getOutAddressLocator

public Object getOutAddressLocator()
Returns the Output Address Locator parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Address Locator

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