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, Externalizable, Serializable

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

A locator workspace description.

Description

A LocatorWorkspaceName is a lightweight object that represents a locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

ILocatorWorkspace2, ILocatorManager2, DatabaseLocatorWorkspace, ILocatorWorkspace, ILocatorManager.getLocatorWorkspaceFromPath(String), LocatorEnumerator, ILocatorWorkspaceName2, LocatorWorkspaceName, IDatabaseLocatorWorkspace, LocalLocatorWorkspace, ILocatorManager, LocatorManager, ILocatorWorkspaceName, Serialized Form

Constructor Summary

LocatorWorkspaceName()
Constructs a LocatorWorkspaceName using ArcGIS Engine.

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

Method Summary

boolean	equals(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 String	getClsid() getClsid.
String	getNameString() The name string of the object.
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
Object	open() Opens the object referred to by this name.
void	readExternal(ObjectInput in)
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(String nameString) The name string of the object.
void	setPath(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(ObjectOutput out)

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

LocatorWorkspaceName

public LocatorWorkspaceName()
                     throws IOException,
                            UnknownHostException

Constructs a LocatorWorkspaceName using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

LocatorWorkspaceName

public LocatorWorkspaceName(Object obj)
                     throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setNameString

public void setNameString(String nameString)
                   throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

public String getNameString()
                     throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public Object open()
            throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException

The path to the folder that contains the locator workspace.

Remarks

If the locator workspace represented by the LocatorWorkspaceName object is a file system locator workspace, then the Path property returns the path to the file system folder that contains the locator workspace. The value returned by the Path property depends on the value returned by the Type property, as shown in the following table:

If the value of the Type property is:	then the Path property returns:
esriLocalSystemLocatorWorkspace	an empty string
esriFileSystemLocatorWorkspace	the path to the file system folder that contains the locator workspace

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPath in interface ILocatorWorkspaceName

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPath

public void setPath(String path)
             throws IOException,
                    AutomationException

The path to the folder that contains the locator workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPath in interface ILocatorWorkspaceName

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws IOException,
                                       AutomationException

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

Remarks

The WorkspaceName property returns a WorkspaceName object that represents the ArcSDE workspace that contains the locator workspace represented by the LocatorWorkspaceName object. Use the Type property to determine if the locator workspace is an ArcSDE locator workspace before using this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceName in interface ILocatorWorkspaceName

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName wksName)
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWorkspaceNameByRef in interface ILocatorWorkspaceName

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws IOException,
                   AutomationException

The type of locator workspace.

Description

The Type property returns a value from the esriLocatorWorkspaceType enumeration that indicates the type of locator workspace that the LocatorWorkspaceName object represents.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface ILocatorWorkspaceName

Returns:

A com.esri.arcgis.geodatabase.esriLocatorWorkspaceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILocatorWorkspaceName.getType(), esriLocatorWorkspaceType

getAGSServerConnectionName

public IAGSServerConnectionName getAGSServerConnectionName()
                                                    throws IOException,
                                                           AutomationException

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

Description

Returns an AGSServerConnectionName object that represents the ArcGIS Server connection that contains the locator workspace.

Remarks

If the locator workspace represented by the LocatorWorkspaceName object represents a locator workspace from an ArcGIS Server, this property returns a reference to an ArcGISServerConnectionName object that represents the ArcGIS Server connection.

Product Availability

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

Specified by:

getAGSServerConnectionName in interface ILocatorWorkspaceName2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnumServerObjectType, AGSLocatorWorkspace, IEnumServerObjectTypeInfo, GeocodeServer, ILocatorManager2.getAGSLocatorWorkspace(com.esri.arcgis.gisclient.IAGSServerConnectionName), ServerObject, ILocatorWorkspaceName2.getAGSServerConnectionName(), AGSAddressLocator

setAGSServerConnectionNameByRef

public void setAGSServerConnectionNameByRef(IAGSServerConnectionName serverConnection)
                                     throws IOException,
                                            AutomationException

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

Product Availability

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

Specified by:

setAGSServerConnectionNameByRef in interface ILocatorWorkspaceName2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException