com.esri.arcgis.geodatabase

Interface IWorkspaceFactory

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IWorkspaceFactory2

All Known Implementing Classes:

BDConnectionWorkspaceFactory, BimFileWorkspaceFactory, CadWorkspaceFactory, FileGDBWorkspaceFactory, InMemoryWorkspaceFactory, IWorkspaceFactory2Proxy, IWorkspaceFactoryProxy, MemoryWorkspaceFactory, PCCoverageWorkspaceFactory, PlugInWorkspaceFactory, RasterWorkspaceFactory, RealtimePluginWorkspaceFactory, SdeWorkspaceFactory, ShapefileWorkspaceFactory, SqliteWorkspaceFactory, SqlWorkspaceFactory, TinWorkspaceFactory, VpfWorkspaceFactory, WorkspaceFactory

public interface IWorkspaceFactory
extends java.io.Serializable

COM Interface 'IWorkspaceFactory'. Generated 9/21/2023 10:01:46 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDf173fc16_d63a_11d1_aa81_00c04fa33a15
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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.

Field Detail

IIDf173fc16_d63a_11d1_aa81_00c04fa33a15

static final int IIDf173fc16_d63a_11d1_aa81_00c04fa33a15

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

open

IWorkspace open(IPropertySet connectionProperties,
                int hWnd)
         throws java.io.IOException,
                AutomationException

Opens the workspace specified by the connection properties.

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

IWorkspace openFromFile(java.lang.String fileName,
                        int hWnd)
                 throws java.io.IOException,
                        AutomationException

Opens the workspace specified by the given file name.

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

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.

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

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.

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

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.

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

IUID getClassID()
         throws java.io.IOException,
                AutomationException

The class ID of the WorkspaceFactory.

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

boolean isWorkspace(java.lang.String fileName)
             throws java.io.IOException,
                    AutomationException

True if the specified file identifies a workspace supported by the workspace factory.

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

IPropertySet readConnectionPropertiesFromFile(java.lang.String fileName)
                                       throws java.io.IOException,
                                              AutomationException

The connection properties from the specified file.

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

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.

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

int getWorkspaceType()
              throws java.io.IOException,
                     AutomationException

The type of workspace the workspace factory opens/creates.

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

boolean copy(IWorkspaceName workspaceName,
             java.lang.String destinationFolder,
             IWorkspaceName[] workspaceNameCopy)
      throws java.io.IOException,
             AutomationException

Copies a workspace to the specified destination folder.

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

boolean move(IWorkspaceName workspaceName,
             java.lang.String destinationFolder)
      throws java.io.IOException,
             AutomationException

Moves a workspace to the specified destination folder.

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.