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, java.io.Serializable

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

COM Class 'LocatorManager'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description 'A manager for locators and locator workspaces.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.location.ILocatorManager2

IID, IID08fc0263_7a3f_4f34_9fea_975b9b5e16c8, xxDummy

Fields inherited from interface com.esri.arcgis.location.ILocatorManager

IIDe0f10b76_eb7c_11d2_9f47_00c04f8ed1c4

Fields inherited from interface com.esri.arcgis.system.IParseNameString

IID, IIDdb1eccbf_c6c6_11d2_9f24_00c04f6bc69e, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceDataElements

IID, IID94dde7ce_aa25_4682_8290_f7ddffee5d98, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

LocatorManager()
Constructs a LocatorManager using ArcGIS Engine.

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

Method Summary

boolean	canParse(java.lang.String nameString) Indicates if the given name string can be parsed by this parser.
boolean	equals(java.lang.Object o) Compare this object with another
ILocatorWorkspace	getAGSLocatorWorkspace(IAGSServerConnectionName serverConnection) Returns the locator workspace for an ArcGIS server connection.
static java.lang.String	getClsid() getClsid.
IDataElement	getDatasetDataElement(java.lang.Object datasetSpec, IDEBrowseOptions browseOptions) Returns the data element for the in-bound dataset name or dataset object.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IAttachedLocator	getLocatorFromDataset(IDataset dataset) Returns the locator attached to the dataset.
ILocatorWorkspace	getLocatorWorkspace(IWorkspace wks) Returns the locator workspace for a workspace.
ILocatorWorkspace	getLocatorWorkspaceFromPath(java.lang.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(java.lang.String nameString) Parses the name string and returns a new Name object.
void	release() Release a LocatorManager.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocatorManager

public LocatorManager()
               throws java.io.IOException,
                      java.net.UnknownHostException

Constructs a LocatorManager using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LocatorManager

public LocatorManager(java.lang.Object obj)
               throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a LocatorManager.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getLocatorWorkspace

public ILocatorWorkspace getLocatorWorkspace(IWorkspace wks)
                                      throws java.io.IOException,
                                             AutomationException

Returns the locator workspace for a workspace.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocatorWorkspaceFromPath

public ILocatorWorkspace getLocatorWorkspaceFromPath(java.lang.String path)
                                              throws java.io.IOException,
                                                     AutomationException

Returns the locator workspace for a path.

Specified by:

getLocatorWorkspaceFromPath in interface ILocatorManager

Parameters:

path - The path (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasLocatorAttached

public boolean hasLocatorAttached(IDatasetName datasetName)
                           throws java.io.IOException,
                                  AutomationException

Indicates if a dataset has an attached locator.

Specified by:

hasLocatorAttached in interface ILocatorManager

Parameters:

datasetName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

Returns:

The bHasLocatorAttached

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocatorFromDataset

public IAttachedLocator getLocatorFromDataset(IDataset dataset)
                                       throws java.io.IOException,
                                              AutomationException

Returns the locator attached to the dataset.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAGSLocatorWorkspace

public ILocatorWorkspace getAGSLocatorWorkspace(IAGSServerConnectionName serverConnection)
                                         throws java.io.IOException,
                                                AutomationException

Returns the locator workspace for an ArcGIS server connection.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canParse

public boolean canParse(java.lang.String nameString)
                 throws java.io.IOException,
                        AutomationException

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

Specified by:

canParse in interface IParseNameString

Parameters:

nameString - The nameString (in)

Returns:

The canParse

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

parse

public IName parse(java.lang.String nameString)
            throws java.io.IOException,
                   AutomationException

Parses the name string and returns a new Name object.

Specified by:

parse in interface IParseNameString

Parameters:

nameString - The nameString (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceDataElement

public IDataElement getWorkspaceDataElement(IDEBrowseOptions browseOptions)
                                     throws java.io.IOException,
                                            AutomationException

The data element for the workspace.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetDataElement

public IDataElement getDatasetDataElement(java.lang.Object datasetSpec,
                                          IDEBrowseOptions browseOptions)
                                   throws java.io.IOException,
                                          AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.