com.esri.arcgis.location
Class AGSLocatorWorkspace

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

All Implemented Interfaces:

ILocatorWorkspace, com.esri.arcgis.interop.RemoteObjRef, IAGSLocatorWorkspace, ILocatorAttach, ILocatorAttach2, ISupportErrorInfo, java.io.Serializable

public class AGSLocatorWorkspace
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILocatorWorkspace, IAGSLocatorWorkspace, ILocatorAttach, ILocatorAttach2, ISupportErrorInfo

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

Description 'A locator workspace that exposes geocoding services from an ArcGIS Server.' 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.geodatabase.ILocatorWorkspace

IID, IIDae5a3a08_f756_11d2_9f4f_00c04f8ed1c4, xxDummy

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

IID, IIDb7d1d9a0_8da7_45b8_b3ed_b07b8ffb5721, xxDummy

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

IID, IIDd12b2dca_775a_11d3_9f5e_00c04f6bdf06, xxDummy

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

IID, IID301bd67a_8042_4dcc_8375_d2697239e9a5, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

AGSLocatorWorkspace(java.lang.Object obj)
Construct a AGSLocatorWorkspace using a reference to such an object returned from ArcGIS Engine or Server.

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	attachLocator(ILocator locator, ITable attachToTable, ITable inputTable, java.lang.String inputFieldNames, java.lang.String inputJoinFieldName, ITable outputTable, java.lang.String outputFieldNames, java.lang.String outputJoinFieldName) Attaches a locator to a table.
void	attachLocator(ILocator locator, ITable attachToTable, java.lang.String inputFieldNames, java.lang.String outputFieldNames) Attaches a locator to a table (simple function).
void	copyLocator(java.lang.String srcName, java.lang.String dstName) Copies a locator.
void	deleteLocator(java.lang.String name) Deletes a locator.
boolean	equals(java.lang.Object o) Compare this object with another
IAGSServerConnectionName	getAGSServerConnection() The ArcGIS server connection that contains the locator workspace.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	release() Release a AGSLocatorWorkspace.
void	renameLocator(java.lang.String oldName, java.lang.String newName) Renames a locator.
void	updateLocator(ILocator locator) Modifies the properties of a locator.

Methods inherited from class java.lang.Object

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

Constructor Detail

AGSLocatorWorkspace

public AGSLocatorWorkspace(java.lang.Object obj)
                    throws java.io.IOException

Construct a AGSLocatorWorkspace using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AGSLocatorWorkspace.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
AGSLocatorWorkspace o = (AGSLocatorWorkspace)obj; // will not work

AGSLocatorWorkspace o = new AGSLocatorWorkspace(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems AGSLocatorWorkspace theAGSLocatorWorkspace = (AGSLocatorWorkspace) obj;

Method Detail

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 AGSLocatorWorkspace.

Specified by:

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

getName

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

The Name object for the locator workspace.

Specified by:

getName in interface ILocatorWorkspace

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

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

LocatorName objects in the locator workspace.

Specified by:

getLocatorNames in interface ILocatorWorkspace

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

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

Locators in the locator workspace.

Specified by:

getLocators in interface ILocatorWorkspace

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

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

Gets a LocatorName object.

Specified by:

getLocatorName in interface ILocatorWorkspace

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

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

Gets a locator.

Specified by:

getLocator in interface ILocatorWorkspace

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

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

Gets a locator style.

Specified by:

getLocatorStyle in interface ILocatorWorkspace

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

public 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.

Specified by:

addLocator in interface ILocatorWorkspace

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

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

Adds a locator style.

Specified by:

addLocatorStyle in interface ILocatorWorkspace

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

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

Modifies the properties of a locator.

Specified by:

updateLocator in interface ILocatorWorkspace

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

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

Deletes a locator.

Specified by:

deleteLocator in interface ILocatorWorkspace

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

renameLocator

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

Renames a locator.

Specified by:

renameLocator in interface ILocatorWorkspace

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

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

Copies a locator.

Specified by:

copyLocator in interface ILocatorWorkspace

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.

getAGSServerConnection

public IAGSServerConnectionName getAGSServerConnection()
                                                throws java.io.IOException,
                                                       AutomationException

The ArcGIS server connection that contains the locator workspace.

Specified by:

getAGSServerConnection in interface IAGSLocatorWorkspace

Returns:

A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

attachLocator

public void attachLocator(ILocator locator,
                          ITable attachToTable,
                          ITable inputTable,
                          java.lang.String inputFieldNames,
                          java.lang.String inputJoinFieldName,
                          ITable outputTable,
                          java.lang.String outputFieldNames,
                          java.lang.String outputJoinFieldName)
                   throws java.io.IOException,
                          AutomationException

Attaches a locator to a table.

Specified by:

attachLocator in interface ILocatorAttach

Parameters:

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

attachToTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

inputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

inputFieldNames - The inputFieldNames (in)

inputJoinFieldName - The inputJoinFieldName (in)

outputTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

outputFieldNames - The outputFieldNames (in)

outputJoinFieldName - The outputJoinFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

attachLocator

public void attachLocator(ILocator locator,
                          ITable attachToTable,
                          java.lang.String inputFieldNames,
                          java.lang.String outputFieldNames)
                   throws java.io.IOException,
                          AutomationException

Attaches a locator to a table (simple function).

Specified by:

attachLocator in interface ILocatorAttach2

Parameters:

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

attachToTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

inputFieldNames - The inputFieldNames (in)

outputFieldNames - The outputFieldNames (in)

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.