com.esri.arcgis.geodatabase
Class IWorkspaceFactoryProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.IWorkspaceFactoryProxy
All Implemented Interfaces:
IWorkspaceFactory, java.io.Externalizable, java.io.Serializable
Direct Known Subclasses:
IWorkspaceFactory2Proxy

public class IWorkspaceFactoryProxy
extends com.esri.arcgis.interop.Dispatch
implements IWorkspaceFactory, java.io.Serializable

Internal use class Proxy for COM Interface 'IWorkspaceFactory'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members that create and open workspaces and supply workspace factory information.' 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
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceFactory
IID, IIDf173fc16_d63a_11d1_aa81_00c04fa33a15
 
Constructor Summary
  IWorkspaceFactoryProxy()
          For internal use only
  IWorkspaceFactoryProxy(java.lang.Object obj)
           
protected IWorkspaceFactoryProxy(java.lang.Object obj, java.lang.String iid)
           
  IWorkspaceFactoryProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IWorkspaceFactoryProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 boolean containsWorkspace(java.lang.String parentDirectory, IFileNames fileNames)
          Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.
 boolean copy(IWorkspaceName workspaceName, java.lang.String destinationFolder, IWorkspaceName[] workspaceNameCopy)
          Copies a workspace to the specified destination folder.
 IWorkspaceName create(java.lang.String parentDirectory, java.lang.String name, IPropertySet connectionProperties, int hWnd)
          Creates a new workspace specified by the directory, file name, and connection properties.
 IUID getClassID()
          The class ID of the WorkspaceFactory.
 java.lang.String getWorkspaceDescription(boolean plural)
          A singular or plural description of the type of workspace the workspace factory opens/creates.
 IWorkspaceName getWorkspaceName(java.lang.String parentDirectory, IFileNames fileNames)
          Retrieves the workspace name of a workspace from the given list of file names.
 int getWorkspaceType()
          The type of workspace the workspace factory opens/creates.
 boolean isWorkspace(java.lang.String fileName)
          True if the specified file identifies a workspace supported by the workspace factory.
 boolean move(IWorkspaceName workspaceName, java.lang.String destinationFolder)
          Moves a workspace to the specified destination folder.
 IWorkspace open(IPropertySet connectionProperties, int hWnd)
          Opens the workspace specified by the connection properties.
 IWorkspace openFromFile(java.lang.String fileName, int hWnd)
          Opens the workspace specified by the given file name.
 IPropertySet readConnectionPropertiesFromFile(java.lang.String fileName)
          The connection properties from the specified file.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, 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

noncastable

public boolean noncastable
Constructor Detail

IWorkspaceFactoryProxy

public IWorkspaceFactoryProxy(java.lang.String CLSID,
                              java.lang.String host,
                              com.esri.arcgis.interop.AuthInfo authInfo)
                       throws java.net.UnknownHostException,
                              java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IWorkspaceFactoryProxy

public IWorkspaceFactoryProxy()
For internal use only


IWorkspaceFactoryProxy

public IWorkspaceFactoryProxy(java.lang.Object obj)
                       throws java.io.IOException
Throws:
java.io.IOException

IWorkspaceFactoryProxy

protected IWorkspaceFactoryProxy(java.lang.Object obj,
                                 java.lang.String iid)
                          throws java.io.IOException
Throws:
java.io.IOException

IWorkspaceFactoryProxy

protected IWorkspaceFactoryProxy(java.lang.String CLSID,
                                 java.lang.String iid,
                                 java.lang.String host,
                                 com.esri.arcgis.interop.AuthInfo authInfo)
                          throws java.io.IOException
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
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

open

public IWorkspace open(IPropertySet connectionProperties,
                       int hWnd)
                throws java.io.IOException,
                       AutomationException
Opens the workspace specified by the connection properties.

Specified by:
open in interface IWorkspaceFactory
Parameters:
connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)
hWnd - The hWnd (A COM typedef) (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openFromFile

public IWorkspace openFromFile(java.lang.String fileName,
                               int hWnd)
                        throws java.io.IOException,
                               AutomationException
Opens the workspace specified by the given file name.

Specified by:
openFromFile in interface IWorkspaceFactory
Parameters:
fileName - The fileName (in)
hWnd - The hWnd (A COM typedef) (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

create

public IWorkspaceName create(java.lang.String parentDirectory,
                             java.lang.String name,
                             IPropertySet connectionProperties,
                             int hWnd)
                      throws java.io.IOException,
                             AutomationException
Creates a new workspace specified by the directory, file name, and connection properties.

Specified by:
create in interface IWorkspaceFactory
Parameters:
parentDirectory - The parentDirectory (in)
name - The name (in)
connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)
hWnd - The hWnd (A COM typedef) (in)
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.

containsWorkspace

public boolean containsWorkspace(java.lang.String parentDirectory,
                                 IFileNames fileNames)
                          throws java.io.IOException,
                                 AutomationException
Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.

Specified by:
containsWorkspace in interface IWorkspaceFactory
Parameters:
parentDirectory - The parentDirectory (in)
fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)
Returns:
The containsWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName(java.lang.String parentDirectory,
                                       IFileNames fileNames)
                                throws java.io.IOException,
                                       AutomationException
Retrieves the workspace name of a workspace from the given list of file names.

Specified by:
getWorkspaceName in interface IWorkspaceFactory
Parameters:
parentDirectory - The parentDirectory (in)
fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)
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.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException
The class ID of the WorkspaceFactory.

Specified by:
getClassID in interface IWorkspaceFactory
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isWorkspace

public boolean isWorkspace(java.lang.String fileName)
                    throws java.io.IOException,
                           AutomationException
True if the specified file identifies a workspace supported by the workspace factory.

Specified by:
isWorkspace in interface IWorkspaceFactory
Parameters:
fileName - The fileName (in)
Returns:
The isWorkspace
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

readConnectionPropertiesFromFile

public IPropertySet readConnectionPropertiesFromFile(java.lang.String fileName)
                                              throws java.io.IOException,
                                                     AutomationException
The connection properties from the specified file.

Specified by:
readConnectionPropertiesFromFile in interface IWorkspaceFactory
Parameters:
fileName - The fileName (in)
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.

getWorkspaceDescription

public java.lang.String getWorkspaceDescription(boolean plural)
                                         throws java.io.IOException,
                                                AutomationException
A singular or plural description of the type of workspace the workspace factory opens/creates.

Specified by:
getWorkspaceDescription in interface IWorkspaceFactory
Parameters:
plural - The plural (in)
Returns:
The description
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWorkspaceType

public int getWorkspaceType()
                     throws java.io.IOException,
                            AutomationException
The type of workspace the workspace factory opens/creates.

Specified by:
getWorkspaceType in interface IWorkspaceFactory
Returns:
A com.esri.arcgis.geodatabase.esriWorkspaceType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

public boolean copy(IWorkspaceName workspaceName,
                    java.lang.String destinationFolder,
                    IWorkspaceName[] workspaceNameCopy)
             throws java.io.IOException,
                    AutomationException
Copies a workspace to the specified destination folder.

Specified by:
copy in interface IWorkspaceFactory
Parameters:
workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
destinationFolder - The destinationFolder (in)
workspaceNameCopy - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (out: use single element array)
Returns:
The successfulCopy
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

move

public boolean move(IWorkspaceName workspaceName,
                    java.lang.String destinationFolder)
             throws java.io.IOException,
                    AutomationException
Moves a workspace to the specified destination folder.

Specified by:
move in interface IWorkspaceFactory
Parameters:
workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)
destinationFolder - The destinationFolder (in)
Returns:
The successfulMove
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.