com.esri.arcgis.location
Class LocatorWorkspaceName

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

All Implemented Interfaces:

ILocatorWorkspaceName, com.esri.arcgis.interop.RemoteObjRef, ILocatorWorkspaceName2, IName, IPersist, IPersistStream, ISupportErrorInfo, java.io.Externalizable, java.io.Serializable

public class LocatorWorkspaceName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IName, ILocatorWorkspaceName, ILocatorWorkspaceName2, IPersistStream, ISupportErrorInfo, java.io.Externalizable

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

Description 'A locator workspace description.' 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

static long

serialVersionUID

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

IID, IIDf47bb961_8885_4cdc_9c85_00be5dd6d903, xxDummy

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

IIDfc747401_39c0_4842_8635_6db6f96717e5

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

LocatorWorkspaceName()
Constructs a LocatorWorkspaceName using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IAGSServerConnectionName	getAGSServerConnectionName() The name of the ArcGIS server connection that contains the locator workspace.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getNameString() The name string of the object.
java.lang.String	getPath() The path to the folder that contains the locator workspace.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	getType() The type of locator workspace.
IWorkspaceName	getWorkspaceName() The Name object for the ArcSDE workspace that contains the locator workspace.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
void	load(IStream pstm) load
java.lang.Object	open() Opens the object referred to by this name.
void	readExternal(java.io.ObjectInput in)
void	release() Release a LocatorWorkspaceName.
void	save(IStream pstm, int fClearDirty) save
void	setAGSServerConnectionNameByRef(IAGSServerConnectionName serverConnection) The name of the ArcGIS server connection that contains the locator workspace.
void	setNameString(java.lang.String nameString) The name string of the object.
void	setPath(java.lang.String path) The path to the folder that contains the locator workspace.
void	setWorkspaceNameByRef(IWorkspaceName wksName) The Name object for the ArcSDE workspace that contains the locator workspace.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

LocatorWorkspaceName

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

Constructs a LocatorWorkspaceName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

LocatorWorkspaceName

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

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

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

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

Specified by:

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

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNameString

public java.lang.String getNameString()
                               throws java.io.IOException,
                                      AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

public java.lang.Object open()
                      throws java.io.IOException,
                             AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPath

public java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException

The path to the folder that contains the locator workspace.

Specified by:

getPath in interface ILocatorWorkspaceName

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(java.lang.String path)
             throws java.io.IOException,
                    AutomationException

The path to the folder that contains the locator workspace.

Specified by:

setPath in interface ILocatorWorkspaceName

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws java.io.IOException,
                                       AutomationException

The Name object for the ArcSDE workspace that contains the locator workspace.

Specified by:

getWorkspaceName in interface ILocatorWorkspaceName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName wksName)
                           throws java.io.IOException,
                                  AutomationException

The Name object for the ArcSDE workspace that contains the locator workspace.

Specified by:

setWorkspaceNameByRef in interface ILocatorWorkspaceName

Parameters:

wksName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type of locator workspace.

Specified by:

getType in interface ILocatorWorkspaceName

Returns:

A com.esri.arcgis.geodatabase.esriLocatorWorkspaceType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAGSServerConnectionName

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

The name of the ArcGIS server connection that contains the locator workspace.

Specified by:

getAGSServerConnectionName in interface ILocatorWorkspaceName2

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.

setAGSServerConnectionNameByRef

public void setAGSServerConnectionNameByRef(IAGSServerConnectionName serverConnection)
                                     throws java.io.IOException,
                                            AutomationException

The name of the ArcGIS server connection that contains the locator workspace.

Specified by:

setAGSServerConnectionNameByRef in interface ILocatorWorkspaceName2

Parameters:

serverConnection - A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

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.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException