com.esri.arcgis.geoprocessing
Class ToolboxWorkspaceFactory

java.lang.Object
  com.esri.arcgis.geoprocessing.ToolboxWorkspaceFactory

All Implemented Interfaces:

ISupportErrorInfo, IToolboxWorkspaceFactory, IWorkspaceFactory, IWorkspaceFactory2, java.io.Serializable

public class ToolboxWorkspaceFactory

extends java.lang.Object

implements IWorkspaceFactory, IWorkspaceFactory2, IToolboxWorkspaceFactory, ISupportErrorInfo

Workspace Factory used to open toolbox workspaces.

Product Availability

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

Supported Platforms

Windows

Remarks

A WorkspaceFactory is a dispenser of workspaces and allows a client to connect to a workspace specified by a set of connection properties. The ToolboxWorkspaceFactory object can be used to open a toolbox from a workspace.

A Workspace is a container of spatial and nonspatial datasets such as feature classes, raster datasets, tables and toolboxes. It provides methods to instantiate existing datasets and to create new datasets. Workspaces are classified into types specified by the esriWorkspaceType enumerator: esriFileSystemWorksapce, esriLocalDatabaseWorkspace, and esriRemoteDatabaseWorkspace.

A toolbox workspace can be either a esriFileSystemWorkspace, a esriLocalDatabaseWorkspace, or a esriRemoteDatabaseWorkspace. Toolboxes can exist in a folder, a personal geodatabase, a file geodatabase, or a enterprise geodatabase.

See Also:

Serialized Form

Constructor Summary

ToolboxWorkspaceFactory()
Constructs a ToolboxWorkspaceFactory using ArcGIS Engine.

ToolboxWorkspaceFactory(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

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.
boolean	equals(java.lang.Object o) Compare this object with another
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IToolboxWorkspaceFactory	getAsIToolboxWorkspaceFactory() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IWorkspaceFactory	getAsIWorkspaceFactory() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IWorkspaceFactory2	getAsIWorkspaceFactory2() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IUID	getClassID() The class ID of the WorkspaceFactory.
static java.lang.String	getClsid()
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) Supported Platforms
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolboxWorkspaceFactory

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

Constructs a ToolboxWorkspaceFactory using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ToolboxWorkspaceFactory

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a ToolboxWorkspaceFactory using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ToolboxWorkspaceFactory.
ToolboxWorkspaceFactory theToolboxWorkspaceFactory = (ToolboxWorkspaceFactory) obj;

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

getAsIWorkspaceFactory

public IWorkspaceFactory getAsIWorkspaceFactory()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIWorkspaceFactory2

public IWorkspaceFactory2 getAsIWorkspaceFactory2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIToolboxWorkspaceFactory

public IToolboxWorkspaceFactory getAsIToolboxWorkspaceFactory()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

open

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

Description copied from interface: IWorkspaceFactory

Opens the workspace specified by the connection properties.

Supported Platforms

Windows, Solaris, Linux

Remarks

Open takes as input a property set of connection properties that specify the workspace to connect to. In the case of file system workspaces and local database workspaces, a single property named DATABASE, whose value is the pathname to the workspace, is usually all that is required. In the case of remote database workspaces accessed via ArcSDE the properties can include the USER, PASSWORD, DATABASE, SERVER, INSTANCE, VERSION, HISTORICAL_NAME, HISTORICAL_TIMESTAMP, and AUTHENTICATION_MODE properties of the database being connected to.

List of acceptable connection property names and a brief description of each

"SERVER" – SDE server name you are connecting to.

"INSTANCE" – Instance you are connection to.

"DATABASE" – Database connected to.

"USER" – Connected user.

"PASSWORD" – Connected password.

"AUTHENTICATION_MODE" – Credential authentication mode of the connection. Acceptable values are "OSA" and "DBMS".

"VERSION" – Transactional version to connect to. Acceptable value is a string that represents a transaction version name.

"HISTORICAL_NAME" – Historical version to connect to. Acceptable value is a string type that represents a historical marker name.

"HISTORICAL_TIMESTAMP" – Moment in history to establish an historical version connection. Acceptable value is a date time that represents a moment timestamp.

Notes:

The "DATABASE" property is optional and is required for ArcSDE instances that manage multiple databases (for example, SQL Server).

If “AUTHENTICATION_MODE” is “OSA” then “USER” and “PASSWORD” are not required. “OSA” represents operating system authentication and uses the operating system credentials to establish a connection with the database.

Since the workspace connection can only represent one version only 1 of the 3 version properties (“VERSION” or “HISTORICAL_NAME” or “HISTORICAL_TIMESTAMP”) should be used.

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:

AutomationException - If the ArcObject component throws an exception.

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

openFromFile

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

Description copied from interface: IWorkspaceFactory

Opens the workspace specified by the given file name.

Supported Platforms

Windows, Solaris, Linux

Remarks

OpenFromFile takes the pathname of a file or directory that represents either a FileSystemWorkspace or LocalDatabaseWorkspace, or a connection file to a RemoteDatabase workspace and returns an interface on the specified workspace. Clients of these methods can then proceed to open and access datasets in the workspace. If these methods are called with insufficient properties, then the user will be presented with a connection dialog that will prompt for the required properties.

