|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.location.LocatorManager
public class LocatorManager
A manager for locators and locator workspaces.
The LocatorManager object is an object for opening locator workspaces, and for retrieving AttachedLocators from datasets.
ILocatorWorkspace2
,
ILocatorManager2
,
AttachedLocator
,
IAttachedLocator
,
DatabaseLocatorWorkspace
,
ILocatorWorkspace
,
ILocatorManager.getLocatorWorkspaceFromPath(String)
,
LocatorEnumerator
,
ILocatorWorkspaceName2
,
LocatorWorkspaceName
,
IDatabaseLocatorWorkspace
,
LocalLocatorWorkspace
,
ILocatorManager
,
LocatorManager
,
ILocatorWorkspaceName
,
Serialized FormConstructor 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 |
---|
public LocatorManager() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic LocatorManager(Object obj) throws IOException
LocatorManager theLocatorManager = (LocatorManager) obj;
obj
to LocatorManager
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public ILocatorWorkspace getLocatorWorkspace(IWorkspace wks) throws IOException, AutomationException
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.
getLocatorWorkspace
in interface ILocatorManager
wks
- A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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)
public ILocatorWorkspace getLocatorWorkspaceFromPath(String path) throws IOException, AutomationException
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.
getLocatorWorkspaceFromPath
in interface ILocatorManager
path
- The path (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.ILocatorWorkspace2
,
ILocatorManager2
,
DatabaseLocatorWorkspace
,
ILocatorWorkspace
,
ILocatorManager.getLocatorWorkspaceFromPath(String)
,
LocatorEnumerator
,
ILocatorWorkspaceName2
,
LocatorWorkspaceName
,
IDatabaseLocatorWorkspace
,
LocalLocatorWorkspace
,
ILocatorManager
,
LocatorManager
,
ILocatorWorkspaceName
public boolean hasLocatorAttached(IDatasetName datasetName) throws IOException, AutomationException
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.
hasLocatorAttached
in interface ILocatorManager
datasetName
- A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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)
public IAttachedLocator getLocatorFromDataset(IDataset dataset) throws IOException, AutomationException
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.
getLocatorFromDataset
in interface ILocatorManager
dataset
- A reference to a com.esri.arcgis.geodatabase.IDataset (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.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)
public ILocatorWorkspace getAGSLocatorWorkspace(IAGSServerConnectionName serverConnection) throws IOException, AutomationException
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.
getAGSLocatorWorkspace
in interface ILocatorManager2
serverConnection
- A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnumServerObjectType
,
AGSLocatorWorkspace
,
IEnumServerObjectTypeInfo
,
GeocodeServer
,
ILocatorManager2.getAGSLocatorWorkspace(com.esri.arcgis.gisclient.IAGSServerConnectionName)
,
ServerObject
,
ILocatorWorkspaceName2.getAGSServerConnectionName()
,
AGSAddressLocator
public boolean canParse(String nameString) throws IOException, AutomationException
Indicates if the given string can be parsed by this parser. Use the CanParse method before using the Parse method.
canParse
in interface IParseNameString
nameString
- The nameString (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IName parse(String nameString) throws IOException, AutomationException
Returns a new Name object by parsing the given string. Use the CanParse method first to ensure the string can be parsed.
parse
in interface IParseNameString
nameString
- The nameString (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataElement getWorkspaceDataElement(IDEBrowseOptions browseOptions) throws IOException, AutomationException
getWorkspaceDataElement
in interface IWorkspaceDataElements
browseOptions
- A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IDataElement getDatasetDataElement(Object datasetSpec, IDEBrowseOptions browseOptions) throws IOException, AutomationException
getDatasetDataElement
in interface IWorkspaceDataElements
datasetSpec
- A reference to another Object (IUnknown) (in)browseOptions
- A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void interfaceSupportsErrorInfo(GUID riid) throws IOException, AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |