com.esri.arcgis.geoprocessing.tools.geocodingtools
Class CreateAddressLocator
java.lang.Object
com.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.geocodingtools.CreateAddressLocator
- All Implemented Interfaces:
- GPTool
public class CreateAddressLocator
- extends AbstractGPTool
Creates an address locator. The address locator can be used to find a location of an address, geocode a table of addresses, or get the address of a point location.
The Create Address Locator tool is contained in the Geocoding Tools tool box.
Usage tips:
- Address locators can be created in the same workspace as the reference data or other workspace in a geodatabase or file folder you specify.
- The role of a reference dataset defines the role that it plays as reference data for the address locator. The address locator styles provided with ArcGIS use the following values to describe the roles of reference datasets:
- Custom locator styles or locator styles provided by third parties may define different roles for reference data feature classes and tables. Refer to their documentation for information on the roles that they define for reference datasets.
- Composite address locators cannot be created using this tool. Use the tool to create a composite addres locator.
Constructor Summary |
CreateAddressLocator()
Creates the Create Address Locator tool with defaults. |
CreateAddressLocator(java.lang.Object inAddressLocatorStyle,
java.lang.Object inReferenceData,
java.lang.Object inFieldMap,
java.lang.Object outAddressLocator)
Creates the Create Address Locator tool with the required parameters. |
Method Summary |
java.lang.String |
getConfigKeyword()
Returns the Configuration Keyword parameter of this tool . |
java.lang.Object |
getInAddressLocatorStyle()
Returns the Address Locator Style parameter of this tool . |
java.lang.Object |
getInFieldMap()
Returns the Field Map parameter of this tool . |
java.lang.Object |
getInReferenceData()
Returns the Reference Data parameter of this tool . |
java.lang.Object |
getOutAddressLocator()
Returns the Output Address Locator 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 |
setConfigKeyword(java.lang.String configKeyword)
Sets the Configuration Keyword parameter of this tool . |
void |
setInAddressLocatorStyle(java.lang.Object inAddressLocatorStyle)
Sets the Address Locator Style parameter of this tool . |
void |
setInFieldMap(java.lang.Object inFieldMap)
Sets the Field Map parameter of this tool . |
void |
setInReferenceData(java.lang.Object inReferenceData)
Sets the Reference Data parameter of this tool . |
void |
setOutAddressLocator(java.lang.Object outAddressLocator)
Sets the Output Address Locator parameter of this tool . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
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(java.lang.Object inAddressLocatorStyle,
java.lang.Object inReferenceData,
java.lang.Object inFieldMap,
java.lang.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
- the address locator style on which to base the new address locator.inReferenceData
- the reference data feature classes and tables to be used by the address locator, along with their roles. custom locator styles or locator styles provided by third parties may define a different set of roles for reference datasets.inFieldMap
- the mapping of reference data fields used by the address locator style to fields in the reference datasets. Each field mapping in this parameter is in the format: where is the alias name for the reference data field used by the address locator, and is the name of the field in the reference dataset. Fields with an asterisk ("*") next to their names are required by the address locator style. vISIBLE—Field is visible; NONE—the geometry is a copy of the original value. if you choose not to map an optional reference data field used by the address locator style to a field in a reference dataset, 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 control is the field's alias name.outAddressLocator
- the address locator to create.
getInAddressLocatorStyle
public java.lang.Object getInAddressLocatorStyle()
- Returns the Address Locator Style parameter of this tool .
This parameter is the address locator style on which to base the new address locator.
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 the address locator style on which to base the new address locator.
This is a required parameter.
- Parameters:
inAddressLocatorStyle
- the address locator style on which to base the new address locator.
getInReferenceData
public java.lang.Object getInReferenceData()
- Returns the Reference Data parameter of this tool .
This parameter is the reference data feature classes and tables to be used by the address locator, along with their roles. 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(java.lang.Object inReferenceData)
- Sets the Reference Data parameter of this tool .
This parameter is the reference data feature classes and tables to be used by the address locator, along with their roles. 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
- the reference data feature classes and tables to be used by the address locator, along with their roles. custom locator styles or locator styles provided by third parties may define a different set of roles for reference datasets.
getInFieldMap
public java.lang.Object getInFieldMap()
- Returns the Field Map parameter of this tool .
This parameter is the mapping of reference data fields used by the address locator style to fields in the reference datasets. Each field mapping in this parameter is in the format: where is the alias name for the reference data field used by the address locator, and is the name of the field in the reference dataset. Fields with an asterisk ("*") next to their names are required by the address locator style. vISIBLE—Field is visible; NONE—the geometry is a copy of the original value. if you choose not to map an optional reference data field used by the address locator style to a field in a reference dataset, 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 control is the field's alias name.
This is a required parameter.
- Returns:
- the Field Map
setInFieldMap
public void setInFieldMap(java.lang.Object inFieldMap)
- Sets the Field Map parameter of this tool .
This parameter is the mapping of reference data fields used by the address locator style to fields in the reference datasets. Each field mapping in this parameter is in the format: where is the alias name for the reference data field used by the address locator, and is the name of the field in the reference dataset. Fields with an asterisk ("*") next to their names are required by the address locator style. vISIBLE—Field is visible; NONE—the geometry is a copy of the original value. if you choose not to map an optional reference data field used by the address locator style to a field in a reference dataset, 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 control is the field's alias name.
This is a required parameter.
- Parameters:
inFieldMap
- the mapping of reference data fields used by the address locator style to fields in the reference datasets. Each field mapping in this parameter is in the format: where is the alias name for the reference data field used by the address locator, and is the name of the field in the reference dataset. Fields with an asterisk ("*") next to their names are required by the address locator style. vISIBLE—Field is visible; NONE—the geometry is a copy of the original value. if you choose not to map an optional reference data field used by the address locator style to a field in a reference dataset, 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 control is the field's alias name.
getOutAddressLocator
public java.lang.Object getOutAddressLocator()
- Returns the Output Address Locator parameter of this tool .
This parameter is the address locator to create.
This is a required parameter.
- Returns:
- the Output Address Locator
setOutAddressLocator
public void setOutAddressLocator(java.lang.Object outAddressLocator)
- Sets the Output Address Locator parameter of this tool .
This parameter is the address locator to create.
This is a required parameter.
- Parameters:
outAddressLocator
- the address locator to create.
getConfigKeyword
public java.lang.String getConfigKeyword()
- Returns the Configuration Keyword parameter of this tool .
This parameter is the configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS)—ArcSDE and file geodatabases only.
This is an optional parameter.
- Returns:
- the Configuration Keyword
setConfigKeyword
public void setConfigKeyword(java.lang.String configKeyword)
- Sets the Configuration Keyword parameter of this tool .
This parameter is the configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS)—ArcSDE and file geodatabases only.
This is an optional parameter.
- Parameters:
configKeyword
- the configuration keyword that determines the storage parameters of the table in a Relational Database Management System (RDBMS)—ArcSDE and file geodatabases only.
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