com.esri.arcgis.datasourcesGDB

Class SqlWorkspaceFactory

java.lang.Object

com.esri.arcgis.datasourcesGDB.SqlWorkspaceFactory

All Implemented Interfaces:

IRemoteDatabaseWorkspaceFactory, ISqlDefaultConnectionInfo, IWorkspaceFactory, IWorkspaceFactory2, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class SqlWorkspaceFactory
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspaceFactory, IWorkspaceFactory2, IRemoteDatabaseWorkspaceFactory, ISupportErrorInfo, ISqlDefaultConnectionInfo

COM Class 'SqlWorkspaceFactory'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesGDB.tlb'

Description 'Sql workspace factory' 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

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

IID, IIDd29cd15f_3014_11d4_8141_00c04f686238, xxDummy

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

IIDf173fc16_d63a_11d1_aa81_00c04fa33a15

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

IID, IIDab4a2d7a_055b_11d2_aa97_00c04fa33a15, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

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

IID, IID177a8e41_d923_4996_99fe_d87d7e1833cd, xxDummy

Constructor Summary

Constructors

Constructor and Description
SqlWorkspaceFactory() Constructs a SqlWorkspaceFactory using ArcGIS Engine.
SqlWorkspaceFactory(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. SqlWorkspaceFactory theSqlWorkspaceFactory = (SqlWorkspaceFactory) obj;

Method Summary

Modifier and Type	Method and Description
void	clearParameters(java.lang.String dbclient, java.lang.String instance, java.lang.String authenticationMode) Clears connection property parameters.
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.
void	deleteConnectionFile(java.lang.String pathName) Deletes the remote database workspace connection file.
IWorkspaceName	editConnectionFile(java.lang.String pathName, int hWnd) Edits the properties of a remote database workspace connection file.
boolean	equals(java.lang.Object o) Compare this object with another
IUID	getClassID() The class ID of the WorkspaceFactory.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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.
IWorkspace	openFromString(java.lang.String connectStr, int hWnd) Opens the workspace specified by a connection string.
IPropertySet	readConnectionPropertiesFromFile(java.lang.String fileName) The connection properties from the specified file.
void	release() Release this COM object reference
IWorkspaceName	renameConnectionFile(java.lang.String oldPathName, java.lang.String newName) Renames the remote database workspace connection file.
void	setParameters(java.lang.String dbclient, java.lang.String instance, java.lang.String authenticationMode, java.lang.String user, java.lang.String password) Sets connection property parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlWorkspaceFactory

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

Constructs a SqlWorkspaceFactory using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SqlWorkspaceFactory

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

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

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.

openFromString

public IWorkspace openFromString(java.lang.String connectStr,
                                 int hWnd)
                          throws java.io.IOException,
                                 AutomationException

Opens the workspace specified by a connection string.

Specified by:

openFromString in interface IWorkspaceFactory2

Parameters:

connectStr - The connectStr (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.

deleteConnectionFile

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

Deletes the remote database workspace connection file.

Specified by:

deleteConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

pathName - The pathName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

renameConnectionFile

public IWorkspaceName renameConnectionFile(java.lang.String oldPathName,
                                           java.lang.String newName)
                                    throws java.io.IOException,
                                           AutomationException

Renames the remote database workspace connection file.

Specified by:

renameConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

oldPathName - The oldPathName (in)

newName - The newName (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.

editConnectionFile

public IWorkspaceName editConnectionFile(java.lang.String pathName,
                                         int hWnd)
                                  throws java.io.IOException,
                                         AutomationException

Edits the properties of a remote database workspace connection file.

Specified by:

editConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

pathName - The pathName (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.

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.

setParameters

public void setParameters(java.lang.String dbclient,
                          java.lang.String instance,
                          java.lang.String authenticationMode,
                          java.lang.String user,
                          java.lang.String password)
                   throws java.io.IOException,
                          AutomationException

Sets connection property parameters.

Specified by:

setParameters in interface ISqlDefaultConnectionInfo

Parameters:

dbclient - The dbclient (in)

instance - The instance (in)

authenticationMode - The authenticationMode (in)

user - The user (in)

password - The password (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearParameters

public void clearParameters(java.lang.String dbclient,
                            java.lang.String instance,
                            java.lang.String authenticationMode)
                     throws java.io.IOException,
                            AutomationException

Clears connection property parameters.

Specified by:

clearParameters in interface ISqlDefaultConnectionInfo

Parameters:

dbclient - The dbclient (in)

instance - The instance (in)

authenticationMode - The authenticationMode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.