|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.interop.Dispatch com.esri.arcgis.geodatabase.IPlugInWorkspaceFactoryHelperProxy
Description: 'Provides access to members that help the Plug-In 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 =
public class IPlugInWorkspaceFactoryHelperProxy
Internal use class
Field Summary | |
---|---|
boolean |
noncastable
Deprecated. |
static java.lang.Class |
targetClass
Deprecated. |
Fields inherited from class com.esri.arcgis.interop.Dispatch |
---|
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef |
Constructor Summary | |
---|---|
|
IPlugInWorkspaceFactoryHelperProxy()
Deprecated. For internal use only |
|
IPlugInWorkspaceFactoryHelperProxy(java.lang.Object obj)
Deprecated. |
protected |
IPlugInWorkspaceFactoryHelperProxy(java.lang.Object obj,
java.lang.String iid)
Deprecated. |
|
IPlugInWorkspaceFactoryHelperProxy(java.lang.String CLSID,
java.lang.String host,
com.esri.arcgis.interop.AuthInfo authInfo)
Deprecated. |
protected |
IPlugInWorkspaceFactoryHelperProxy(java.lang.String CLSID,
java.lang.String iid,
java.lang.String host,
com.esri.arcgis.interop.AuthInfo authInfo)
Deprecated. |
Method Summary | |
---|---|
void |
addListener(java.lang.String iidStr,
java.lang.Object theListener,
java.lang.Object theSource)
Deprecated. |
boolean |
containsWorkspace(java.lang.String parentDirectory,
IFileNames fileNames)
Deprecated. Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace. |
java.lang.String |
getDatasetDescription(int datasetType)
Deprecated. A desription of a detaset of the type specified. |
java.lang.String |
getDataSourceName()
Deprecated. The name of the data source. |
java.lang.String |
getWorkspaceDescription(boolean plural)
Deprecated. A singular or plural description of the type of workspace the workspace factory opens. |
IUID |
getWorkspaceFactoryTypeID()
Deprecated. The class ID which is registered in the WorkspaceFactory category. |
java.lang.String |
getWorkspaceString(java.lang.String parentDirectory,
IFileNames fileNames)
Deprecated. If parentDirectory is or contains a valid workspace, gets a string uniquely identifying that workspace. |
int |
getWorkspaceType()
Deprecated. The type of workspace the workspace factory opens. |
boolean |
isCanSupportSQL()
Deprecated. Indicates whether datasets of this type can process SQL queries. |
boolean |
isWorkspace(java.lang.String wksString)
Deprecated. Tests if the workspace string represents a valid workspace. |
IPlugInWorkspaceHelper |
openWorkspace(java.lang.String wksString)
Deprecated. Opens a workspace helper for the workspace identified by the workspace string. |
void |
removeListener(java.lang.String iidStr,
java.lang.Object theListener)
Deprecated. |
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 |
---|
public static final java.lang.Class targetClass
public boolean noncastable
Constructor Detail |
---|
public IPlugInWorkspaceFactoryHelperProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) throws java.net.UnknownHostException, java.io.IOException
java.net.UnknownHostException
java.io.IOException
public IPlugInWorkspaceFactoryHelperProxy()
public IPlugInWorkspaceFactoryHelperProxy(java.lang.Object obj) throws java.io.IOException
java.io.IOException
protected IPlugInWorkspaceFactoryHelperProxy(java.lang.Object obj, java.lang.String iid) throws java.io.IOException
java.io.IOException
protected IPlugInWorkspaceFactoryHelperProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) throws java.io.IOException
java.io.IOException
Method Detail |
---|
public void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) throws java.io.IOException
addListener
in class com.esri.arcgis.interop.Dispatch
java.io.IOException
public void removeListener(java.lang.String iidStr, java.lang.Object theListener) throws java.io.IOException
removeListener
in class com.esri.arcgis.interop.Dispatch
java.io.IOException
public java.lang.String getDataSourceName() throws java.io.IOException, AutomationException
The DataSourceName property returns the name of the plug-in data source.
getDataSourceName
in interface IPlugInWorkspaceFactoryHelper
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDatasetDescription(int datasetType) throws java.io.IOException, AutomationException
getDatasetDescription
in interface IPlugInWorkspaceFactoryHelper
datasetType
- A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getWorkspaceDescription(boolean plural) throws java.io.IOException, AutomationException
getWorkspaceDescription
in interface IPlugInWorkspaceFactoryHelper
plural
- The plural (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getWorkspaceFactoryTypeID() throws java.io.IOException, AutomationException
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.
getWorkspaceFactoryTypeID
in interface IPlugInWorkspaceFactoryHelper
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getWorkspaceType() throws java.io.IOException, AutomationException
getWorkspaceType
in interface IPlugInWorkspaceFactoryHelper
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCanSupportSQL() throws java.io.IOException, AutomationException
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.
isCanSupportSQL
in interface IPlugInWorkspaceFactoryHelper
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isWorkspace(java.lang.String wksString) throws java.io.IOException, AutomationException
Takes a workspace string, and determines if it refers to an actual workspace. Should return true if OpenWorkspace is expected to succeed for this workspace string.
isWorkspace
in interface IPlugInWorkspaceFactoryHelper
wksString
- The wksString (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean containsWorkspace(java.lang.String parentDirectory, IFileNames fileNames) throws java.io.IOException, AutomationException
If fileNames is null, returns IsWorkspace for this parentDirectory. If fileNames is not null, returns true if the parentDirectory, which contains the files and folders listed in fileNames, contains a workspace of this type.
File-based data sources: True if any of the files in fileNames are datasets of this type.
Folder-based data sources: True if any of the folders in fileNames are datasets of this type.
Database data sources: True if any of the files in fileNames are workspaces of this type or connection files to workspaces of this type.
containsWorkspace
in interface IPlugInWorkspaceFactoryHelper
parentDirectory
- The parentDirectory (in)fileNames
- A reference to a com.esri.arcgis.system.IFileNames (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getWorkspaceString(java.lang.String parentDirectory, IFileNames fileNames) throws java.io.IOException, AutomationException
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.
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.
getWorkspaceString
in interface IPlugInWorkspaceFactoryHelper
parentDirectory
- The parentDirectory (in)fileNames
- A reference to a com.esri.arcgis.system.IFileNames (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPlugInWorkspaceHelper openWorkspace(java.lang.String wksString) throws java.io.IOException, AutomationException
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.
openWorkspace
in interface IPlugInWorkspaceFactoryHelper
wksString
- The wksString (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |