|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.geocodingtools.CreateCompositeAddressLocator
public class CreateCompositeAddressLocator
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.
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(Object inAddressLocators,
Object inFieldMap,
Object outCompositeAddressLocator)
Creates the Create Composite Address Locator tool with the required parameters. |
Method Summary | |
---|---|
Object |
getInAddressLocators()
Returns the Address Locators parameter of this tool . |
Object |
getInFieldMap()
Returns the Field Map parameter of this tool . |
Object |
getInSelectionCriteria()
Returns the Selection Criteria parameter of this tool . |
Object |
getOutCompositeAddressLocator()
Returns the Output Composite 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 |
setInAddressLocators(Object inAddressLocators)
Sets the Address Locators parameter of this tool . |
void |
setInFieldMap(Object inFieldMap)
Sets the Field Map parameter of this tool . |
void |
setInSelectionCriteria(Object inSelectionCriteria)
Sets the Selection Criteria parameter of this tool . |
void |
setOutCompositeAddressLocator(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 |
---|
public CreateCompositeAddressLocator()
Initializes the array of tool parameters with the default values specified when the tool was created.
public CreateCompositeAddressLocator(Object inAddressLocators, Object inFieldMap, Object outCompositeAddressLocator)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other 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 |
---|
public Object getInAddressLocators()
public void setInAddressLocators(Object inAddressLocators)
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.public Object getInFieldMap()
public void setInFieldMap(Object inFieldMap)
inFieldMap
- the mapping of input fields used by each participating address locator to the input fields of the composite address locator.public Object getInSelectionCriteria()
public void setInSelectionCriteria(Object inSelectionCriteria)
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.public Object getOutCompositeAddressLocator()
public void setOutCompositeAddressLocator(Object outCompositeAddressLocator)
outCompositeAddressLocator
- the composite address locator to create.public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |