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

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

public class GeocodeAddresses
extends AbstractGPTool

Geocodes a table of addresses The Geocode Addresses tool is contained in the Geocoding Tools tool box.

Software restrictions: none

Illustration:

Usage tips:


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 - Table View, the address table to geocode
addressLocator - Address Locator, the address locator to use to geocode the address table
inAddressFields - Field Info, 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 control is the field's alias name.
outFeatureClass - Feature Class, the output geocoded feature class or shapefile
Method Detail

getInTable

public Object getInTable()
Returns the Input Table parameter of this tool . This parameter is Table View, the address table 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 Table View, the address table to geocode This is a required parameter.

Parameters:
inTable - Table View, the address table to geocode

getAddressLocator

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

Parameters:
addressLocator - Address Locator, the address locator to use to geocode the address table

getInAddressFields

public Object getInAddressFields()
Returns the Input Address Fields parameter of this tool . This parameter is Field Info, 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 control 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 Field Info, 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 control is the field's alias name. This is a required parameter.

Parameters:
inAddressFields - Field Info, 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 control is the field's alias name.

getOutFeatureClass

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

Parameters:
outFeatureClass - Feature Class, the output geocoded feature class or shapefile

getOutRelationshipType

public String getOutRelationshipType()
Returns the Dynamic Output Feature Class parameter of this tool . This parameter is String, 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 String, 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 - String, 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