com.esri.arcgis.location
Interface ILocatorManager

All Superinterfaces:
Serializable
All Known Subinterfaces:
ILocatorManager2
All Known Implementing Classes:
LocatorManager

public interface ILocatorManager
extends Serializable

Provides access to members for manipulating located datasets and locator workspaces.

Superseded By

ILocatorManager2

When To Use

Use the ILocatorManager interface to open locator workspaces, and to retrieve AttachedLocators from datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ILocatorWorkspace2, ILocatorManager2, AttachedLocator, DatabaseLocatorWorkspace, IAttachedLocator, ILocatorWorkspace, ILocatorManager.getLocatorWorkspaceFromPath(String), LocatorEnumerator, ILocatorWorkspaceName2, LocatorWorkspaceName, IDatabaseLocatorWorkspace, LocalLocatorWorkspace, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager, LocatorManager, ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset), ILocatorWorkspaceName

Method Summary
 IAttachedLocator getLocatorFromDataset(IDataset dataset)
          Returns the locator attached to the dataset.
 ILocatorWorkspace getLocatorWorkspace(IWorkspace wks)
          Returns the locator workspace for a workspace.
 ILocatorWorkspace getLocatorWorkspaceFromPath(String path)
          Returns the locator workspace for a path.
 boolean hasLocatorAttached(IDatasetName datasetName)
          Indicates if a dataset has an attached locator.
 

Method Detail

getLocatorWorkspace

ILocatorWorkspace getLocatorWorkspace(IWorkspace wks)
                                      throws IOException,
                                             AutomationException
Returns the locator workspace for a workspace.

Remarks

The GetLocatorWorkspace method returns a reference to a locator workspace contained by the workspace represented by the wks parameter.

If the wks parameter is a reference to an ArcSDE workspace, then this method returns a reference to a DatabaseLocatorWorkspace. If the wks parameter is a reference to a file workspace, such as a shapefile or coverage workspace, then this method returns a reference to a LocalLocatorWorkspace that contains locators in the folder that contains the file workspace. If the wks parameter is a reference to a personal Geodatabase workspace, then this method returns a reference to a LocalLocatorWorkspace that contains locators in the folder that contains the personal Geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
wks - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocatorWorkspace
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
com.esri.arcgis.locationui.GxLocatorFolder, ISetDefaultConnectionInfo, IFDOToADOConnection.connect(com.esri.arcgis.geodatabase.IWorkspace, java.lang.Object), IWorkspaceName, ILocalLocatorWorkspace, IWorkspaceName2, IDataset, com.esri.arcgis.locationui.GxGeocodingServiceExtension, FdoAdoConnection, com.esri.arcgis.locationui.IGxLocatorFolder, com.esri.arcgis.locationui.GxLocatorFactory, IDatabaseConnectionInfo, Workspace, IRemoteDatabaseWorkspaceFactory, ILocalLocatorWorkspace.getPath(), ILocatorManager.getLocatorWorkspace(com.esri.arcgis.geodatabase.IWorkspace), IFDOToADOConnection.createADOConnection(com.esri.arcgis.geodatabase.IWorkspace)

getLocatorWorkspaceFromPath

ILocatorWorkspace getLocatorWorkspaceFromPath(String path)
                                              throws IOException,
                                                     AutomationException
Returns the locator workspace for a path.

Remarks

The GetLocatorWorkspaceFromPath method returns a LocalLocatorWorkspace for the given Path. To open the default local locator workspace (represented by the top-level Address Locators folder in ArcCatalog), specify an empty string for the Path parameter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
path - The path (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocatorWorkspace
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorWorkspace2, ILocatorManager2, DatabaseLocatorWorkspace, ILocatorWorkspace, ILocatorManager.getLocatorWorkspaceFromPath(String), LocatorEnumerator, ILocatorWorkspaceName2, LocatorWorkspaceName, IDatabaseLocatorWorkspace, LocalLocatorWorkspace, ILocatorManager, LocatorManager, ILocatorWorkspaceName

hasLocatorAttached

boolean hasLocatorAttached(IDatasetName datasetName)
                           throws IOException,
                                  AutomationException
Indicates if a dataset has an attached locator.

Remarks

The HasLocatorAttached method indicates if the dataset specified by the DatasetName parameter has an AttachedLocator. A dataset usually has an AttachedLocator if it was created using a locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
datasetName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
Returns:
The bHasLocatorAttached
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorManager2, AttachedLocator, IAttachedLocator, ILocatorAttach2, ILocatorManager, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset), ILocatorAttach2.attachLocator(com.esri.arcgis.geodatabase.ILocator, com.esri.arcgis.geodatabase.ITable, String, String)

getLocatorFromDataset

IAttachedLocator getLocatorFromDataset(IDataset dataset)
                                       throws IOException,
                                              AutomationException
Returns the locator attached to the dataset.

Remarks

The GetLocatorFromDataset method returns the AttachedLocator from the dataset specified by the Dataset parameter. Use the HasLocatorAttached method to determine if a dataset has an AttachedLocator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
dataset - A reference to a com.esri.arcgis.geodatabase.IDataset (in)
Returns:
A reference to a com.esri.arcgis.location.IAttachedLocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
ILocatorManager2, AttachedLocator, IAttachedLocator, ILocatorAttach2, ILocatorManager, ILocatorManager.hasLocatorAttached(com.esri.arcgis.geodatabase.IDatasetName), ILocatorManager.getLocatorFromDataset(com.esri.arcgis.geodatabase.IDataset), ILocatorAttach2.attachLocator(com.esri.arcgis.geodatabase.ILocator, com.esri.arcgis.geodatabase.ITable, String, String)