com.esri.arcgis.geodatabase
Interface ILocatorWorkspace

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ILocatorWorkspace2

All Known Implementing Classes:

AGSLocatorWorkspace, DatabaseLocatorWorkspace, ILocatorWorkspace2Proxy, ILocatorWorkspaceProxy, LocalLocatorWorkspace

public interface ILocatorWorkspace
extends java.io.Serializable

COM Interface 'ILocatorWorkspace'. Generated 3/19/2015 1:20:56 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members for managing the locators in the locator workspace.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDae5a3a08_f756_11d2_9f4f_00c04f8ed1c4
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IIDae5a3a08_f756_11d2_9f4f_00c04f8ed1c4

static final int IIDae5a3a08_f756_11d2_9f4f_00c04f8ed1c4

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getName

ILocatorWorkspaceName getName()
                              throws java.io.IOException,
                                     AutomationException

The Name object for the locator workspace.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocatorNames

IEnumLocatorName getLocatorNames(int queryType,
                                 java.lang.String category)
                                 throws java.io.IOException,
                                        AutomationException

LocatorName objects in the locator workspace.

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:

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

AutomationException - If the ArcObject component throws an exception.

getLocators

IEnumLocator getLocators(int queryType,
                         java.lang.String category)
                         throws java.io.IOException,
                                AutomationException

Locators in the locator workspace.

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:

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

AutomationException - If the ArcObject component throws an exception.

getLocatorName

ILocatorName getLocatorName(java.lang.String name)
                            throws java.io.IOException,
                                   AutomationException

Gets a LocatorName object.

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocator

ILocator getLocator(java.lang.String name)
                    throws java.io.IOException,
                           AutomationException

Gets a locator.

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocatorStyle

ILocatorStyle getLocatorStyle(java.lang.String name)
                              throws java.io.IOException,
                                     AutomationException

Gets a locator style.

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLocator

ILocator addLocator(java.lang.String name,
                    ILocator locator,
                    java.lang.String configKeyword,
                    ITrackCancel cancelTracker)
                    throws java.io.IOException,
                           AutomationException

Adds a locator to the locator workspace.

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:

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

AutomationException - If the ArcObject component throws an exception.

addLocatorStyle

void addLocatorStyle(java.lang.String name,
                     java.lang.String category,
                     ILocatorStyle locatorStyle)
                     throws java.io.IOException,
                            AutomationException

Adds a locator style.

Parameters:

name - The name (in)

category - The category (in)

locatorStyle - A reference to a com.esri.arcgis.geodatabase.ILocatorStyle (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateLocator

void updateLocator(ILocator locator)
                   throws java.io.IOException,
                          AutomationException

Modifies the properties of a locator.

Parameters:

locator - A reference to a com.esri.arcgis.geodatabase.ILocator (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteLocator

void deleteLocator(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

Deletes a locator.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

renameLocator

void renameLocator(java.lang.String oldName,
                   java.lang.String newName)
                   throws java.io.IOException,
                          AutomationException

Renames a locator.

Parameters:

oldName - The oldName (in)

newName - The newName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copyLocator

void copyLocator(java.lang.String srcName,
                 java.lang.String dstName)
                 throws java.io.IOException,
                        AutomationException

Copies a locator.

Parameters:

srcName - The srcName (in)

dstName - The dstName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.