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

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

All Implemented Interfaces:

GPTool

public class RebuildAddressLocator

extends AbstractGPTool

Rebuilds an address locator The Rebuild Address Locator tool is contained in the Geocoding Tools tool box.

Software restrictions: none

Usage tips:

• You must have write privileges to the address locator to use this tool.
• The reference feature class and tables must be available. You may need to repair the address locator particularly the paths to the reference data if the data has been moved to a different location since the last time the locator was built.
• Address locators created based on a versioned geodatabase will be rebuilt using the same version.
• Composite address locators cannot be rebuilt.
• Address locators created with ArcGIS prior to version 9.2 or address locators provided by any StreetMap products cannot be rebuilt.
• The following environment settings affect this tool: Configuration keyword; workspace; , and scratch workspace;

Field Summary

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

vals

Constructor Summary

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

RebuildAddressLocator(java.lang.Object inAddressLocator)
Creates the Rebuild Address Locator tool with the required parameters.

Method Summary

java.lang.Object	getInAddressLocator() Returns the Input Address Locator parameter of this tool .
java.lang.Object	getOutAddressLocator() Returns the Output Address Locator parameter of this tool (Read only).
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	setInAddressLocator(java.lang.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(java.lang.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 - Address Locator, the address locator you want to rebuild

Method Detail

getInAddressLocator

public java.lang.Object getInAddressLocator()

Returns the Input Address Locator parameter of this tool . This parameter is Address Locator, the address locator you want to rebuild This is a required parameter.

Returns:

the Input Address Locator

setInAddressLocator

public void setInAddressLocator(java.lang.Object inAddressLocator)

Sets the Input Address Locator parameter of this tool . This parameter is Address Locator, the address locator you want to rebuild This is a required parameter.

Parameters:

inAddressLocator - Address Locator, the address locator you want to rebuild

getOutAddressLocator

public java.lang.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 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