com.esri.arcgis.datasourcesfile
Class SDCWorkspaceFactory

java.lang.Object
  com.esri.arcgis.datasourcesfile.SDCWorkspaceFactory

All Implemented Interfaces:

IPlugInCreateWorkspace, IPlugInWorkspaceFactoryHelper, IWorkspaceFactory, IWorkspaceFactory2, com.esri.arcgis.interop.RemoteObjRef, IParseNameString, java.io.Serializable

public class SDCWorkspaceFactory
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspaceFactory, IWorkspaceFactory2, IPlugInWorkspaceFactoryHelper, IPlugInCreateWorkspace, IParseNameString

COM Class 'SDCWorkspaceFactory'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriDataSourcesFile.olb'

Description 'Esri SDC 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.IPlugInCreateWorkspace

IID, IID697ffbd6_7d45_48c2_9810_7131183edcaf, xxDummy

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

IID, IIDdb1eccbf_c6c6_11d2_9f24_00c04f6bc69e, xxDummy

Constructor Summary

SDCWorkspaceFactory()
Constructs a SDCWorkspaceFactory using ArcGIS Engine.

SDCWorkspaceFactory(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SDCWorkspaceFactory theSDCWorkspaceFactory = (SDCWorkspaceFactory) obj;

Method Summary

boolean	canParse(java.lang.String nameString) Indicates if the given name string can be parsed by this parser.
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	createWorkspace(java.lang.String workspaceString) Creates a new Plug-In workspace.
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.
java.lang.String	getDatasetDescription(int datasetType) A desription of a detaset of the type specified.
java.lang.String	getDataSourceName() The name of the data source.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getWorkspaceDescription(boolean plural) A singular or plural description of the type of workspace the workspace factory opens/creates.
IUID	getWorkspaceFactoryTypeID() The class ID which is registered in the WorkspaceFactory category.
IWorkspaceName	getWorkspaceName(java.lang.String parentDirectory, IFileNames fileNames) Retrieves the workspace name of a workspace from the given list of file names.
java.lang.String	getWorkspaceString(java.lang.String parentDirectory, IFileNames fileNames) If parentDirectory is or contains a valid workspace, gets a string uniquely identifying that workspace.
int	getWorkspaceType() The type of workspace the workspace factory opens/creates.
int	hashCode() the hashcode for this object
boolean	isCanSupportSQL() Indicates whether datasets of this type can process SQL queries.
boolean	isWorkspace(java.lang.String fileName) True if the specified file identifies a workspace supported by the workspace factory.
java.lang.String	makeWorkspaceString(java.lang.String parentDirectory, java.lang.String file, IPropertySet connectionProperties) Gets a string uniquely identifing the workspace described by the input parameters.
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.
IPlugInWorkspaceHelper	openWorkspace(java.lang.String wksString) Opens a workspace helper for the workspace identified by the workspace string.
IName	parse(java.lang.String nameString) Parses the name string and returns a new Name object.
IPropertySet	readConnectionPropertiesFromFile(java.lang.String fileName) The connection properties from the specified file.
void	release() Release a SDCWorkspaceFactory.

Methods inherited from class java.lang.Object

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

Constructor Detail

SDCWorkspaceFactory

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

Constructs a SDCWorkspaceFactory using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

SDCWorkspaceFactory

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

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

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

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

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a SDCWorkspaceFactory.

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 IPlugInWorkspaceFactoryHelper

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 IPlugInWorkspaceFactoryHelper

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 IPlugInWorkspaceFactoryHelper

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 IPlugInWorkspaceFactoryHelper

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.

getDataSourceName

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

The name of the data source.

Description

The DataSourceName property returns the name of the plug-in data source.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDataSourceName in interface IPlugInWorkspaceFactoryHelper

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetDescription

public java.lang.String getDatasetDescription(int datasetType)
                                       throws java.io.IOException,
                                              AutomationException

A desription of a detaset of the type specified.

Product Availability

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

Specified by:

getDatasetDescription in interface IPlugInWorkspaceFactoryHelper

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

The dsDesc

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceFactoryTypeID

public IUID getWorkspaceFactoryTypeID()
                               throws java.io.IOException,
                                      AutomationException

The class ID which is registered in the WorkspaceFactory category.

Description

If the plug-in workspace factory helper class is written in C++, returns the CLSID of the that class. Otherwise, returns a proxy CLSID, which will be used as the CLSID of the workspace factory for the data source.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceFactoryTypeID in interface IPlugInWorkspaceFactoryHelper

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.

isCanSupportSQL

public boolean isCanSupportSQL()
                        throws java.io.IOException,
                               AutomationException

Indicates whether datasets of this type can process SQL queries.

Description

Should return true if the data access library can process where clauses. If this returns true, workspace factory helpers returned by OpenWorkspace should implement ISQLSyntax.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanSupportSQL in interface IPlugInWorkspaceFactoryHelper

Returns:

The canSupportSQL

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceString

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

If parentDirectory is or contains a valid workspace, gets a string uniquely identifying that workspace.

Description

If (1) the fileNames parameter is not null and ContainsWorkspace is true for this parentDirectory and list of fileNames, or (2) fileNames is null and IsWorkspace returns true for this parentDirectory, this method returns a string which represents this workspace and succeeds with S_OK as the HRESULT. Otherwise it returns null and succeeds with S_FALSE as the HRESULT. In the case where the fileNames parameter is not null, you must remove any files from the array that belong to your data source.

Note that for database data sources, parentDirectory will be the database or connection file when fileNames is null.

Remarks

This string can be passed to OpenWorkspace to open the workspace helper class for this workspace. For file- and folder-based data sources, the parentDirectory is considered the workspace. For database data sources, the first database in the list is considered the workspace. Files claimed by this data source (including .xml metadata files) must be removed from fileNames. (Note that database data sources should only remove the first database.) This function will be called repeatedly until it fails.
The content of the workspace strings is determined solely by the plug-in. Workspace strings are obtained from GetWorkspaceString and passed to IsWorkspace and OpenWorkspace. They are used as a lightweight representation of a workspace. For many data sources, the path to the workspace will be a good workspace string, but the strings can be anything. However, workspace strings containing reserved characters such as '=' should be enclosed by parentheses so that parsing will be safe.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceString in interface IPlugInWorkspaceFactoryHelper

Parameters:

parentDirectory - The parentDirectory (in)

fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)

