com.esri.arcgis.geodatabase
Interface ILocatorWorkspace

All Superinterfaces:
Serializable
All Known Subinterfaces:
ILocatorWorkspace2
All Known Implementing Classes:
AGSLocatorWorkspace, DatabaseLocatorWorkspace, ILocatorWorkspace2Proxy, ILocatorWorkspaceProxy, LocalLocatorWorkspace

public interface ILocatorWorkspace
extends Serializable

Provides access to members for managing the locators in the locator workspace.

Superseded By

ILocatorWorkspace2

Remarks

For some of the members of this interface, you must specify a Category string parameter. You can use categories to organize your locators and locator styles. All of the locators and locator styles provided with ArcGIS have a category of “Address”.

When To Use

Use the ILocatorWorkspace interface to manage the locators and locator styles in the locator workspace. You can use this interface to retrieve locators and locator styles from the locator workspace, as well as create, modify, and delete locators in the locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILocatorWorkspace2, ILocatorManager2, DatabaseLocatorWorkspace, ILocatorWorkspace, ILocatorManager.getLocatorWorkspaceFromPath(String), LocatorEnumerator, ILocatorWorkspaceName2, LocatorWorkspaceName, IDatabaseLocatorWorkspace, LocalLocatorWorkspace, ILocatorManager, LocatorManager, ILocatorWorkspaceName

Method Summary
 ILocator addLocator(String name, ILocator locator, String configKeyword, ITrackCancel cancelTracker)
          Adds a locator to the locator workspace.
 void addLocatorStyle(String name, String category, ILocatorStyle locatorStyle)
          Adds a locator style.
 void copyLocator(String srcName, String dstName)
          Copies a locator.
 void deleteLocator(String name)
          Deletes a locator.
 ILocator getLocator(String name)
          Gets a locator.
 ILocatorName getLocatorName(String name)
          Gets a LocatorName object.
 IEnumLocatorName getLocatorNames(int queryType, String category)
          LocatorName objects in the locator workspace.
 IEnumLocator getLocators(int queryType, String category)
          Locators in the locator workspace.
 ILocatorStyle getLocatorStyle(String name)
          Gets a locator style.
 ILocatorWorkspaceName getName()
          The Name object for the locator workspace.
 void renameLocator(String oldName, String newName)
          Renames a locator.
 void updateLocator(ILocator locator)
          Modifies the properties of a locator.
 

Method Detail

getName

ILocatorWorkspaceName getName()
                              throws IOException,
                                     AutomationException
The Name object for the locator workspace.

Description

The Name property returns a reference to a LocatorWorkspaceName object that represents the locator workspace.

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.ILocatorWorkspaceName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.getName()

getLocatorNames

IEnumLocatorName getLocatorNames(int queryType,
                                 String category)
                                 throws IOException,
                                        AutomationException
LocatorName objects in the locator workspace.

Product Availability

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

