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

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

All Implemented Interfaces:

GPTool

public class StandardizeAddresses

extends AbstractGPTool

Standardizes the address information in a table or feature class. When you create an address locator, the address fields in the reference data that you use for the locator should be standardized according to the geocoding rules used by the address locator. Doing so will increase the geocoding match rate that you can achieve with the address locator. The Standardize Addresses tool is contained in the Geocoding Tools tool box.

Software restrictions: none

Usage tips:

• The input address data can be any table or feature class supported by ArcGIS.
• If you are using an address locator style that geocodes addresses with house numbers (most address locator styles do this), you must include a field that contains a numeric value that represents the house number in the input address fields. Failing to do so will cause the Standardize Addresses tool to standardize the addresses, with missing house numbers, incorrectly. In most cases, the ObjectID field is a good choice, because this field is guaranteed to have a numeric value.
• In most cases, you should choose the address locator style that you will later use to create an address locator using the output of the Standardize Addresses tool.
• The output address fields that you select are the standardized address fields that will be written to the output table or feature class. If you are only using the Standardize Addresses tool to standardize the street names in the input table or feature class, then in most cases you will only need to write the standardized fields that contain components of the street name to the output table or feature class. If, however, you are using the Standardize Addresses tool to parse a field that contains an entire address (including the house number), then you should choose to write the standardized house number field to the output as well.
• If you choose to create Static output, then all fields from the input table or feature class will be copied to the output table or feature class. The output table or feature class will be the same type (either a table or a feature class) as the input table or feature class.
• If your input table or feature class and output table are in the same geodatabase workspace, you can choose to create dynamic output. If you choose this option, then the output table will contain only the standardized address fields that you choose, along with a field that contains a foreign key to the ObjectID in the input table or feature class. If you choose to create dynamic output, subsequent edits that you make to the address fields in the input table or feature class will automatically be reflected in the output table. The output of the Standardize Addresses tool is always a table if you choose to create dynamic output.
• By default, the Standardize Addresses tool will create static output, unless you explicitly specify to create dynamic output.
• 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

StandardizeAddresses()
Creates the Standardize Addresses tool with defaults.

StandardizeAddresses(java.lang.Object inAddressData, java.lang.Object inInputAddressFields, java.lang.Object inAddressLocatorStyle, java.lang.Object inOutputAddressFields, java.lang.Object outAddressData)
Creates the Standardize Addresses tool with the required parameters.

Method Summary

java.lang.Object	getInAddressData() Returns the Input Address Data parameter of this tool .
java.lang.Object	getInAddressLocatorStyle() Returns the Address Locator Style parameter of this tool .
java.lang.Object	getInInputAddressFields() Returns the Input Address Fields parameter of this tool .
java.lang.Object	getInOutputAddressFields() Returns the Output Address Fields parameter of this tool .
java.lang.String	getInRelationshipType() Returns the Dynamic Output Data.
java.lang.Object	getOutAddressData() Returns the Output Address Data 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	setInAddressData(java.lang.Object inAddressData) Sets the Input Address Data parameter of this tool .
void	setInAddressLocatorStyle(java.lang.Object inAddressLocatorStyle) Sets the Address Locator Style parameter of this tool .
void	setInInputAddressFields(java.lang.Object inInputAddressFields) Sets the Input Address Fields parameter of this tool .
void	setInOutputAddressFields(java.lang.Object inOutputAddressFields) Sets the Output Address Fields parameter of this tool .
void	setInRelationshipType(java.lang.String inRelationshipType) Sets the Dynamic Output Data.
void	setOutAddressData(java.lang.Object outAddressData) Sets the Output Address Data 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

StandardizeAddresses

public StandardizeAddresses()

Creates the Standardize Addresses tool with defaults.

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

StandardizeAddresses

public StandardizeAddresses(java.lang.Object inAddressData,
                            java.lang.Object inInputAddressFields,
                            java.lang.Object inAddressLocatorStyle,
                            java.lang.Object inOutputAddressFields,
                            java.lang.Object outAddressData)

Creates the Standardize 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:

inAddressData - Table View, the table or feature class containing address information that you want to standardize.

inInputAddressFields - String, the set of fields in the input table or feature class that, when concatenated, form the address to be standardized.

inAddressLocatorStyle - Address Locator Style, the address locator style to use to standardize the address information in the input table or feature class. When you specify an ArcSDE address locator style from the command line or within a scripting environment, you must qualify the name of the locator style with the ArcSDE workspace that contains it, as shown in the example below. This parameter does not use the Workspace environment variable.

inOutputAddressFields - String, the set of standardized address fields to include in the output table or feature class.

outAddressData - Dataset, the output table or feature class to create containing the standardized address fields.

