com.esri.arcgis.geodatabase
Interface ILocator

All Superinterfaces:

Serializable

All Known Subinterfaces:

ILocator2, ISdeLocator

All Known Implementing Classes:

AGSAddressLocator, CompositeLocator, ESRIFDOAddressLocator, ESRIFDOAddressLocatorStyle, ESRIGen2AddressLocator, ESRIGen2AddressLocatorStyle, GenericLocatorStyle, ILocator2Proxy, ILocatorProxy, ISdeLocatorProxy, RouteMeasureLocator, RSLocator, StreetMapAddressLocator, StreetMapAddressLocatorStyle

public interface ILocator
extends Serializable

Provides access to members that describe general locator properties.

Remarks

The ILocator interface is supported by all locators and locator styles supported by ArcGIS. Additional interfaces must be supported by a locator in order to be used as an address locator in ArcGIS.

When To Use

Use the ILocator interface to inspect the general properties of a locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator), ILocatorStyle, StreetMapAddressLocatorStyle, com.esri.arcgis.locationui.GxLocator, ESRIFDOAddressLocatorStyle, ILocatorWorkspace.getLocator(String), ILocator, ESRIFDOAddressLocator, StreetMapAddressLocator, com.esri.arcgis.locationui.LocatorExtension, com.esri.arcgis.locationui.IGxNewLocator, ILocatorWorkspace.getLocatorStyle(String), com.esri.arcgis.catalogUI.IGxLocator

Method Summary

String	getCategory() Category of the locator.
String	getDescription() Description of the locator.
String	getName() Name of the locator.
ILocatorUI	getUserInterface() User interface for the locator.
void	setDescription(String description) Description of the locator.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the locator.

Remarks

Locators and locator styles stored in an ArcSDE locator workspace are prefixed by the name of the ArcSDE user that owns the locator styles, as in "SDE.US Streets with Zone".

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description of the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String description)
                    throws IOException,
                           AutomationException

Description of the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

Category of the locator.

Remarks

The Category property returns a string indicating the category to which the locator belongs. There are two categories that are defined for locators provided with ArcGIS:

• Address - Locators that are used to geocode addresses
• RouteEvent - Locators that are used for linear referencing

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The category

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserInterface

ILocatorUI getUserInterface()
                            throws IOException,
                                   AutomationException

User interface for the locator.

Description

The UserInterface property returns an object that you can use to display the user interfaces for the locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.ILocatorUI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.