Parameters:
queryType - A com.esri.arcgis.geodatabase.esriLocatorQuery constant (in)
category - The category (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumLocatorName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocators

IEnumLocator getLocators(int queryType,
                         String category)
                         throws IOException,
                                AutomationException
Locators in the locator workspace.

Product Availability

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

Parameters:
queryType - A com.esri.arcgis.geodatabase.esriLocatorQuery constant (in)
category - The category (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumLocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocatorName

ILocatorName getLocatorName(String name)
                            throws IOException,
                                   AutomationException
Gets a LocatorName object.

Description

The GetLocatorName method retrieves a LocatorName object from a locator workspace.

Remarks

The Name parameter is the name of the locator that you want to retrieve from the locator workspace.

In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator". When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocatorName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorName, LocatorName, ILocatorWorkspace.getLocatorName(String)

getLocator

ILocator getLocator(String name)
                    throws IOException,
                           AutomationException
Gets a locator.

Description

The GetLocator method retrieves a locator from a locator workspace.

Remarks

The Name parameter is the name of the locator that you want to retrieve from the locator workspace.

Within the default local locator workspace, and within ArcSDE locator workspaces, locator names are prefixed by a user name, as in "jack.My Locator". In local locator workspaces, the locator name is prefixed by the user name of the current user. In ArcSDE workspaces, the locator name is prefixed by the name of the ArcSDE user that owns the locator. When you call methods in ArcObjects that have parameters that specify locators in a locator workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator), StreetMapAddressLocatorStyle, com.esri.arcgis.locationui.GxLocator, ESRIFDOAddressLocatorStyle, ILocatorWorkspace.getLocator(String), ILocator, ESRIFDOAddressLocator, StreetMapAddressLocator, com.esri.arcgis.locationui.LocatorExtension, com.esri.arcgis.catalogUI.IGxLocator

getLocatorStyle

ILocatorStyle getLocatorStyle(String name)
                              throws IOException,
                                     AutomationException
Gets a locator style.

Description

The GetLocatorStyle method retrieves a locator style from a locator workspace.

Remarks

The Name parameter is the name of the locator style that you want to retrieve from the locator workspace.

Within ArcSDE locator workspaces, locator style names are prefixed by the name of the SDE user that owns the locator style (usually the default SDE user), as in "SDE.US Streets with Zone". You must specify the SDE user as a part of the Name parameter when calling the GetLocatorStyle method on an ArcSDE locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocatorStyle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorStyle, StreetMapAddressLocatorStyle, ESRIFDOAddressLocatorStyle, com.esri.arcgis.locationui.IGxNewLocator, ILocatorWorkspace.getLocatorStyle(String)

addLocator

ILocator addLocator(String name,
                    ILocator locator,
                    String configKeyword,
                    ITrackCancel cancelTracker)
                    throws IOException,
                           AutomationException
Adds a locator to the locator workspace.

Description

The AddLocator method adds the specified locator to the locator workspace with the specified name.

Remarks

In general, when creating a locator, you will first retrieve a locator style from the locator workspace, set the properties on the locator style, then use the AddLocator method to create a new locator.

The Name parameter specifies the name for the new locator.

The Locator parameter is a reference to the locator that you want to add to the locator workspace.

The ConfigKeyword parameter is used to specify the ArcSDE storage keyword used to create the reference data indexes for the new locator. This parameter is only used if the locator workspace is in an ArcSDE database. Using a configuration keyword specifies certain parameters for storing tables to the ArcSDE database, and the proper configuration can improve the performance of your locators. For more information on ArcSDE configuration keywords, refer to the ArcSDE Configuration and Tuning Guide for your relational database management system (RDBMS). To use the default storage keyword for the ArcSDE database, specify a blank string for this parameter.

ICancelTracker is an optional parameter that you can use to specify a CancelTracker object that is used to display the reference data index building progress and allows the user to cancel the process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
locator - A reference to a com.esri.arcgis.geodatabase.ILocator (in)
configKeyword - The configKeyword (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.addLocator(String, com.esri.arcgis.geodatabase.ILocator, String, com.esri.arcgis.system.ITrackCancel), ILocatorWorkspace.deleteLocator(String), ILocatorWorkspace.copyLocator(String, String)

addLocatorStyle

void addLocatorStyle(String name,
                     String category,
                     ILocatorStyle locatorStyle)
                     throws IOException,
                            AutomationException
Adds a locator style.

Description

The AddLocatorStyle method adds the specified locator style to the locator workspace.

Remarks

In general, you will only use this method if you have created your own custom locator style and want to copy it from one locator workspace to another.

The Name parameter specifies the name for the new locator style.

The Category parameter is used to specify the category of the new locator style. Address locator styles provided with ArcGIS all have a category of "Address".

The LocatorStyle parameter is a reference to the locator style to add to the locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
category - The category (in)
locatorStyle - A reference to a com.esri.arcgis.geodatabase.ILocatorStyle (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.addLocatorStyle(String, String, com.esri.arcgis.geodatabase.ILocatorStyle)

updateLocator

void updateLocator(ILocator locator)
                   throws IOException,
                          AutomationException
Modifies the properties of a locator.

Remarks

To update a locator or locator style, first get the locator or locator style from the locator workspace using one of the members of the ILocatorWorkspace interface. Modify the properties of the locator or locator style, then update the locator or locator style using this method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
locator - A reference to a com.esri.arcgis.geodatabase.ILocator (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator), StreetMapAddressLocatorStyle, com.esri.arcgis.locationui.GxLocator, ESRIFDOAddressLocatorStyle, ILocatorWorkspace.getLocator(String), ILocator, ESRIFDOAddressLocator, StreetMapAddressLocator, com.esri.arcgis.locationui.LocatorExtension, com.esri.arcgis.catalogUI.IGxLocator

deleteLocator

void deleteLocator(String name)
                   throws IOException,
                          AutomationException
Deletes a locator.

Description

The DeleteLocator method deletes a locator or locator style from a locator workspace.

Remarks

The Name parameter is the name of the locator or locator style that you want to remove from the locator workspace.

In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator". When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.addLocator(String, com.esri.arcgis.geodatabase.ILocator, String, com.esri.arcgis.system.ITrackCancel), ILocatorWorkspace.deleteLocator(String), ILocatorWorkspace.copyLocator(String, String)

renameLocator

void renameLocator(String oldName,
                   String newName)
                   throws IOException,
                          AutomationException
Renames a locator.

Remarks

The oldName parameter is the current name of the locator or locator style that you want to rename. The newName parameter is the new name for the locator or locator style.

In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator". When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error. You must fully-qualify the oldName parameter with a user name. Do not qualify the newName parameter with a user name; the locator workspace will add the user name automatically.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
oldName - The oldName (in)
newName - The newName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.updateLocator(com.esri.arcgis.geodatabase.ILocator), ILocatorStyle, com.esri.arcgis.locationui.GxLocatorFolder, StreetMapAddressLocatorStyle, com.esri.arcgis.locationui.GxLocator, ESRIFDOAddressLocatorStyle, ILocatorWorkspace.getLocator(String), ILocator, ESRIFDOAddressLocator, ILocalLocatorWorkspace, StreetMapAddressLocator, com.esri.arcgis.locationui.GxGeocodingServiceExtension, com.esri.arcgis.locationui.LocatorExtension, com.esri.arcgis.locationui.IGxLocatorFolder, com.esri.arcgis.locationui.GxLocatorFactory, com.esri.arcgis.locationui.IGxNewLocator, ILocalLocatorWorkspace.getPath(), ILocatorManager.getLocatorWorkspace(com.esri.arcgis.geodatabase.IWorkspace), ILocatorWorkspace.getLocatorStyle(String), com.esri.arcgis.catalogUI.IGxLocator

copyLocator

void copyLocator(String srcName,
                 String dstName)
                 throws IOException,
                        AutomationException
Copies a locator.

Description

The CopyLocator method creates a copy of the specified locator in the same locator workspace.

Remarks

The srcName parameter is the name of the locator that you want to copy. The dstName parameter is the name for the copy of the locator.

In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator". When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
srcName - The srcName (in)
dstName - The dstName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace.addLocator(String, com.esri.arcgis.geodatabase.ILocator, String, com.esri.arcgis.system.ITrackCancel), ILocatorWorkspace.deleteLocator(String), ILocatorWorkspace.copyLocator(String, String)