Returns:

The wksString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openWorkspace

public IPlugInWorkspaceHelper openWorkspace(java.lang.String wksString)
                                     throws java.io.IOException,
                                            AutomationException

Opens a workspace helper for the workspace identified by the workspace string.

Description

Creates and initializes an instance of the workspace helper class and returns its IPlugInWorkspaceHelper pointer. The wksString may have been obtained from GetWorkspaceString, or it may be a custom string specified to IWorkspaceFactory::Open. If the wksString is not valid, the method should fail and return a null pointer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

openWorkspace in interface IPlugInWorkspaceFactoryHelper

Parameters:

wksString - The wksString (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

makeWorkspaceString

public java.lang.String makeWorkspaceString(java.lang.String parentDirectory,
                                            java.lang.String file,
                                            IPropertySet connectionProperties)
                                     throws java.io.IOException,
                                            AutomationException

Gets a string uniquely identifing the workspace described by the input parameters.

Specified by:

makeWorkspaceString in interface IPlugInCreateWorkspace

Parameters:

parentDirectory - The parentDirectory (in)

file - The file (in)

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

Returns:

The workspaceString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createWorkspace

public void createWorkspace(java.lang.String workspaceString)
                     throws java.io.IOException,
                            AutomationException

Creates a new Plug-In workspace.

Specified by:

createWorkspace in interface IPlugInCreateWorkspace

Parameters:

workspaceString - The workspaceString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canParse

public boolean canParse(java.lang.String nameString)
                 throws java.io.IOException,
                        AutomationException

Indicates if the given name string can be parsed by this parser.

Specified by:

canParse in interface IParseNameString

Parameters:

nameString - The nameString (in)

Returns:

The canParse

Throws:

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

AutomationException - If the ArcObject component throws an exception.

parse

public IName parse(java.lang.String nameString)
            throws java.io.IOException,
                   AutomationException

Parses the name string and returns a new Name object.

Specified by:

parse in interface IParseNameString

Parameters:

nameString - The nameString (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.