com.esri.arcgis.datasourcesfile

Class BimFileWorkspace

java.lang.Object

com.esri.arcgis.datasourcesfile.BimFileWorkspace

All Implemented Interfaces:

IDataset, IFeatureWorkspace, IWorkspace, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class BimFileWorkspace
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspace, IFeatureWorkspace, IDataset

COM Class 'BimFileWorkspace'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriDataSourcesFile.tlb'

Description 'Esri BIM File Workspace' 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.IWorkspace

IID, IIDd4803ee1_79f4_11d0_97fc_0080c7f79481, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureWorkspace

IID, IIDd9cab491_3f69_11d1_b095_0000f8780820, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDataset

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

Constructor Summary

Constructors

Constructor and Description
BimFileWorkspace() Constructs a BimFileWorkspace using ArcGIS Engine.
BimFileWorkspace(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. BimFileWorkspace theBimFileWorkspace = (BimFileWorkspace) obj;

Method Summary

Modifier and Type	Method and Description
boolean	canCopy() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
IDataset	copy(java.lang.String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
IFeatureClass	createFeatureClass(java.lang.String name, IFields fields, IUID cLSID, IUID eXTCLSID, int featureType, java.lang.String shapeFieldName, java.lang.String configKeyword) Creates a new standalone feature class under the workspace.
IFeatureDataset	createFeatureDataset(java.lang.String name, ISpatialReference spatialReference) Creates a new feature dataset.
IQueryDef	createQueryDef() Create a query definition object.
IRelationshipClass	createRelationshipClass(java.lang.String relClassName, IObjectClass originClass, IObjectClass destinationClass, java.lang.String forwardLabel, java.lang.String backwardLabel, int cardinality, int notification, boolean isComposite, boolean isAttributed, IFields relAttrFields, java.lang.String originPrimaryKey, java.lang.String destPrimaryKey, java.lang.String originForeignKey, java.lang.String destForeignKey) Creates a new relationship class.
ITable	createTable(java.lang.String name, IFields fields, IUID cLSID, IUID eXTCLSID, java.lang.String configKeyword) Creates a new table.
void	delete() Deletes this dataset.
boolean	equals(java.lang.Object o) Compare this object with another
void	executeSQL(java.lang.String sqlStmt) Executes the specified SQL statement.
boolean	exists() Checks if the workspace exists.
java.lang.String	getBrowseName() The browse name of the dataset.
java.lang.String	getCategory() The category of the dataset.
static java.lang.String	getClsid() getClsid.
IPropertySet	getConnectionProperties() The connection properties of the workspace.
IEnumDatasetName	getDatasetNames(int datasetType) The DatasetNames in the workspace.
IEnumDataset	getDatasets(int datasetType) The datasets in the workspace.
IName	getFullName() The associated name object.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getName() The name of the Dataset.
java.lang.String	getPathName() The file system full path of the workspace.
IPropertySet	getPropertySet() The set of properties for the dataset.
IEnumDataset	getSubsets() Datasets contained within this dataset.
int	getType() The Type of the Workspace.
IWorkspace	getWorkspace() The workspace containing this dataset.
IWorkspaceFactory	getWorkspaceFactory() The factory that created the workspace.
int	hashCode() the hashcode for this object
boolean	isDirectory() TRUE if the workspace is a file system directory.
IDataset	openExtensionDataset(int extensionDatasetType, java.lang.String extensionDatasetName) Opens an existing extension dataset.
IFeatureClass	openFeatureClass(java.lang.String name) Opens an existing feature class.
IFeatureDataset	openFeatureDataset(java.lang.String name) Opens an existing feature dataset.
IFeatureDataset	openFeatureQuery(java.lang.String queryName, IQueryDef queryDef) Opens a feature dataset containing a single feature class defined by the specified Query.
IRelationshipClass	openRelationshipClass(java.lang.String name) Opens an existing relationship class.
ITable	openRelationshipQuery(IRelationshipClass relClass, boolean joinForward, IQueryFilter srcQueryFilter, ISelectionSet srcSelectionSet, java.lang.String targetColumns, boolean doNotPushJoinToDB) The table of a relationship join query.
ITable	openTable(java.lang.String name) Opens an existing table.
void	release() Release this COM object reference
void	rename(java.lang.String name) Renames this Dataset.
void	setBrowseName(java.lang.String name) The browse name of the dataset.

Methods inherited from class java.lang.Object

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

Constructor Detail

BimFileWorkspace

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

Constructs a BimFileWorkspace using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

BimFileWorkspace

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

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

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

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

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getConnectionProperties

public IPropertySet getConnectionProperties()
                                     throws java.io.IOException,
                                            AutomationException

The connection properties of the workspace.

Specified by:

getConnectionProperties in interface IWorkspace

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.

getWorkspaceFactory

public IWorkspaceFactory getWorkspaceFactory()
                                      throws java.io.IOException,
                                             AutomationException

The factory that created the workspace.

Specified by:

getWorkspaceFactory in interface IWorkspace

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasets

public IEnumDataset getDatasets(int datasetType)
                         throws java.io.IOException,
                                AutomationException

The datasets in the workspace.

Specified by:

getDatasets in interface IWorkspace

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetNames

public IEnumDatasetName getDatasetNames(int datasetType)
                                 throws java.io.IOException,
                                        AutomationException

The DatasetNames in the workspace.

Specified by:

getDatasetNames in interface IWorkspace

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPathName

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

The file system full path of the workspace.

Specified by:

getPathName in interface IWorkspace

Returns:

The pathName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The Type of the Workspace.

Specified by:

getType in interface IDataset

Specified by:

getType in interface IWorkspace

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.

isDirectory

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

TRUE if the workspace is a file system directory.

Specified by:

isDirectory in interface IWorkspace

Returns:

The isDir

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exists

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

Checks if the workspace exists.

Specified by:

exists in interface IWorkspace

Returns:

The exists

Throws:

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

AutomationException - If the ArcObject component throws an exception.

executeSQL

public void executeSQL(java.lang.String sqlStmt)
                throws java.io.IOException,
                       AutomationException

Executes the specified SQL statement.

Specified by:

executeSQL in interface IWorkspace

Parameters:

sqlStmt - The sqlStmt (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openTable

public ITable openTable(java.lang.String name)
                 throws java.io.IOException,
                        AutomationException

Opens an existing table.

Specified by:

openTable in interface IFeatureWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createTable

public ITable createTable(java.lang.String name,
                          IFields fields,
                          IUID cLSID,
                          IUID eXTCLSID,
                          java.lang.String configKeyword)
                   throws java.io.IOException,
                          AutomationException

Creates a new table.

Specified by:

createTable in interface IFeatureWorkspace

Parameters:

name - The name (in)

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

cLSID - A reference to a com.esri.arcgis.system.IUID (in)

eXTCLSID - A reference to a com.esri.arcgis.system.IUID (in)

configKeyword - The configKeyword (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openFeatureClass

public IFeatureClass openFeatureClass(java.lang.String name)
                               throws java.io.IOException,
                                      AutomationException

Opens an existing feature class.

Specified by:

openFeatureClass in interface IFeatureWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFeatureClass

public IFeatureClass createFeatureClass(java.lang.String name,
                                        IFields fields,
                                        IUID cLSID,
                                        IUID eXTCLSID,
                                        int featureType,
                                        java.lang.String shapeFieldName,
                                        java.lang.String configKeyword)
                                 throws java.io.IOException,
                                        AutomationException

Creates a new standalone feature class under the workspace.

Specified by:

createFeatureClass in interface IFeatureWorkspace

Parameters:

name - The name (in)

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

cLSID - A reference to a com.esri.arcgis.system.IUID (in)

eXTCLSID - A reference to a com.esri.arcgis.system.IUID (in)

featureType - A com.esri.arcgis.geodatabase.esriFeatureType constant (in)

shapeFieldName - The shapeFieldName (in)

configKeyword - The configKeyword (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openFeatureDataset

public IFeatureDataset openFeatureDataset(java.lang.String name)
                                   throws java.io.IOException,
                                          AutomationException

Opens an existing feature dataset.

Specified by:

openFeatureDataset in interface IFeatureWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFeatureDataset

public IFeatureDataset createFeatureDataset(java.lang.String name,
                                            ISpatialReference spatialReference)
                                     throws java.io.IOException,
                                            AutomationException

Creates a new feature dataset.

Specified by:

createFeatureDataset in interface IFeatureWorkspace

Parameters:

name - The name (in)

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createQueryDef

public IQueryDef createQueryDef()
                         throws java.io.IOException,
                                AutomationException

Create a query definition object.

Specified by:

createQueryDef in interface IFeatureWorkspace

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openFeatureQuery

public IFeatureDataset openFeatureQuery(java.lang.String queryName,
                                        IQueryDef queryDef)
                                 throws java.io.IOException,
                                        AutomationException

Opens a feature dataset containing a single feature class defined by the specified Query.

Specified by:

openFeatureQuery in interface IFeatureWorkspace

Parameters:

queryName - The queryName (in)

queryDef - A reference to a com.esri.arcgis.geodatabase.IQueryDef (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openRelationshipClass

public IRelationshipClass openRelationshipClass(java.lang.String name)
                                         throws java.io.IOException,
                                                AutomationException

Opens an existing relationship class.

Specified by:

openRelationshipClass in interface IFeatureWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRelationshipClass

public IRelationshipClass createRelationshipClass(java.lang.String relClassName,
                                                  IObjectClass originClass,
                                                  IObjectClass destinationClass,
                                                  java.lang.String forwardLabel,
                                                  java.lang.String backwardLabel,
                                                  int cardinality,
                                                  int notification,
                                                  boolean isComposite,
                                                  boolean isAttributed,
                                                  IFields relAttrFields,
                                                  java.lang.String originPrimaryKey,
                                                  java.lang.String destPrimaryKey,
                                                  java.lang.String originForeignKey,
                                                  java.lang.String destForeignKey)
                                           throws java.io.IOException,
                                                  AutomationException

Creates a new relationship class.

Specified by:

createRelationshipClass in interface IFeatureWorkspace

Parameters:

relClassName - The relClassName (in)

originClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)

destinationClass - A reference to a com.esri.arcgis.geodatabase.IObjectClass (in)

forwardLabel - The forwardLabel (in)

backwardLabel - The backwardLabel (in)

cardinality - A com.esri.arcgis.geodatabase.esriRelCardinality constant (in)

notification - A com.esri.arcgis.geodatabase.esriRelNotification constant (in)

isComposite - The isComposite (in)

isAttributed - The isAttributed (in)

relAttrFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

originPrimaryKey - The originPrimaryKey (in)

destPrimaryKey - The destPrimaryKey (in)

originForeignKey - The originForeignKey (in)

destForeignKey - The destForeignKey (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openRelationshipQuery

public ITable openRelationshipQuery(IRelationshipClass relClass,
                                    boolean joinForward,
                                    IQueryFilter srcQueryFilter,
                                    ISelectionSet srcSelectionSet,
                                    java.lang.String targetColumns,
                                    boolean doNotPushJoinToDB)
                             throws java.io.IOException,
                                    AutomationException

The table of a relationship join query.

Specified by:

openRelationshipQuery in interface IFeatureWorkspace

Parameters:

relClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

joinForward - The joinForward (in)

srcQueryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

srcSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

targetColumns - The targetColumns (in)

doNotPushJoinToDB - The doNotPushJoinToDB (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openExtensionDataset

public IDataset openExtensionDataset(int extensionDatasetType,
                                     java.lang.String extensionDatasetName)
                              throws java.io.IOException,
                                     AutomationException

Opens an existing extension dataset.

Specified by:

openExtensionDataset in interface IFeatureWorkspace

Parameters:

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

extensionDatasetName - The extensionDatasetName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the Dataset.

Specified by:

getName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

public IName getFullName()
                  throws java.io.IOException,
                         AutomationException

The associated name object.

Specified by:

getFullName in interface IDataset

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.

getBrowseName

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

The browse name of the dataset.

Specified by:

getBrowseName in interface IDataset

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrowseName

public void setBrowseName(java.lang.String name)
                   throws java.io.IOException,
                          AutomationException

The browse name of the dataset.

Specified by:

setBrowseName in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

The category of the dataset.

Specified by:

getCategory in interface IDataset

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsets

public IEnumDataset getSubsets()
                        throws java.io.IOException,
                               AutomationException

Datasets contained within this dataset.

Specified by:

getSubsets in interface IDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspace

public IWorkspace getWorkspace()
                        throws java.io.IOException,
                               AutomationException

The workspace containing this dataset.

Specified by:

getWorkspace in interface IDataset

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.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException

The set of properties for the dataset.

Specified by:

getPropertySet in interface IDataset

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.

canCopy

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

True if this dataset can be copied.

Specified by:

canCopy in interface IDataset

Returns:

The canCopy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

public IDataset copy(java.lang.String copyName,
                     IWorkspace copyWorkspace)
              throws java.io.IOException,
                     AutomationException

Copies this dataset to a new dataset with the specified name.

Specified by:

copy in interface IDataset

Parameters:

copyName - The copyName (in)

copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canDelete

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

True if this dataset can be deleted.

Specified by:

canDelete in interface IDataset

Returns:

The canDelete

Throws:

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

AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException

Deletes this dataset.

Specified by:

delete in interface IDataset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRename

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

True if this dataset can be renamed.

Specified by:

canRename in interface IDataset

Returns:

The canRename

Throws:

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

AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Renames this Dataset.

Specified by:

rename in interface IDataset

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.