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

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

All Implemented Interfaces:

GPTool

public class GeocodeAddresses
extends AbstractGPTool

Geocodes a table of addresses. This process requires a table that stores the addresses you want to geocode and an address locator or a composite address locator. This tool matches the addresses against the address locator and saves the result for each input record in a new point feature class. The Geocode Addresses tool is contained in the Geocoding Tools tool box.

Usage tips:

• The output feature class is saved in the same spatial reference as the address locator. Changing the spatial reference of the output feature class is possible by setting a different in the tool's .
• The output feature class, by default, stores a copy of input address and additional information such as score, status, and matched address of each record. The addresses can be rematched either using the tool or the dialog box in ArcMap. Editing addresses in the input address table will not change the result in the output feature class once the matching process finishes and the feature class is created.
• Set the Dynamic Output Feature Class parameter to true (checked) if you want the matching result in the output feature class to be updated automatically when the input address table is updated. A relationship class is created for the input table and the output feature class. When an address in the input table is changed in an editing session in ArcMap, the address will be geocoded again immediately and the related record in the output feature class will be updated with the new geocoding result. The automatic update is also supported for adding a new record or deleting an existing record in the input table.This option is disabled if you are using a Basic license, as relationship classes cannot be generated with a Basic licence.

Field Summary

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

vals

Constructor Summary

GeocodeAddresses()
Creates the Geocode Addresses tool with defaults.

GeocodeAddresses(Object inTable, Object addressLocator, Object inAddressFields, Object outFeatureClass)
Creates the Geocode Addresses tool with the required parameters.

Method Summary

Object	getAddressLocator() Returns the Input Address Locator parameter of this tool .
Object	getInAddressFields() Returns the Input Address Fields parameter of this tool .
Object	getInTable() Returns the Input Table parameter of this tool .
Object	getOutFeatureClass() Returns the Output Feature Class parameter of this tool .
String	getOutRelationshipType() Returns the Dynamic Output Feature Class 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	setAddressLocator(Object addressLocator) Sets the Input Address Locator parameter of this tool .
void	setInAddressFields(Object inAddressFields) Sets the Input Address Fields parameter of this tool .
void	setInTable(Object inTable) Sets the Input Table parameter of this tool .
void	setOutFeatureClass(Object outFeatureClass) Sets the Output Feature Class parameter of this tool .
void	setOutRelationshipType(String outRelationshipType) Sets the Dynamic Output Feature Class 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

GeocodeAddresses

public GeocodeAddresses()

Creates the Geocode Addresses tool with defaults.

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

GeocodeAddresses

public GeocodeAddresses(Object inTable,
                        Object addressLocator,
                        Object inAddressFields,
                        Object outFeatureClass)

Creates the Geocode Addresses 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:

inTable - the table of addresses to geocode.

addressLocator - the address locator to use to geocode the table of addresses.

inAddressFields - the mapping of address fields used by the address locator to fields in the input table of addresses. each field mapping in this parameter is in the format where is the name of the input address field used by the address locator, and is the name of the corresponding field in the table of addresses. if you choose not to map an optional input address field used by the address locator to a field in the input table of addresses, specify that there is no mapping by using "" in place of a field name. to determine the alias name for a reference data field used by a locator style, open the Create Address Locator tool and choose the locator style. The name that appears in the Field Name column of the Field Map section is the field's alias name.

outFeatureClass - the output geocoded feature class or shapefile.

Method Detail

getInTable

public Object getInTable()

Returns the Input Table parameter of this tool . This parameter is the table of addresses to geocode. This is a required parameter.

Returns:

the Input Table

setInTable

public void setInTable(Object inTable)

Sets the Input Table parameter of this tool . This parameter is the table of addresses to geocode. This is a required parameter.

Parameters:

inTable - the table of addresses to geocode.

getAddressLocator

public Object getAddressLocator()

Returns the Input Address Locator parameter of this tool . This parameter is the address locator to use to geocode the table of addresses. This is a required parameter.

Returns:

the Input Address Locator

setAddressLocator

public void setAddressLocator(Object addressLocator)

Sets the Input Address Locator parameter of this tool . This parameter is the address locator to use to geocode the table of addresses. This is a required parameter.

Parameters:

addressLocator - the address locator to use to geocode the table of addresses.

getInAddressFields

public Object getInAddressFields()

Returns the Input Address Fields parameter of this tool . This parameter is the mapping of address fields used by the address locator to fields in the input table of addresses. each field mapping in this parameter is in the format where is the name of the input address field used by the address locator, and is the name of the corresponding field in the table of addresses. if you choose not to map an optional input address field used by the address locator to a field in the input table of addresses, specify that there is no mapping by using "" in place of a field name. to determine the alias name for a reference data field used by a locator style, open the Create Address Locator tool and choose the locator style. The name that appears in the Field Name column of the Field Map section is the field's alias name. This is a required parameter.

Returns:

the Input Address Fields

setInAddressFields

public void setInAddressFields(Object inAddressFields)

Sets the Input Address Fields parameter of this tool . This parameter is the mapping of address fields used by the address locator to fields in the input table of addresses. each field mapping in this parameter is in the format

where is the name of the input address field used by the address locator, and is the name of the corresponding field in the table of addresses. if you choose not to map an optional input address field used by the address locator to a field in the input table of addresses, specify that there is no mapping by using "" in place of a field name. to determine the alias name for a reference data field used by a locator style, open the Create Address Locator tool and choose the locator style. The name that appears in the Field Name column of the Field Map section is the field's alias name. This is a required parameter.

Parameters:

inAddressFields - the mapping of address fields used by the address locator to fields in the input table of addresses. each field mapping in this parameter is in the format

where is the name of the input address field used by the address locator, and is the name of the corresponding field in the table of addresses. if you choose not to map an optional input address field used by the address locator to a field in the input table of addresses, specify that there is no mapping by using "" in place of a field name. to determine the alias name for a reference data field used by a locator style, open the Create Address Locator tool and choose the locator style. The name that appears in the Field Name column of the Field Map section is the field's alias name.

getOutFeatureClass

public Object getOutFeatureClass()

Returns the Output Feature Class parameter of this tool . This parameter is the output geocoded feature class or shapefile. 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 geocoded feature class or shapefile. This is a required parameter.

Parameters:

outFeatureClass - the output geocoded feature class or shapefile.

getOutRelationshipType

public String getOutRelationshipType()

Returns the Dynamic Output Feature Class parameter of this tool . This parameter is indicates whether to create a static copy of the address table inside the geocoded feature class or to create a dynamically updated geocoded feature class. This is an optional parameter.

Returns:

the Dynamic Output Feature Class

setOutRelationshipType

public void setOutRelationshipType(String outRelationshipType)

Sets the Dynamic Output Feature Class parameter of this tool . This parameter is indicates whether to create a static copy of the address table inside the geocoded feature class or to create a dynamically updated geocoded feature class. This is an optional parameter.

Parameters:

outRelationshipType - indicates whether to create a static copy of the address table inside the geocoded feature class or to create a dynamically updated geocoded 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