com.esri.arcgis.geodatabase
Class IWorkspaceNameProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IWorkspaceNameProxy

All Implemented Interfaces:

java.io.Externalizable, IWorkspaceName, java.io.Serializable

Direct Known Subclasses:

IWorkspaceName2Proxy

public class IWorkspaceNameProxy

extends Dispatch

implements IWorkspaceName, java.io.Serializable

Provides access to members that supply workspace name information.

Product Availability

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

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	IWorkspaceNameProxy() For internal use only
	IWorkspaceNameProxy(java.lang.Object obj)
protected	IWorkspaceNameProxy(java.lang.Object obj, java.lang.String iid)
	IWorkspaceNameProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	IWorkspaceNameProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
java.lang.String	getBrowseName() The browse name of the WorkspaceName.
java.lang.String	getCategory() The category of the WorkspaceName.
IPropertySet	getConnectionProperties() The connection properties of the WorkspaceName.
java.lang.String	getPathName() The path name of the WorkspaceName.
int	getType() The type of the associated workspace.
IWorkspaceFactory	getWorkspaceFactory() The workspace factory of the WorkspaceName.
java.lang.String	getWorkspaceFactoryProgID() The ProgID of the WorkspaceName's workspace factory.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
void	setBrowseName(java.lang.String browseName) The browse name of the WorkspaceName.
void	setConnectionProperties(IPropertySet connectionProperties) The connection properties of the WorkspaceName.
void	setPathName(java.lang.String pathName) The path name of the WorkspaceName.
void	setWorkspaceFactoryProgID(java.lang.String progID) The ProgID of the WorkspaceName's workspace factory.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

IWorkspaceNameProxy

public IWorkspaceNameProxy(java.lang.String CLSID,
                           java.lang.String host,
                           AuthInfo authInfo)
                    throws java.net.UnknownHostException,
                           java.io.IOException

IWorkspaceNameProxy

public IWorkspaceNameProxy()

For internal use only

IWorkspaceNameProxy

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

IWorkspaceNameProxy

protected IWorkspaceNameProxy(java.lang.Object obj,
                              java.lang.String iid)
                       throws java.io.IOException

IWorkspaceNameProxy

protected IWorkspaceNameProxy(java.lang.String CLSID,
                              java.lang.String iid,
                              java.lang.String host,
                              AuthInfo authInfo)
                       throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

getPathName

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

Description copied from interface: IWorkspaceName

The path name of the WorkspaceName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPathName in interface IWorkspaceName

Returns:

The pathName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setPathName

public void setPathName(java.lang.String pathName)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IWorkspaceName

The path name of the WorkspaceName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPathName in interface IWorkspaceName

Parameters:

pathName - The pathName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWorkspaceFactoryProgID

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

Description copied from interface: IWorkspaceName

The ProgID of the WorkspaceName's workspace factory.

Supported Platforms

Windows, Solaris, Linux

Description

The WorkspaceFactoryProgID identifies the ProgID of the WorkspaceFactory object that is used to open that particular workspace.

Here is a list of some of the possible WorkspaceFactoryProgIDs:

• esriDataSourcesGDB.AccessWorkspaceFactory
• esriDataSourcesFile.ArcInfoWorkspaceFactory
• esriDataSourcesFile.CadWorkspaceFactory
• esriDataSourcesGDB.FileGDBWorkspaceFactory
• esriDataSourcesOleDB.OLEDBWorkspaceFactory
• esriDataSourcesFile.PCCoverageWorkspaceFactory
• esriDataSourcesRaster.RasterWorkspaceFactory
• esriDataSourcesGDB.SdeWorkspaceFactory
• esriDataSourcesFile.ShapefileWorkspaceFactory
• esriDataSourcesOleDB.TextFileWorkspaceFactory
• esriDataSourcesFile.TinWorkspaceFactory
• esriDataSourcesFile.VpfWorkspaceFactory

Specified by:

getWorkspaceFactoryProgID in interface IWorkspaceName

Returns:

The progID

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setWorkspaceFactoryProgID

public void setWorkspaceFactoryProgID(java.lang.String progID)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IWorkspaceName

The ProgID of the WorkspaceName's workspace factory.

Supported Platforms

Windows, Solaris, Linux

Description

The WorkspaceFactoryProgID identifies the ProgID of the COM WorkspaceFactory object used to open a workspace through a WorkspaceName object. You must set this property when you are using the WorkspaceName to open a workspace.

Here is a list of some of the possible WorkspaceFactoryProgIDs:

• esriDataSourcesGDB.AccessWorkspaceFactory
• esriDataSourcesFile.ArcInfoWorkspaceFactory
• esriDataSourcesFile.CadWorkspaceFactory
• esriDataSourcesGDB.FileGDBWorkspaceFactory
• esriDataSourcesOleDB.OLEDBWorkspaceFactory
• esriDataSourcesFile.PCCoverageWorkspaceFactory
• esriDataSourcesRaster.RasterWorkspaceFactory
• esriDataSourcesGDB.SdeWorkspaceFactory
• esriDataSourcesFile.ShapefileWorkspaceFactory
• esriDataSourcesOleDB.TextFileWorkspaceFactory
• esriDataSourcesFile.TinWorkspaceFactory
• esriDataSourcesFile.VpfWorkspaceFactory

To set the WorkspaceName's WorkspaceFactoryProgID, simply pass it the string representing the correct type of workspace factory.

Specified by:

setWorkspaceFactoryProgID in interface IWorkspaceName

Parameters:

progID - The progID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getBrowseName

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

Description copied from interface: IWorkspaceName

The browse name of the WorkspaceName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBrowseName in interface IWorkspaceName

Returns:

The browseName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setBrowseName

public void setBrowseName(java.lang.String browseName)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IWorkspaceName

The browse name of the WorkspaceName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBrowseName in interface IWorkspaceName

Parameters:

browseName - The browseName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWorkspaceFactory

public IWorkspaceFactory getWorkspaceFactory()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IWorkspaceName

The workspace factory of the WorkspaceName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceFactory in interface IWorkspaceName

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setConnectionProperties

public void setConnectionProperties(IPropertySet connectionProperties)
                             throws java.io.IOException,
                                    AutomationException

Description copied from interface: IWorkspaceName

The connection properties of the WorkspaceName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setConnectionProperties in interface IWorkspaceName

Parameters:

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IWorkspaceName

The connection properties of the WorkspaceName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getConnectionProperties in interface IWorkspaceName

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

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

Description copied from interface: IWorkspaceName

The type of the associated workspace.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IWorkspaceName

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCategory

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

Description copied from interface: IWorkspaceName

The category of the WorkspaceName.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IWorkspaceName

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.