com.esri.arcgis.geodatabase
Class IWorkspacePropertiesProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IWorkspacePropertiesProxy

All Implemented Interfaces:

IWorkspaceProperties, Externalizable, Serializable

Direct Known Subclasses:

IWorkspaceProperties2Proxy

public class IWorkspacePropertiesProxy
extends com.esri.arcgis.interop.Dispatch
implements IWorkspaceProperties, Serializable

Provides access to members that control the workspace properties.

Superseded By

IWorkspaceProperties2

Remarks

A workspace may have a set of properties that may be queried using the optional IWorkspaceProperties interface. Two groups of workspace properties exist, the workspace property group and the table property group. Both groups have values in the esriWorkspacePropertyGroupType enumeration, which should be passed to the propertyGroup parameter of this property to indicate which group is being accessed.

The PropertyType parameter should be a value from one of two enumerations, depending on which property group is desired. If the esriWorkspacePropertyGroup value is passed in as the propertyGroup parameter, a value from the esriWorkspacePropertyType enumeration should be passed in as the PropertyType parameter. If the esriWorkspaceTablePropertyGroup value is passed in as the propertyGroup parameter, a value from the esriWorkspaceTablePropertyType enumeration should be passed in as the PropertyType parameter.

Note that the PropertyType parameter expects a long integer. This is because a value from either the esriWorkspacePropertyType enumeration or the esriWorkspaceTablePropertyType enumeration may be used. In some languages (for example, C#) it is necessary to cast these enumerations' values to integers when passing them to the Property property. See the C# example associated with this interface for more on this.

Some of the properties of workspace property group include:

• WorkspacePropCanExecuteSQL: True if the workspace supports the IWorkspace::ExecuteSQLmethod. Note that all feature workspaces accept some form of SQL where clause.
• WorkspacePropCanEdit: True if the workspace supports edit sessions that are managed with the IWorkspaceEditinterface.
• WorkspacePropIsReadonly: True if the workspace cannot be updated.
• WorkspacePropSupportsQualifiedNames: True if the workspace supports qualified names.
• WorkspacePropSupportsMetadata: True if the workspace supports user metadata accessed via the IMetadata interface and exposed to the user in ArcCatalog.
• WorkspacePropCanAnalyze: True if the workspace supports the Analyzemethod on tables in the workspace.
• WorkspacePropCanGetConfigurationKeywords: True if the geodatabase is stored in an ArcSDE 8.1 or higher database or File Geodatabase, in which case that database is aware and can return its configuration keywords via the IWorkspaceConfiguration::ConfigurationKeywordsmethod.
• WorkspacePropIsGeoDatabase: True is the workspace is a geodatabase.
• WorkspacePropMaxWhereClauseLength: Returns the maximum length of the where clause supported by the workspace for use in queries.

Some of the properties in the table property group include:

• TablePropRowCountIsCalculated: True if the ITable::RowCountmethod requires calculation, that is, True if getting the row count is an expensive operation.
• TablePropCanAddField: True if this workspace supports adding fields to tables. Note that if True, the ITable::AddFieldmethod may still fail on specific tables, for example because of a lack of privileges.
• TablePropCanDeleteField: True if this workspace supports deleting fields from tables. The method may still fail on a specific table, for example because of a lack of privileges.
• TablePropCanAddIndex: True if this workspace supports adding indexes to tables. The method may still fail on a specific table, for example because of a lack of privileges.
• TablePropCanDeleteIndex: True if this workspace supports deleting indexes for tables. The method may still fail on a specific table, for example because of a lack of privileges.
• TablePropOIDIsRecordNumber: True if the OID for rows from this table is the record number of the row. This implies that OIDs are continuous.
• TablePropMaxFieldNameLength: Returns the maximum length of field names supported by this workspace.
• TablePropBindCursor: True if this table has support for bind cursors.

Applications can use the above properties to determine the capability of the workspace they are working with. Note that if the optional IWorkspaceProperties interface is not implemented, applications should assume that the above capabilities are supported. Applications should always be prepared to deal with the absence of optional interfaces or with failure when executing methods on mandatory interfaces, for example because of privileges or licensing issues.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IWorkspacePropertiesProxy()
	IWorkspacePropertiesProxy(Object obj)
protected	IWorkspacePropertiesProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
IWorkspaceProperty	getProperty(int propertyGroup, int propertyType) Information about this particular property.
void	removeListener(String iidStr, Object theListener)
void	setProperty(int propertyGroup, int propertyType, IWorkspaceProperty workspaceProperty) Information about this particular property.

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

noncastable

public boolean noncastable

Constructor Detail

IWorkspacePropertiesProxy

public IWorkspacePropertiesProxy()

IWorkspacePropertiesProxy

public IWorkspacePropertiesProxy(Object obj)
                          throws IOException

Throws:

IOException

IWorkspacePropertiesProxy

protected IWorkspacePropertiesProxy(Object obj,
                                    String iid)
                             throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getProperty

public IWorkspaceProperty getProperty(int propertyGroup,
                                      int propertyType)
                               throws IOException,
                                      AutomationException

Information about this particular property.

Product Availability

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

Specified by:

getProperty in interface IWorkspaceProperties

Parameters:

propertyGroup - A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)

propertyType - The propertyType (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(int propertyGroup,
                        int propertyType,
                        IWorkspaceProperty workspaceProperty)
                 throws IOException,
                        AutomationException

Information about this particular property.

Product Availability

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

Specified by:

setProperty in interface IWorkspaceProperties

Parameters:

propertyGroup - A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)

propertyType - The propertyType (in)

workspaceProperty - A reference to a com.esri.arcgis.geodatabase.IWorkspaceProperty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.