Method Detail

getInAddressData

public java.lang.Object getInAddressData()

Returns the Input Address Data parameter of this tool . This parameter is Table View, the table or feature class containing address information that you want to standardize. This is a required parameter.

Returns:

the Input Address Data

setInAddressData

public void setInAddressData(java.lang.Object inAddressData)

Sets the Input Address Data parameter of this tool . This parameter is Table View, the table or feature class containing address information that you want to standardize. This is a required parameter.

Parameters:

inAddressData - Table View, the table or feature class containing address information that you want to standardize.

getInInputAddressFields

public java.lang.Object getInInputAddressFields()

Returns the Input Address Fields parameter of this tool . This parameter is String, the set of fields in the input table or feature class that, when concatenated, form the address to be standardized. This is a required parameter.

Returns:

the Input Address Fields

setInInputAddressFields

public void setInInputAddressFields(java.lang.Object inInputAddressFields)

Sets the Input Address Fields parameter of this tool . This parameter is String, the set of fields in the input table or feature class that, when concatenated, form the address to be standardized. This is a required parameter.

Parameters:

inInputAddressFields - String, the set of fields in the input table or feature class that, when concatenated, form the address to be standardized.

getInAddressLocatorStyle

public java.lang.Object getInAddressLocatorStyle()

Returns the Address Locator Style parameter of this tool . This parameter is Address Locator Style, the address locator style to use to standardize the address information in the input table or feature class. When you specify an ArcSDE address locator style from the command line or within a scripting environment, you must qualify the name of the locator style with the ArcSDE workspace that contains it, as shown in the example below. This parameter does not use the Workspace environment variable. This is a required parameter.

Returns:

the Address Locator Style

setInAddressLocatorStyle

public void setInAddressLocatorStyle(java.lang.Object inAddressLocatorStyle)

Sets the Address Locator Style parameter of this tool . This parameter is Address Locator Style, the address locator style to use to standardize the address information in the input table or feature class. When you specify an ArcSDE address locator style from the command line or within a scripting environment, you must qualify the name of the locator style with the ArcSDE workspace that contains it, as shown in the example below. This parameter does not use the Workspace environment variable. This is a required parameter.

Parameters:

inAddressLocatorStyle - Address Locator Style, the address locator style to use to standardize the address information in the input table or feature class. When you specify an ArcSDE address locator style from the command line or within a scripting environment, you must qualify the name of the locator style with the ArcSDE workspace that contains it, as shown in the example below. This parameter does not use the Workspace environment variable.

getInOutputAddressFields

public java.lang.Object getInOutputAddressFields()

Returns the Output Address Fields parameter of this tool . This parameter is String, the set of standardized address fields to include in the output table or feature class. This is a required parameter.

Returns:

the Output Address Fields

setInOutputAddressFields

public void setInOutputAddressFields(java.lang.Object inOutputAddressFields)

Sets the Output Address Fields parameter of this tool . This parameter is String, the set of standardized address fields to include in the output table or feature class. This is a required parameter.

Parameters:

inOutputAddressFields - String, the set of standardized address fields to include in the output table or feature class.

getOutAddressData

public java.lang.Object getOutAddressData()

Returns the Output Address Data parameter of this tool . This parameter is Dataset, the output table or feature class to create containing the standardized address fields. This is a required parameter.

Returns:

the Output Address Data

setOutAddressData

public void setOutAddressData(java.lang.Object outAddressData)

Sets the Output Address Data parameter of this tool . This parameter is Dataset, the output table or feature class to create containing the standardized address fields. This is a required parameter.

Parameters:

outAddressData - Dataset, the output table or feature class to create containing the standardized address fields.

getInRelationshipType

public java.lang.String getInRelationshipType()

Returns the Dynamic Output Data. parameter of this tool . This parameter is String, by default, the Standardize Addresses command creates Static output. The Dynamic option only works if both the input and output datasets are contained in the same geodatabase workspace. This is an optional parameter.

Returns:

the Dynamic Output Data.

setInRelationshipType

public void setInRelationshipType(java.lang.String inRelationshipType)

Sets the Dynamic Output Data. parameter of this tool . This parameter is String, by default, the Standardize Addresses command creates Static output. The Dynamic option only works if both the input and output datasets are contained in the same geodatabase workspace. This is an optional parameter.

Parameters:

inRelationshipType - String, by default, the Standardize Addresses command creates Static output. The Dynamic option only works if both the input and output datasets are contained in the same geodatabase workspace.

• Static—Creates a static copy of the rows or features in the input table or feature class in the output table or feature class.
• Dynamic—Creates a table containing the standardized address fields that is automatically updated when address fields in the input table or feature class are edited.

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