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. The Standardize Addresses tool is contained in the Geocoding Tools tool box.

Usage tips:

• The input address data can be a table or feature class that contains address attributes that can be standardized based on an address locator style.
• The input address you want to standardize can be stored in a single field, such as the Address field in a customer address table. You can then select the field as the Input Address Field in the tool.If the address information has already been broken into multiple fields in the input feature class or table which you can find in common reference street or point address data, the standardization process will concatenate the fields on the fly and standardize the information. You specify the fields in the order that forms the complete address.
• The standardized result can be saved in one of the following two output options:

Field Summary

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

vals

Constructor Summary

StandardizeAddresses()
Creates the Standardize Addresses tool with defaults.

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

Method Summary

Object	getInAddressData() Returns the Input Address Data parameter of this tool .
Object	getInAddressLocatorStyle() Returns the Address Locator Style parameter of this tool .
Object	getInInputAddressFields() Returns the Input Address Fields parameter of this tool .
Object	getInOutputAddressFields() Returns the Output Address Fields parameter of this tool .
String	getInRelationshipType() Returns the Dynamic Output Data.
Object	getOutAddressData() Returns the Output Address Data 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	setInAddressData(Object inAddressData) Sets the Input Address Data parameter of this tool .
void	setInAddressLocatorStyle(Object inAddressLocatorStyle) Sets the Address Locator Style parameter of this tool .
void	setInInputAddressFields(Object inInputAddressFields) Sets the Input Address Fields parameter of this tool .
void	setInOutputAddressFields(Object inOutputAddressFields) Sets the Output Address Fields parameter of this tool .
void	setInRelationshipType(String inRelationshipType) Sets the Dynamic Output Data.
void	setOutAddressData(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(Object inAddressData,
                            Object inInputAddressFields,
                            Object inAddressLocatorStyle,
                            Object inOutputAddressFields,
                            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 - the table or feature class containing address information that you want to standardize.

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

inAddressLocatorStyle - the address locator style to use to standardize the address information in the input table or feature class.

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

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

Method Detail

getInAddressData

public Object getInAddressData()

Returns the Input Address Data parameter of this tool . This parameter is 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(Object inAddressData)

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

Parameters:

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

getInInputAddressFields

public Object getInInputAddressFields()

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

Returns:

the Input Address Fields

setInInputAddressFields

public void setInInputAddressFields(Object inInputAddressFields)

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

Parameters:

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

getInAddressLocatorStyle

public Object getInAddressLocatorStyle()

Returns the Address Locator Style parameter of this tool . This parameter is the address locator style to use to standardize the address information in the input table or feature class. This is a required parameter.

Returns:

the Address Locator Style

setInAddressLocatorStyle

public void setInAddressLocatorStyle(Object inAddressLocatorStyle)

Sets the Address Locator Style parameter of this tool . This parameter is the address locator style to use to standardize the address information in the input table or feature class. This is a required parameter.

Parameters:

inAddressLocatorStyle - the address locator style to use to standardize the address information in the input table or feature class.

getInOutputAddressFields

public Object getInOutputAddressFields()

Returns the Output Address Fields parameter of this tool . This parameter is 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(Object inOutputAddressFields)

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

Parameters:

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

getOutAddressData

public Object getOutAddressData()

Returns the Output Address Data parameter of this tool . This parameter is 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(Object outAddressData)

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

Parameters:

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

getInRelationshipType

public String getInRelationshipType()

Returns the Dynamic Output Data. parameter of this tool . This parameter is indicates whether to create a static or dynamic output dataset. This is an optional parameter.

Returns:

the Dynamic Output Data.

setInRelationshipType

public void setInRelationshipType(String inRelationshipType)

Sets the Dynamic Output Data. parameter of this tool . This parameter is indicates whether to create a static or dynamic output dataset. This is an optional parameter.

Parameters:

inRelationshipType - indicates whether to create a static or dynamic output dataset.

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