The hWnd argument is the parent window or application's window. The hWnd will guarantee that the connection dialog, if presented to you because of insufficient properties, has the correct parent.

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

Description copied from interface: IWorkspaceFactory

Creates a new workspace specified by the directory, file name, and connection properties.

Supported Platforms

Windows, Solaris, Linux

Remarks

Create has different results depending on the type of workspace factory. If you are working with ArcSDE, a new connection file (.sde) is created. If you are working with an ArcInfo workspace factory, then a folder with an INFO subfolder is created. The optional ConnectionProperties parameter specifies any additional connection properties needed, such as the server, instance, user and password in the case where a connection file to a remote database workspace is being created. If no connection properties are specified, then this method will result in a dialog being displayed that prompts the user for the required 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:

AutomationException - If the ArcObject component throws an exception.

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

containsWorkspace

public boolean containsWorkspace(java.lang.String parentDirectory,
                                 IFileNames fileNames)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IWorkspaceFactory

Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.

Supported Platforms

Windows, Solaris, Linux

Remarks

ContainsWorkspace is useful when browsing the file system for workspaces. It takes a parent directory and the list of file names in the directory to be examined. It returns true if the parent directory represents a workspace covered by this factory or if the parent directory contains a workspace or a connection file to a workspace covered by this factory.

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:

AutomationException - If the ArcObject component throws an exception.

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

getWorkspaceName

public IWorkspaceName getWorkspaceName(java.lang.String parentDirectory,
                                       IFileNames fileNames)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IWorkspaceFactory

Retrieves the workspace name of a workspace from the given list of file names.

Supported Platforms

Windows, Solaris, Linux

Remarks

GetWorkspaceName is useful when browsing the file system for workspaces. It is handed in a parent directory and the list of file names in the directory to be examined. It returns a WorkspaceName object representing the first workspace it finds in the list of filenames and removes any filenames representing the workspace or its datasets from the input list of filenames.

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

Description copied from interface: IWorkspaceFactory

The class ID of the WorkspaceFactory.

Supported Platforms

Windows, Solaris, Linux

Remarks

GetClassID returns the unique identifier for the workspace factory. You can use this to distinguish different versions of the same type of factory, for example, whether you are working with an SDEWorkspace, FileGDBWorkspace or AccessWorkspace factory.

Specified by:

getClassID in interface IWorkspaceFactory

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isWorkspace

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

Description copied from interface: IWorkspaceFactory

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

Description copied from interface: IWorkspaceFactory

The connection properties from the specified file.

Supported Platforms

Windows, Solaris, Linux

Remarks

The filename parameter represents the pathname of a file that contains the connection information to be placed into the IPropertySet variable. When used with ArcSDE connection files, the pathname generally points to a binary file in the directory %USERPROFILE%/Application Data/ESRI/ArcCatalog.

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

Description copied from interface: IWorkspaceFactory

A singular or plural description of the type of workspace the workspace factory opens/creates.

Supported Platforms

Windows, Solaris, Linux

Remarks

Example return values include:

WorkspaceFactory Description
Type of workspace -> Description
ArcSDE -> Spatial Database Connection
ArcInfo -> ArcInfo Workspace
Access -> Personal Geodatabase
File -> File Geodatabase
Shapefile -> Shapefiles
SDC -> SDC Data

The plural parameter is used as a helper that will take and make the workspacefactory plural. e.g. SDE Connection will become SDE Connections.

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

Description copied from interface: IWorkspaceFactory

The type of workspace the workspace factory opens/creates.

Supported Platforms

Windows, Solaris, Linux

Remarks

The WorkspaceType property of a WorkspaceFactory returns information on the type of workspace managed by the WorkspaceFactory. Workspaces are classified into the following types specified by the esriWorkspaceType enumeration; FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace.

See esriWorkspaceType for information on the types of workspaces.

Shapefiles and ArcInfo workspaces are examples of FileSystemWorkspace. A Personal Geodatabase stored in Access or a File Geodatabase is an example of a LocalDatabaseWorkspace . An ArcSDE Geodatabase stored in an RDBMS such as Oracle, DB2, SqlServer, or Informix and accessed via ArcSDE is an example of a RemoteDatabaseWorkspace.

Specified by:

getWorkspaceType in interface IWorkspaceFactory

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.

copy

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

Description copied from interface: IWorkspaceFactory

Copies a workspace to the specified destination folder.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.

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:

AutomationException - If the ArcObject component throws an exception.

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

move

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

Description copied from interface: IWorkspaceFactory

Moves a workspace to the specified destination folder.

Supported Platforms

Windows, Solaris, Linux

Remarks

The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.

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:

AutomationException - If the ArcObject component throws an exception.

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

openFromString

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

Description copied from interface: IWorkspaceFactory2

Opens the workspace specified by a connection string.

Supported Platforms

Windows, Solaris, Linux

Remarks

The connect string is a collection of name value pairs separated by a semicolon (;).

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:

AutomationException - If the ArcObject component throws an exception.

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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