Class BimFileWorkspaceClass
- Namespace
- ESRI.ArcGIS.DatasourcesFile
- Assembly
- ESRI.Server.DatasourcesFile.dll
[Guid("7BB800C6-89A9-413C-9CC4-796EB51DCD97")]
[ClassInterface(ClassInterfaceType.None)]
public class BimFileWorkspaceClass : BimFileWorkspace, IWorkspace, IFeatureWorkspace, IDataset
- Inheritance
-
BimFileWorkspaceClass
- Implements
- Inherited Members
Constructors
BimFileWorkspaceClass()
public BimFileWorkspaceClass()
Explicit Interface Implementations
BrowseName
The browse name of the dataset.
virtual string BrowseName { get; set; }
Returns
Remarks
CanCopy()
True if this dataset can be copied.
virtual bool CanCopy()
Returns
Remarks
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
The CanCopy method is supported by:
- CAD Drawings
- Coverages
- DBase Tables
- Info Tables
- Raster Datasets
- SDC datasets
- SDC Network Datasets
- Shapefiles
- Shapefile Network Datasets
CanDelete()
True if this dataset can be deleted.
virtual bool CanDelete()
Returns
Remarks
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
CanRename()
True if this dataset can be renamed.
virtual bool CanRename()
Returns
Remarks
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
Category
The category of the dataset.
virtual string Category { get; }
Returns
Remarks
IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".
The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.
ConnectionProperties
The connection properties of the workspace.
virtual IPropertySet ConnectionProperties { get; }
Returns
Remarks
The ConnectionProperties property of a workspace returns the set of named connection properties for this workspace.
Copy(string, IWorkspace)
Copies this dataset to a new dataset with the specified name.
virtual IDataset Copy(string copyName, IWorkspace copyWorkspace)
Parameters
copyNamestringcopyWorkspaceIWorkspace
Returns
Remarks
IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.
CreateFeatureClass(string, IFields, UID, UID, esriFeatureType, string, string)
Creates a new standalone feature class under the workspace.
virtual IFeatureClass CreateFeatureClass(string Name, IFields Fields, UID CLSID, UID EXTCLSID, esriFeatureType FeatureType, string ShapeFieldName, string ConfigKeyword)
Parameters
NamestringFieldsIFieldsCLSIDUIDEXTCLSIDUIDFeatureTypeesriFeatureTypeShapeFieldNamestringConfigKeywordstring
Returns
Remarks
The CreateFeatureClass method can be used to create a stand-alone feature class that is not part of a feature dataset. It takes, in addition to all the parameters that CreateTable takes, an esriFeatureType parameter that specifies the category of features to be stored in this feature class (i.e., esriFTSimple, esriFTComplexEdgeFeature) and a shape field name. The shape field name identifies the name of the field in the input fields collection that represents the shape field for the feature class.
The Fields object passed to the Fields parameter should not be an object retrieved from another class. If the new class is going to have the same fields as an existing class, cast the existing class' fields collection to the IClone interface, clone it, and use the cloned fields collection as input for this method.
The GeometryDef object associated with the shape field object must be fully setup with a spatial reference, grid properties, and the geometry type before calling CreateFeatureClass.
The following esriGeometryType enumeration values represent the valid geometry types for a new feature class' GeometryDef object: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, and esriGeometryMultiPatch.
If the feature class is being created in geodatabase then the fields collection must contain, at a minimum, an Object ID field and a Shape field. The required fields can be obtained from the class description for the type of object you wish to create (see the RequiredFields property on IObjectClassDescription).
The CLSID parameter is used to specify what type of feature will be contained by the class. If a null value is passed in for the CLSID, the geodatabase will return Feature instances from the class. In most cases, this is the desired behavior. If the feature class is used to store custom features, the GUID of the custom feature should be provided. Alternatively, the IClassSchemaEdit interface can be used to change the feature class' CLSID following creation.
The EXTCLSID parameter is used to specify what class will be instantiated as the feature class extension. This object must at least support the IClassExtension interface. If a null value is passed in for the EXTCLSID parameter, the feature class will not have a class extension associated with it. Since class extensions are not required, this is often the desired behavior. If the feature class should have an associated extension, the GUID of the class extension should be provided. Alternatively, the IClassSchemaEdit interface can be used to associate a class extension following creation.
The configurationKeywordparameter allows the application to control the physical layout for this table in the underlying RDBMS. For example, in the case of an Oracle database, the configuration keyword controls the tablespace in which the table is created, the initial and next extents, and other properties. The configuration keywords for an ArcSDE instance are set up by the ArcSDE data administrator, and the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfigurationinterface.
If the workspace the feature class will be created in is a pre-9.2 geodatabase, you must ensure the GeometryDef references a low precision spatial reference. 9.1 and earlier versions of the geodatabase only support low precision spatial references, while 9.2 geodatabases require high precision spatial references. Use IControlPrecision2::IsHighPrecision to manage the precision level of the spatial reference used to create the feature class. Use the IGeodatabaseRelease interface to determine the release of the geodatabase.
Developers should be aware that calling this method on a shapefile workspace when a shapefile of the same name already exists will cause the existing shapefile to be deleted. To prevent this, check for the existence of a shapefile prior to calling this method.
Note:Table or feature class names with the following prefixes are not supported:
~ "gdb_"
~ "sde_"
~ "delta_"
CreateFeatureDataset(string, ISpatialReference)
Creates a new feature dataset.
virtual IFeatureDataset CreateFeatureDataset(string Name, ISpatialReference SpatialReference)
Parameters
NamestringSpatialReferenceISpatialReference
Returns
Remarks
The CreateFeatureDataset method can be used to create a new FeatureDataset given its name and spatial reference. Methods supported by the returned feature dataset allow creation of feature classes in the feature dataset.
If the workspace the FeatureDataset will be created in is a pre-9.2 Geodatabase, you must ensure the spatial reference is a low precision spatial reference. 9.1 and earlier versions of the Geodatabase only support low precision spatial references, while 9.2 Geodatabases require high precision spatial references. Use IControlPrecision2::IsHighPrecision to manage the precision level of the spatial reference used to create the FeatureDataset. Use the IGeodatabaseRelease interface to determine the release of the geodatabase
CreateQueryDef()
Create a query definition object.
virtual IQueryDef CreateQueryDef()
Returns
Remarks
The CreateQueryDef method can be used to create a new query definition object that can be evaluated by returning a cursor.
With personal geodatabases, QueryDefs do not return newly inserted rows, within an edit session when the QueryDef contains a Where Clause. The edits must be saved and the QueryDef executed outside of the edit session or Search must be used to return the information.
CreateRelationshipClass(string, IObjectClass, IObjectClass, string, string, esriRelCardinality, esriRelNotification, bool, bool, IFields, string, string, string, string)
Creates a new relationship class.
virtual IRelationshipClass CreateRelationshipClass(string relClassName, IObjectClass OriginClass, IObjectClass DestinationClass, string ForwardLabel, string BackwardLabel, esriRelCardinality Cardinality, esriRelNotification Notification, bool IsComposite, bool IsAttributed, IFields relAttrFields, string OriginPrimaryKey, string destPrimaryKey, string OriginForeignKey, string destForeignKey)
Parameters
relClassNamestringOriginClassIObjectClassDestinationClassIObjectClassForwardLabelstringBackwardLabelstringCardinalityesriRelCardinalityNotificationesriRelNotificationIsCompositeboolIsAttributedboolrelAttrFieldsIFieldsOriginPrimaryKeystringdestPrimaryKeystringOriginForeignKeystringdestForeignKeystring
Returns
Remarks
The CreateRelationshipClass method can be used to create a new stand-alone relationship class that is not part of a feature dataset. The relationship class is implemented as a separate data table whose name is the name of the relationship class if the cardinality is many-to-many or if the relationship class is attributed. The relAttribFields parameter is optional, and a null value may be passed in for non-attributed relationship classes.
Many-to-many or attributed relationship classes require specification of all four key fields—the OriginPrimaryKey and the destPrimaryKey parameters are the primary key fields for the origin and destination object classes. The OriginForeignKey and destForeignKey parameters are the names of the corresponding foreign keys that will be created in the data table representing the relationship class. If the relationship class is one-to-one or one-to-many and not attributed, then the relationship class is implemented as a foreign key field in the destination object class (the OriginForeignKey) that references the primary key field in the origin object class (the OriginPrimaryKey). In this case, the OriginPrimaryKey, the OriginForeignKey, and the destPrimaryKey must be supplied.
The Fields object passed to the relAttrFields parameter should not be an object retrieved from another class. If the new class is going to have the same fields as an existing class, cast the existing class' fields collection to the IClone interface, clone it, and use the cloned fields collection as input for this method.
CreateTable(string, IFields, UID, UID, string)
Creates a new table.
virtual ITable CreateTable(string Name, IFields Fields, UID CLSID, UID EXTCLSID, string ConfigKeyword)
Parameters
Returns
Remarks
The CreateTable method can be used to create a new table or object class in the workspace.
The optional CLSID and EXTCLSID parameters allow the calling application to specify the GUIDs for the objects that implement the instance and the class extension behavior for an object class. If no CLSID is passed in, then the resulting table is not registered in the geodatabase object class data dictionary (It will support the IObjectClass interface but will have an ObjectClassID of –1). Valid values for CLSID are esriGeoDatabase.Object or any non-spatial object that extends esriGeoDatabase.Object. CLSID must be set in order to apply a class extension with the EXTCLSID parameter.
The Fields object passed to the Fields parameter should not be an object retrieved from another class. If the new class is going to have the same fields as an existing class, cast the existing class' fields collection to the IClone interface, clone it, and use the cloned fields collection as input for this method.
The optional configurationKeyword parameter allows the application to control the physical layout for this table in the underlying RDBMS. For example, in an Oracle database, the configuration keyword controls the tablespace in which the table is created, the initial and next extents, and other properties. The configuration keywords for an ArcSDE instance are set up by the ArcSDE data administrator, the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfiguration interface.
Note: Table or feature class names with the following prefixes are not supported:
- "gdb_"
- "sde_"
- "delta_"
DatasetNames[esriDatasetType]
The DatasetNames in the workspace.
virtual IEnumDatasetName DatasetNames[esriDatasetType DatasetType] { get; }
Parameters
DatasetTypeesriDatasetType
Returns
Remarks
The DatasetNames method returns an enumerator over the dataset names in the workspace for the specified dataset type. Name objects are lightweight versions of the geodatabase objects they refer to, while still providing access to some of the properties/methods available in the geodatabase object. From a name object, an instance of the geodatabase object specified by the name object can be created/returned, and vice versa.
See esriDatasetType for more information on dataset types.
Browsing applications should use the DatasetNames method to obtain name objects. These dataset name objects contain the essential properties of the corresponding dataset objects and are faster to retrieve. If the actual dataset specified by a name object is required (for example, because the user selected it), then it can easily be instantiated by calling the Open method on the name object.
Using a dataset type of esriDTAny will return all the datasets or dataset names in the workspace, across all dataset types. Note that these methods return only the top-level datasets in the workspace. In particular, if a workspace contains both stand-alone feature classes and additional feature classes that are part of a feature dataset, then calling the DatasetNames property on the workspace with a dataset type of esriDTFeatureClass will return only the standalone feature classes. To get the feature class names within a feature dataset, the application needs to get the FeatureClassNames property on the top-level feature dataset name returned by the workspace.
Datasets[esriDatasetType]
The datasets in the workspace.
virtual IEnumDataset Datasets[esriDatasetType DatasetType] { get; }
Parameters
DatasetTypeesriDatasetType
Returns
Remarks
The Datasets method returns an enumerator over the datasets in the workspace of the specified dataset type. Not to be confused with DatasetNames, Datasets will return a fully hydrated dataset object.
See esriDatasetType for more information on dataset types.
Using a dataset type of esriDTAny will return all the datasets or datasets in the workspace, across all dataset types. Note that only the top-level datasets in the workspace are returned by these methods. In particular, if a workspace contains both stand-alone feature classes and additional feature classes that are part of a feature dataset, then calling the Datasets property on the workspace with a dataset type of esriDTFeatureClass will return only the standalone feature classes.
Delete()
Deletes this dataset.
virtual void Delete()
Remarks
Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
ExecuteSQL(string)
Executes the specified SQL statement.
virtual void ExecuteSQL(string sqlStmt)
Parameters
sqlStmtstring
Remarks
The ExecuteSQL method can be used to send an arbitrary SQL statement to the underlying database for execution. The statement can be any DDL (data definition language) or DML (data manipulation language) statement but can not return any result sets. The syntax for the SQL is as required by the underlying database. The workspace supports an optional ISQLSyntax interface that provides information to applications on aspects of the SQL Syntax for the underlying database.
To determine if a workspace supports the ExecutesSQL method, an application can check the value of the canExecuteSQLworkspace property via the optional IWorkspaceProperties interface. In general, this method is only supported on local and remote database workspaces.
Exists()
Checks if the workspace exists.
virtual bool Exists()
Returns
Remarks
This method can be used with workspaces from file-based data sources to detect if they've been deleted by another application. For example, a shapefile workspace is a directory and can be deleted while the workspace is open.
FullName
The associated name object.
virtual IName FullName { get; }
Returns
Remarks
IDataset_Type
The type of the Dataset.
virtual esriDatasetType IDataset_Type { get; }
Returns
Remarks
IsDirectory()
TRUE if the workspace is a file system directory.
virtual bool IsDirectory()
Returns
Name
The name of the Dataset.
virtual string Name { get; }
Returns
OpenExtensionDataset(esriDatasetType, string)
Opens an existing extension dataset.
virtual IDataset OpenExtensionDataset(esriDatasetType extensionDatasetType, string extensionDatasetName)
Parameters
extensionDatasetTypeesriDatasetTypeextensionDatasetNamestring
Returns
OpenFeatureClass(string)
Opens an existing feature class.
virtual IFeatureClass OpenFeatureClass(string Name)
Parameters
Namestring
Returns
Remarks
The OpenFeatureClass method can be used to open any existing feature class in the workspace given its fully qualified name. Note that every feature class in a geodatabase has a unique fully qualified name, and the OpenFeatureClass method can be used to directly open feature classes that are part of a feature dataset (the feature dataset name does not need to be specified).
Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable). ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a feature class. Use the NameExists method on the IWorkspace2 interface to determine if a feature class with the appropriate name exists in a geodatabase.
Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.
For Coverage feature classes:
buildings:polygon
gdb.Buildings
OpenFeatureDataset(string)
Opens an existing feature dataset.
virtual IFeatureDataset OpenFeatureDataset(string Name)
Parameters
Namestring
Returns
Remarks
The OpenFeatureDataset method can be used to open any existing feature dataset in the workspace given its fully qualified name.
Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable). ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a feature dataset.
OpenFeatureQuery(string, IQueryDef)
Opens a feature dataset containing a single feature class defined by the specified Query.
virtual IFeatureDataset OpenFeatureQuery(string QueryName, IQueryDef QueryDef)
Parameters
Returns
Remarks
The OpenFeatureQuery can be used to open a virtual feature class whose definition is based on a QueryDef created using the CreateQueryDef method. The QueryDef can involve multiple tables as long as one of them is a feature class; the resulting virtual feature class can be used to construct a feature layer that can be added to a map. The shape column is required as part of the SubFields parameter of the QueryDef.
OpenRelationshipClass(string)
Opens an existing relationship class.
virtual IRelationshipClass OpenRelationshipClass(string Name)
Parameters
Namestring
Returns
Remarks
The OpenRelationshipClass method can be used to open any existing relationship class in the workspace given its fully qualified name.
Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable). ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a relationship class.
OpenRelationshipQuery(IRelationshipClass, bool, IQueryFilter, ISelectionSet, string, bool)
The table of a relationship join query.
virtual ITable OpenRelationshipQuery(IRelationshipClass relClass, bool joinForward, IQueryFilter SrcQueryFilter, ISelectionSet SrcSelectionSet, string TargetColumns, bool DoNotPushJoinToDB)
Parameters
relClassIRelationshipClassjoinForwardboolSrcQueryFilterIQueryFilterSrcSelectionSetISelectionSetTargetColumnsstringDoNotPushJoinToDBbool
Returns
OpenTable(string)
Opens an existing table.
virtual ITable OpenTable(string Name)
Parameters
Namestring
Returns
Remarks
For Coverage feature classes:
cover:feature("stream:arc")
cover:feature("stream.aat")
gdb.Owners
PathName
The file system full path of the workspace.
virtual string PathName { get; }
Returns
Remarks
PropertySet
The set of properties for the dataset.
virtual IPropertySet PropertySet { get; }
Returns
Remarks
Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.
IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.
Rename(string)
Renames this Dataset.
virtual void Rename(string Name)
Parameters
Namestring
Remarks
IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.
Subsets
Datasets contained within this dataset.
virtual IEnumDataset Subsets { get; }
Returns
Remarks
IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.
Type
The Type of the Workspace.
virtual esriWorkspaceType Type { get; }
Returns
Remarks
Workspace
The workspace containing this dataset.
virtual IWorkspace Workspace { get; }
Returns
Remarks
<p>A Workspace is a container of spatial and non-spatial datasets such as feature classes, raster datasets, and tables. It provides methods to instantiate existing datasets and to create new datasets. Workspaces are classified into types specified by the <b><a href="esriWorkspaceType.htm">esriWorkspaceType</a></b> enumerator: FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace. Shapefiles and ArcGIS for Desktop Advanced workspaces are examples of FileSystemWorkspace. A personal geodatabase stored in an Access or a File Geodatabase is an example of a LocalDatabaseWorkspace. A geodatabase stored in an RDBMS such as Oracle, DB2, SQL Server, or Informix and accessed via ArcSDE is an example of a RemoteDatabaseWorkspace.</p> <p>A Workspace hands out a <b><a href="WorkspaceName.htm">WorkspaceName</a> </b>object as the value of its FullName property. For example, the WorkspaceName for a workspace can be persisted in a map document. An application can call the <b>Open()</b> method on the workspace name after loading it from persistent storage to connect to and get an object reference to the workspace.</p>
WorkspaceFactory
The factory that created the workspace.
virtual IWorkspaceFactory WorkspaceFactory { get; }
Returns
Remarks
<CODE> <P>A WorkspaceFactory is a dispenser of workspaces and allows a client to connect to a workspace specified by a set of connection properties. A workspace represents a database or a datasource that contains one or more datasets. Examples of datasets include tables, feature classes and relationship classes. A WorkspaceFactory is a cocreatable, singleton object. A WorkspaceFactory maintains a pool of currently connected, active workspaces that are being referenced by the application. Connection properties are specified using a PropertySet object and can be saved to a connection file. A WorkspaceFactory also supports methods that can be used to browse and manage file system workspaces, and methods to manage connection files for remote database workspaces.</P></CODE>