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

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

All Implemented Interfaces:

GPTool

public class CreateCompositeAddressLocator
extends AbstractGPTool

Creates a composite address locator. A composite address locator consists of two or more individual address locators that allow addresses to be matched against the multiple address locators. The Create Composite Address Locator tool is contained in the Geocoding Tools tool box.

Usage tips:

• Prior to creating composite address locators, use the tool to create participating address locators.
• Spatial reference for a composite address locator is required. The spatial reference of the first participating address locator is used unless you specify a different in the tool's .

Field Summary

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

vals

Constructor Summary

CreateCompositeAddressLocator()
Creates the Create Composite Address Locator tool with defaults.

CreateCompositeAddressLocator(java.lang.Object inAddressLocators, java.lang.Object inFieldMap, java.lang.Object outCompositeAddressLocator)
Creates the Create Composite Address Locator tool with the required parameters.

Method Summary

java.lang.Object	getInAddressLocators() Returns the Address Locators parameter of this tool .
java.lang.Object	getInFieldMap() Returns the Field Map parameter of this tool .
java.lang.Object	getInSelectionCriteria() Returns the Selection Criteria parameter of this tool .
java.lang.Object	getOutCompositeAddressLocator() Returns the Output Composite 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	setInAddressLocators(java.lang.Object inAddressLocators) Sets the Address Locators parameter of this tool .
void	setInFieldMap(java.lang.Object inFieldMap) Sets the Field Map parameter of this tool .
void	setInSelectionCriteria(java.lang.Object inSelectionCriteria) Sets the Selection Criteria parameter of this tool .
void	setOutCompositeAddressLocator(java.lang.Object outCompositeAddressLocator) Sets the Output Composite 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

CreateCompositeAddressLocator

public CreateCompositeAddressLocator()

Creates the Create Composite Address Locator tool with defaults.

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

CreateCompositeAddressLocator

public CreateCompositeAddressLocator(java.lang.Object inAddressLocators,
                                     java.lang.Object inFieldMap,
                                     java.lang.Object outCompositeAddressLocator)

Creates the Create Composite 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:

inAddressLocators - the order of the participating address locators determines how candidates are searched and an address is matched. When you geocode a single address, the address will be matched against all participating address locators unless the locator is specified with a selection criterion. All the found candidates will be displayed based on the order of the listed participating address locators. If you geocode a table of addresses, addresses are matched automatically to the first best candidate found from the first participating address locators. If the address fails to match, it will fall back to the subsequent locator in the list. a reference name for each participating address locator is required. This is the name of the address locator referred to by the composite address locator. The name should contain no space or special symbols. The maximum length of the name is 14 characters.

inFieldMap - the mapping of input fields used by each participating address locator to the input fields of the composite address locator.

outCompositeAddressLocator - the composite address locator to create.

Method Detail

getInAddressLocators

public java.lang.Object getInAddressLocators()

Returns the Address Locators parameter of this tool . This parameter is the order of the participating address locators determines how candidates are searched and an address is matched. When you geocode a single address, the address will be matched against all participating address locators unless the locator is specified with a selection criterion. All the found candidates will be displayed based on the order of the listed participating address locators. If you geocode a table of addresses, addresses are matched automatically to the first best candidate found from the first participating address locators. If the address fails to match, it will fall back to the subsequent locator in the list. a reference name for each participating address locator is required. This is the name of the address locator referred to by the composite address locator. The name should contain no space or special symbols. The maximum length of the name is 14 characters. This is a required parameter.

Returns:

the Address Locators

setInAddressLocators

public void setInAddressLocators(java.lang.Object inAddressLocators)

Sets the Address Locators parameter of this tool . This parameter is the order of the participating address locators determines how candidates are searched and an address is matched. When you geocode a single address, the address will be matched against all participating address locators unless the locator is specified with a selection criterion. All the found candidates will be displayed based on the order of the listed participating address locators. If you geocode a table of addresses, addresses are matched automatically to the first best candidate found from the first participating address locators. If the address fails to match, it will fall back to the subsequent locator in the list. a reference name for each participating address locator is required. This is the name of the address locator referred to by the composite address locator. The name should contain no space or special symbols. The maximum length of the name is 14 characters. This is a required parameter.

Parameters:

inAddressLocators - the order of the participating address locators determines how candidates are searched and an address is matched. When you geocode a single address, the address will be matched against all participating address locators unless the locator is specified with a selection criterion. All the found candidates will be displayed based on the order of the listed participating address locators. If you geocode a table of addresses, addresses are matched automatically to the first best candidate found from the first participating address locators. If the address fails to match, it will fall back to the subsequent locator in the list. a reference name for each participating address locator is required. This is the name of the address locator referred to by the composite address locator. The name should contain no space or special symbols. The maximum length of the name is 14 characters.

getInFieldMap

public java.lang.Object getInFieldMap()

Returns the Field Map parameter of this tool . This parameter is the mapping of input fields used by each participating address locator to the input fields of the composite address locator. 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 input fields used by each participating address locator to the input fields of the composite address locator. This is a required parameter.

Parameters:

inFieldMap - the mapping of input fields used by each participating address locator to the input fields of the composite address locator.

getInSelectionCriteria

public java.lang.Object getInSelectionCriteria()

Returns the Selection Criteria parameter of this tool . This parameter is selection criteria for each participating address locator. Only one selection criterion is supported for each participating address locator. using selection criteria will disqualify participating address locators that do not meet the criteria on a particular address so that the geocoding process will be more efficient. Refer to the topic Creating a composite address locator to learn more about the use of selection criteria in the geocoding process. This is an optional parameter.

Returns:

the Selection Criteria

setInSelectionCriteria

public void setInSelectionCriteria(java.lang.Object inSelectionCriteria)

Sets the Selection Criteria parameter of this tool . This parameter is selection criteria for each participating address locator. Only one selection criterion is supported for each participating address locator. using selection criteria will disqualify participating address locators that do not meet the criteria on a particular address so that the geocoding process will be more efficient. Refer to the topic Creating a composite address locator to learn more about the use of selection criteria in the geocoding process. This is an optional parameter.

Parameters:

inSelectionCriteria - selection criteria for each participating address locator. Only one selection criterion is supported for each participating address locator. using selection criteria will disqualify participating address locators that do not meet the criteria on a particular address so that the geocoding process will be more efficient. Refer to the topic Creating a composite address locator to learn more about the use of selection criteria in the geocoding process.

getOutCompositeAddressLocator

public java.lang.Object getOutCompositeAddressLocator()

Returns the Output Composite Address Locator parameter of this tool . This parameter is the composite address locator to create. This is a required parameter.

Returns:

the Output Composite Address Locator

setOutCompositeAddressLocator

public void setOutCompositeAddressLocator(java.lang.Object outCompositeAddressLocator)

Sets the Output Composite Address Locator parameter of this tool . This parameter is the composite address locator to create. This is a required parameter.

Parameters:

outCompositeAddressLocator - the composite address locator to create.

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