com.esri.arcgis.location
Class LocatorManager

java.lang.Object
  com.esri.arcgis.location.LocatorManager

All Implemented Interfaces:

IWorkspaceDataElements, com.esri.arcgis.interop.RemoteObjRef, ILocatorManager, ILocatorManager2, IParseNameString, ISupportErrorInfo, Serializable

public class LocatorManager
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILocatorManager, ILocatorManager2, IParseNameString, IWorkspaceDataElements, ISupportErrorInfo

A manager for locators and locator workspaces.

Description

The LocatorManager object is an object for opening locator workspaces, and for retrieving AttachedLocators from datasets.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Singleton:

This type is a singleton.

See Also:

ILocatorWorkspace2, ILocatorManager2, AttachedLocator, IAttachedLocator, DatabaseLocatorWorkspace, ILocatorWorkspace, ILocatorManager.getLocatorWorkspaceFromPath(String), LocatorEnumerator, ILocatorWorkspaceName2, LocatorWorkspaceName, IDatabaseLocatorWorkspace, LocalLocatorWorkspace, ILocatorManager, LocatorManager, ILocatorWorkspaceName, Serialized Form

Constructor Summary

LocatorManager()
Constructs a LocatorManager using ArcGIS Engine.

LocatorManager(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LocatorManager theLocatorManager = (LocatorManager) obj;

Method Summary

boolean	canParse(String nameString) Indicates if the given name string can be parsed by this parser.
boolean	equals(Object o) Compare this object with another
ILocatorWorkspace	getAGSLocatorWorkspace(IAGSServerConnectionName serverConnection) Returns the locator workspace for an ArcGIS server connection.
static String	getClsid() getClsid.
IDataElement	getDatasetDataElement(Object datasetSpec, IDEBrowseOptions browseOptions) Returns the data element for the in-bound dataset name or dataset object.
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.
IDataElement	getWorkspaceDataElement(IDEBrowseOptions browseOptions) The data element for the workspace.
int	hashCode() the hashcode for this object
boolean	hasLocatorAttached(IDatasetName datasetName) Indicates if a dataset has an attached locator.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
IName	parse(String nameString) Parses the name string and returns a new Name object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

LocatorManager

public LocatorManager()
               throws IOException,
                      UnknownHostException

Constructs a LocatorManager using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LocatorManager

public LocatorManager(Object obj)
               throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LocatorManager theLocatorManager = (LocatorManager) obj;

Construct a LocatorManager using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to LocatorManager.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getLocatorWorkspace

public 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

Specified by:

getLocatorWorkspace in interface ILocatorManager

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

public 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

Specified by:

getLocatorWorkspaceFromPath in interface ILocatorManager

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

public 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

Specified by:

hasLocatorAttached in interface ILocatorManager

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

public 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

Specified by:

getLocatorFromDataset in interface ILocatorManager

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)

getAGSLocatorWorkspace

public ILocatorWorkspace getAGSLocatorWorkspace(IAGSServerConnectionName serverConnection)
                                         throws IOException,
                                                AutomationException

Returns the locator workspace for an ArcGIS server connection.

Remarks

An ArcGIS Server can serve GeocodeServers which can be used by ArcGIS like any other locator. Use this method to return a reference to an AGSLocatorWorkspace that contains locators that represent the GeocodeServers served by the ArcGIS Server. The serverConnection parameter is a reference to an AGSServerConnectionName object that represents the ArcGIS Server connection.

Product Availability

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

Specified by:

getAGSLocatorWorkspace in interface ILocatorManager2

Parameters:

serverConnection - A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName (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:

IEnumServerObjectType, AGSLocatorWorkspace, IEnumServerObjectTypeInfo, GeocodeServer, ILocatorManager2.getAGSLocatorWorkspace(com.esri.arcgis.gisclient.IAGSServerConnectionName), ServerObject, ILocatorWorkspaceName2.getAGSServerConnectionName(), AGSAddressLocator

canParse

public boolean canParse(String nameString)
                 throws IOException,
                        AutomationException

Indicates if the given name string can be parsed by this parser.

Description

Indicates if the given string can be parsed by this parser. Use the CanParse method before using the Parse method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canParse in interface IParseNameString

Parameters:

nameString - The nameString (in)

Returns:

The canParse

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

parse

public IName parse(String nameString)
            throws IOException,
                   AutomationException

Parses the name string and returns a new Name object.

Description

Returns a new Name object by parsing the given string. Use the CanParse method first to ensure the string can be parsed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

parse in interface IParseNameString

Parameters:

nameString - The nameString (in)

Returns:

A reference to a com.esri.arcgis.system.IName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceDataElement

public IDataElement getWorkspaceDataElement(IDEBrowseOptions browseOptions)
                                     throws IOException,
                                            AutomationException

The data element for the workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceDataElement in interface IWorkspaceDataElements

Parameters:

browseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetDataElement

public IDataElement getDatasetDataElement(Object datasetSpec,
                                          IDEBrowseOptions browseOptions)
                                   throws IOException,
                                          AutomationException

Returns the data element for the in-bound dataset name or dataset object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDatasetDataElement in interface IWorkspaceDataElements

Parameters:

datasetSpec - A reference to another Object (IUnknown) (in)

browseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.