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

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

public class CreateAddressLocator
extends AbstractGPTool

Creates an address locator The Create Address Locator tool is contained in the Geocoding Tools tool box.

Software restrictions: none

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
CreateAddressLocator()
          Creates the Create Address Locator tool with defaults.
CreateAddressLocator(Object inAddressLocatorStyle, Object inReferenceData, Object inFieldMap, Object outAddressLocator)
          Creates the Create Address Locator tool with the required parameters.
 
Method Summary
 String getConfigKeyword()
          Returns the Configuration Keyword parameter of this tool .
 Object getInAddressLocatorStyle()
          Returns the Address Locator Style parameter of this tool .
 Object getInFieldMap()
          Returns the Field Map parameter of this tool .
 Object getInReferenceData()
          Returns the Reference Data parameter of this tool .
 Object getOutAddressLocator()
          Returns the Output Address Locator 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 setConfigKeyword(String configKeyword)
          Sets the Configuration Keyword parameter of this tool .
 void setInAddressLocatorStyle(Object inAddressLocatorStyle)
          Sets the Address Locator Style parameter of this tool .
 void setInFieldMap(Object inFieldMap)
          Sets the Field Map parameter of this tool .
 void setInReferenceData(Object inReferenceData)
          Sets the Reference Data parameter of this tool .
 void setOutAddressLocator(Object outAddressLocator)
          Sets the Output 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

CreateAddressLocator

public CreateAddressLocator()
Creates the Create Address Locator tool with defaults.

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


CreateAddressLocator

public CreateAddressLocator(Object inAddressLocatorStyle,
                            Object inReferenceData,
                            Object inFieldMap,
                            Object outAddressLocator)
Creates the Create 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:
inAddressLocatorStyle - Address Locator Style, the address locator style on which to base the new address locator. When you specify an ArcSDE address locator style, the output address locator must be stored in the same ArcSDE database. You must also fully qualify an ArcSDE locator style with its workspace, as shown in the example below.
inReferenceData - (Table View String; Table View String;...), custom locator styles or locator styles provided by third parties may define a different set of roles for reference datasets.
inFieldMap - 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.
outAddressLocator - Address Locator, the address locator to create. If you choose an ArcSDE address locator style, you must store the locator in the same ArcSDE database. You must also fully qualify the output address locator with its workspace, as shown in the example below.
Method Detail

getInAddressLocatorStyle

public Object getInAddressLocatorStyle()
Returns the Address Locator Style parameter of this tool . This parameter is Address Locator Style, the address locator style on which to base the new address locator. When you specify an ArcSDE address locator style, the output address locator must be stored in the same ArcSDE database. You must also fully qualify an ArcSDE locator style with its workspace, as shown in the example below. 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 Address Locator Style, the address locator style on which to base the new address locator. When you specify an ArcSDE address locator style, the output address locator must be stored in the same ArcSDE database. You must also fully qualify an ArcSDE locator style with its workspace, as shown in the example below. This is a required parameter.

Parameters:
inAddressLocatorStyle - Address Locator Style, the address locator style on which to base the new address locator. When you specify an ArcSDE address locator style, the output address locator must be stored in the same ArcSDE database. You must also fully qualify an ArcSDE locator style with its workspace, as shown in the example below.

getInReferenceData

public Object getInReferenceData()
Returns the Reference Data parameter of this tool . This parameter is (Table View String; Table View String;...), custom locator styles or locator styles provided by third parties may define a different set of roles for reference datasets. This is a required parameter.

Returns:
the Reference Data

setInReferenceData

public void setInReferenceData(Object inReferenceData)
Sets the Reference Data parameter of this tool . This parameter is (Table View String; Table View String;...), custom locator styles or locator styles provided by third parties may define a different set of roles for reference datasets. This is a required parameter.

Parameters:
inReferenceData - (Table View String; Table View String;...), custom locator styles or locator styles provided by third parties may define a different set of roles for reference datasets.

getInFieldMap

public Object getInFieldMap()
Returns the Field Map 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 Field Map

setInFieldMap

public void setInFieldMap(Object inFieldMap)
Sets the Field Map 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:
inFieldMap - 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.

getOutAddressLocator

public Object getOutAddressLocator()
Returns the Output Address Locator parameter of this tool . This parameter is Address Locator, the address locator to create. If you choose an ArcSDE address locator style, you must store the locator in the same ArcSDE database. You must also fully qualify the output address locator with its workspace, as shown in the example below. This is a required parameter.

Returns:
the Output Address Locator

setOutAddressLocator

public void setOutAddressLocator(Object outAddressLocator)
Sets the Output Address Locator parameter of this tool . This parameter is Address Locator, the address locator to create. If you choose an ArcSDE address locator style, you must store the locator in the same ArcSDE database. You must also fully qualify the output address locator with its workspace, as shown in the example below. This is a required parameter.

Parameters:
outAddressLocator - Address Locator, the address locator to create. If you choose an ArcSDE address locator style, you must store the locator in the same ArcSDE database. You must also fully qualify the output address locator with its workspace, as shown in the example below.

getConfigKeyword

public String getConfigKeyword()
Returns the Configuration Keyword parameter of this tool . This parameter is String, the configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS) - ArcSDE only. This is an optional parameter.

Returns:
the Configuration Keyword

setConfigKeyword

public void setConfigKeyword(String configKeyword)
Sets the Configuration Keyword parameter of this tool . This parameter is String, the configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS) - ArcSDE only. This is an optional parameter.

Parameters:
configKeyword - String, the configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS) - ArcSDE only.

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