Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geodatabase
Class Workspace

java.lang.Object
  extended by com.esri.arcgis.geodatabase.Workspace
All Implemented Interfaces:
IDatabaseCompact, IDatabaseConnectionInfo, IDataset, IDatasetContainer, IFeatureWorkspace, IFeatureWorkspaceAnno, IFeatureWorkspaceManage, IFeatureWorkspaceSchemaEdit, IGeodatabaseRelease, IRasterWorkspaceEx, ISpatialCacheManager, ISpatialCacheManager2, ISQLSyntax, ITopologyWorkspace, ITransactions, ITransactionsOptions, IWorkspace, IWorkspace2, IWorkspaceConfiguration, IWorkspaceDomains, IWorkspaceDomains2, IWorkspaceDomains3, IWorkspaceEdit, IWorkspaceEditControl, IWorkspaceExtensionManager, IWorkspaceReplicaDatasets, IWorkspaceReplicas, IWorkspaceReplicasAdmin, IWorkspaceReplicasAdmin2, IWorkspaceReplicasAdmin3, IWorkspaceSpatialReferenceInfo, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable
public class Workspace
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspace, IWorkspace2, IDataset, IDatasetContainer, IWorkspaceEdit, IWorkspaceEditControl, IFeatureWorkspace, IFeatureWorkspaceManage, IFeatureWorkspaceSchemaEdit, IGeodatabaseRelease, ITransactions, ITransactionsOptions, IWorkspaceDomains, IWorkspaceDomains2, IWorkspaceDomains3, ISpatialCacheManager, ISpatialCacheManager2, IFeatureWorkspaceAnno, IDatabaseCompact, ISQLSyntax, IWorkspaceConfiguration, IWorkspaceSpatialReferenceInfo, IWorkspaceExtensionManager, IDatabaseConnectionInfo, IRasterWorkspaceEx, IWorkspaceReplicas, IWorkspaceReplicasAdmin, IWorkspaceReplicasAdmin2, IWorkspaceReplicasAdmin3, IWorkspaceReplicaDatasets, ITopologyWorkspace

COM Class 'Workspace'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'Workspace Object.' 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.IWorkspace2
IID, IID4b21005e_01df_4945_9038_adcbd17a0f2e, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDataset
IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetContainer
IID, IIDbd770969_efb7_11d3_9fa2_00c04f6bdf0c, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceEdit
IID, IID995d5c92_15c6_11d2_89ed_006097aff44e, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceEditControl
IID, IID17240108_a1c0_4f02_bb9a_35d970abee15, 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.IFeatureWorkspaceManage
IID, IIDff866b9f_6f94_11d3_80e5_00c04f686238, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureWorkspaceSchemaEdit
IID, IID74996427_6627_11d3_80d3_00c04f686238, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGeodatabaseRelease
IID, IIDfe8f2fec_85ae_11d4_a0ca_00c04f6bdd84, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITransactions
IID, IIDf05d9bc1_d03c_11d1_887f_0000f877762d, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITransactionsOptions
IID, IID6e45153f_df82_11d1_aa82_00c04fa37585, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceDomains3
IID, IID7fd9b83c_76c0_4998_b9d3_afe9600b5d36, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceDomains2
IID56a5e6d4_01c6_11d4_a057_00c04f6bdd84
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceDomains
IIDd80957f0_8883_11d2_aabb_00c04fa37b82
 
Fields inherited from interface com.esri.arcgis.geodatabase.ISpatialCacheManager2
IID, IID9078f181_bb75_11d4_9feb_00c04f6bdf0c, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ISpatialCacheManager
IIDe2e4622f_55b4_11d3_9f77_00c04f6bdf0c
 
Fields inherited from interface com.esri.arcgis.geodatabase.IFeatureWorkspaceAnno
IID, IID14eb5331_ca80_11d2_8a2f_006097aff44e, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatabaseCompact
IID, IID660214d1_7c1b_11d3_80ea_00c04f686238, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ISQLSyntax
IID, IID18e2854e_edc8_11d2_aaef_00c04fa37849, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceConfiguration
IID, IID9e8f5c35_7888_4df9_862c_9dd74eff9062, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceSpatialReferenceInfo
IID, IID89890719_42d8_11d4_8145_00c04f686238, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceExtensionManager
IID, IIDb2119283_0cd1_11d4_9fac_00c04f6bdf0c, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDatabaseConnectionInfo
IID, IID2808cad6_e0fa_4478_be5b_0e645a2bc7ed, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IRasterWorkspaceEx
IID, IIDc8778a65_0e27_4cb5_9a50_a7471b398ea7, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceReplicas
IID, IIDd7463e40_9508_4b36_8728_29524d897fff, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceReplicasAdmin3
IID, IID9aa25800_7148_4680_9b14_d9f8818869aa, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceReplicasAdmin2
IID9aa14e6d_aa5a_4dae_a868_d70e8fd5a0be
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceReplicasAdmin
IID72ad4bea_a562_4c4a_a264_14fc6234b187
 
Fields inherited from interface com.esri.arcgis.geodatabase.IWorkspaceReplicaDatasets
IID, IID95f9e91d_885b_4f0e_9873_d66f5409ee41, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.ITopologyWorkspace
IID, IIDea103f9f_8226_4d62_afd8_a9aead2a3be3, xxDummy
 
Constructor Summary
Workspace(java.lang.Object obj)
          Construct a Workspace using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 void abortEditOperation()
          Aborts an edit operation.
 void abortTransaction()
          Aborts the current transaction.
 void addDataset(IDataset datasetToAdd)
          Adds a dataset to the dataset collection.
 int addDomain(IDomain domain)
          Adds the given domain to the workspace.
 void addIWorkspaceEvents2Listener(IWorkspaceEvents2 theListener)
          addIWorkspaceEvents2Listener.
 void addIWorkspaceEventsListener(IWorkspaceEvents theListener)
          addIWorkspaceEventsListener.
 void addSymbolCollection(java.lang.String name, java.lang.Object symbolCollection)
          Updates the symbol collection in the class extension.
 void alterClassExtensionCLSID(java.lang.String name, IUID classExtensionCLSID, IPropertySet classExtensionProperties)
          Changes the class extension COM class associated with this database class.
 void alterDomain(IDomain domain)
          Alters an existing domain in the workspace.
 void alterDomainWithName(IDomain domain, java.lang.String oldDomainName)
          Alters an existing domain in the workspace.
 void alterInstanceCLSID(java.lang.String name, IUID instanceCLSID)
          Changes the instance COM class associated with this database class.
 void alterReplica(IReplica replica)
          Updates replica information.
 void alterReplica2(IReplica replica, boolean persistParentUserInfo)
          Alter replica properties with the ability to persist userID and Password.
 void analyzeIndex(java.lang.String tableName, java.lang.String index)
          Analyze the index to generate DBMS statistics.
 void analyzeTable(java.lang.String tableName, int tableComponents)
          Analyze the table to generate DBMS statistics.
 boolean canCompact()
          True if this dataset can be compacted.
 boolean canCopy()
          True if this dataset can be copied.
 boolean canDelete()
          True if this dataset can be deleted.
 boolean canDelete(IName aName)
          Checks if an object can be deleted.
 boolean canRegisterReplicaDataset(IReplicaDataset replicaDataset, IReplica replica)
          Indicates if a replica dataset can be registed with the replica.
 boolean canRename()
          True if this dataset can be renamed.
 boolean canRename(IName aName)
          Checks if an object can be renamed.
 boolean canUnregisterReplicaDataset(IReplicaDataset replicaDataset)
          Indicates if a replica dataset can be unregisted from the replica.
 void commitTransaction()
          Commits the current transaction.
 void compact()
          Compacts the database.
 IDataset copy(java.lang.String copyName, IWorkspace copyWorkspace)
          Copies this dataset to a new dataset with the specified name.
 IFeatureClass createAnnotationClass(java.lang.String name, IFields fields, IUID cLSID, IUID eXTCLSID, java.lang.String shapeFieldName, java.lang.String configKeyword, IFeatureDataset dstFeatureDataset, IFeatureClass srcFeatureClass, java.lang.Object annoProperties, java.lang.Object referenceScale, java.lang.Object symbolCollection, boolean autoCreate)
          Creates a new annotation feature class in the workspace.
 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.
 IRasterCatalog createRasterCatalog(java.lang.String name, IFields fields, java.lang.String shapeFieldName, java.lang.String rasterFieldName, java.lang.String configKeyword)
          Creates a new raster catalog.
 IRasterDataset createRasterDataset(java.lang.String name, int numBands, int pixelType, IRasterStorageDef storageDef, java.lang.String configKeyword, IRasterDef rasterDef, IGeometryDef geometryDef)
          Creates a new raster dataset.
 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.
 void deleteByName(IDatasetName aName)
          Deletes an object by it's name.
 void deleteDomain(java.lang.String domainName)
          Deletes the given domain from the workspace.
 void deleteRasterCatalog(java.lang.String name)
          Deletes a raster catalog.
 void deleteRasterDataset(java.lang.String name)
          Deletes a raster dataset.
 void disableUndoRedo()
          Disables Undo and Redo of edit operations.
 void emptyCache()
          Empties the spatial cache.
 void enableUndoRedo()
          Enables Undo and Redo of edit operations.
 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.
 void fillCache(IEnvelope extent)
          Fills the spatial cache using the specified extent.
 void fillCacheEx(IEnvelope extent, double expansionFactor)
          Fills the spatial cache using the specified extent with an expansion factor.
 IWorkspaceExtension findExtension(IUID gUID)
          Finds the specified workspace extension by its globally unique id.
 int getAutoCommitInterval()
          The auto commit interval is the number of modification operations before a database commit is executed.
 java.lang.String getBrowseName()
          The browse name of the dataset.
 int getBugfixVersion()
          Geodatabase bugfix version level.
 double getCacheExpansionFactor()
          The extent expansion factor for the spatial cache.
 IEnvelope getCacheExtent()
          The extent of the spatial cache.
 java.lang.String getCategory()
          The category of the dataset.
 IEnumConfigurationKeyword getConfigurationKeywords()
          The available configuration keywords.
 java.lang.String getConnectedDatabase()
          The name of the connected database.
 java.lang.String getConnectedUser()
          The name of the connected user.
 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.
 boolean getDelimitedIdentifierCase()
          True if DBMS's quoted identifiers are case sensitive.
 IDomain getDomainByName(java.lang.String domainName)
          The domain with the given name from the workspace.
 IEnumDomain getDomains()
          All the domains in the workspace.
 IEnumDomain getDomainsByFieldType(int type)
          The domain with the given name from the workspace.
 IWorkspaceExtension getExtension(int index)
          The workspace extension at this index.
 int getExtensionCount()
          The number of workspace extensions.
 IName getFullName()
          The associated name object.
 java.lang.String getFunctionName(int sqlFunc)
          DBMS dependent SQL function names.
 boolean getIdentifierCase()
          True if DBMS's identifiers are case sensitive.
 java.lang.String getInvalidCharacters()
          The list of invalid characters used in literals (if any).
 java.lang.String getInvalidStartingCharacters()
          The list of invalid characters used in literals (if any).
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IEnumBSTR getKeywords()
          The list of DBMS specific reserved keywords.
 int getMajorVersion()
          Geodatabase major version level.
 int getMinorVersion()
          Geodatabase minor version level.
 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.
 IReplica getReplicaByGuid(java.lang.String replicaGuid)
          The replica or reference to a replica with the specified ID.
 IReplica getReplicaByID(int replicaID)
          The replica or reference to a replica with the specified ID.
 IReplica getReplicaByName(java.lang.String replicaName)
          The replica or reference to a replica with the specified name.
 IEnumReplicaDataset getReplicaDatasetsByID(int replicaID)
          A list of datasets based on a replica ID.
 IEnumReplicaDataset getReplicaDatasetsByName(java.lang.String replicaName)
          A list of datasets based on a replica name.
 IEnumReplica getReplicas()
          Replicas contained by or refernced by this workspace.
 ILongArray getReplicasByDataset(int datasetType, int datasetID)
          Indicates if dataset is part of a replica.
 IEnumSpatialReferenceInfo getSpatialReferenceInfo()
          The defined Spatial References in the Workspace.
 java.lang.String getSpecialCharacter(int sqlSC)
          Special DBMS dependent SQL characters.
 boolean getStringComparisonCase()
          True if string comparisons are case sensitive.
 IEnumDataset getSubsets()
          Datasets contained within this dataset.
 int getSupportedClauses()
          Supported SQL clauses.
 int getSupportedPredicates()
          Supported SQL predicates.
 int getType()
          The Type of the Workspace.
 IWorkspace getWorkspace()
          The workspace containing this dataset.
 IWorkspaceFactory getWorkspaceFactory()
          The factory that created the workspace.
 void hasEdits(boolean[] hasEdits)
          True if there are any completed edit operations that need to be saved .
 int hashCode()
          the hashcode for this object
 void hasRedos(boolean[] hasRedos)
          True if there are any completed undos that can be redone.
 void hasUndos(boolean[] hasUndos)
          True if there are any completed edit operations that can be undone.
 boolean isBeingEdited()
          True if the workspace is being edited.
 boolean isCacheIsFull()
          Indicates if the spatial cache is full.
 boolean isCanDeleteDomain(java.lang.String domainName)
          Indicates if the user can delete the domain.
 boolean isCanUpgrade()
          Indicates if the geodatabase can be upgraded with this interface.
 boolean isCurrentRelease()
          Indicates if the geodatabase at the current release level.
 boolean isDirectory()
          TRUE if the workspace is a file system directory.
 boolean isInTransaction()
          Indicates if there is already a transaction in progress.
 boolean isNameExists(int type, java.lang.String name)
          Indicates if a dataset with the given name exists within the workspace.
 boolean isReferencedByReplica(int datasetType, int datasetID)
          Indicates if dataset is part of a replica.
 boolean isRegisteredAsObjectClass(java.lang.String name)
          Checks if an object is registered as an object class.
 boolean isRegisteredAsVersioned(IName aName)
          Checks if an object is registered as versioned.
 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.
 IRasterCatalog openRasterCatalog(java.lang.String name)
          Opens an existing raster catalog.
 IRasterDataset openRasterDataset(java.lang.String name)
          Opens an existing raster dataset.
 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.
 ITopology openTopology(java.lang.String name)
          Opens and returns the topology with the specified name.
 void parseColumnName(java.lang.String fullName, java.lang.String[] dbName, java.lang.String[] ownerName, java.lang.String[] tableName, java.lang.String[] columnName)
          Given a column name, determine its qualification parts.
 void parseTableName(java.lang.String fullName, java.lang.String[] dbName, java.lang.String[] ownerName, java.lang.String[] tableName)
          Given a table name, determine its qualification parts.
 java.lang.String qualifyColumnName(java.lang.String tableName, java.lang.String columnName)
          Given a table name and column name, returns its fully qualified name.
 java.lang.String qualifyTableName(java.lang.String dbName, java.lang.String ownerName, java.lang.String tableName)
          Given a database, owner, and table name, return its fully qualified name.
 void redoEditOperation()
          Causes a Redo to be performed on the last undo.
 void refreshReplicas()
          Re-reads the list of replicas from the database.
 void registerAsRasterCatalog(java.lang.String name, java.lang.String oIDFieldName, IGeometryDef geometryDef)
          Registers as a RasterCatalog.
 void registerAsRasterDataset(java.lang.String name, IGeometryDef geometryDef)
          Registers as a RasterDataset.
 void registerExtension(java.lang.String name, IUID gUID)
          Registers this workspace extension with the database making it required for successful connection to this database.
 int registerReplica(IReplica replica)
          Creates new replica information.
 void registerReplicaDataset(IReplicaDataset rDataset, int filter, boolean useGeometry, java.lang.String queryDef, IFIDSet pSelID, IReplica pToReplica)
          Register replica dataset info with the replica.
 void release()
          Release a Workspace.
 void removeIWorkspaceEvents2Listener(IWorkspaceEvents2 theListener)
          removeIWorkspaceEvents2Listener.
 void removeIWorkspaceEventsListener(IWorkspaceEvents theListener)
          removeIWorkspaceEventsListener.
 void rename(java.lang.String name)
          Renames this Dataset.
 void replaceSymbolCollection(java.lang.String name, java.lang.Object symbolCollection)
          Replaces the symbol collection in the class extension.
 IRasterDataset saveAsRasterDataset(java.lang.String name, IRaster raster, IRasterStorageDef storageDef, java.lang.String configKeyword, IRasterDef rasterDef, IGeometryDef geometryDef)
          Creates a new raster dataset from another seed Raster.
 void setAutoCommitInterval(int interval)
          The auto commit interval is the number of modification operations before a database commit is executed.
 void setBrowseName(java.lang.String name)
          The browse name of the dataset.
 void setStoreEventsRequired()
          Indicates that insert and update cursors on simple classes cannot bypass store events
 void startEditing(boolean withUndoRedo)
          Starts editing the workspace.
 void startEditOperation()
          Begins an edit operation.
 void startTransaction()
          Begins a new transaction.
 void stopEditing(boolean saveEdits)
          Stops editing the workspace.
 void stopEditOperation()
          Ends an edit operation.
 void undoEditOperation()
          Causes an Undo to be performed on the last edit operation.
 void unRegisterExtension(IUID gUID)
          UnRegisters this workspace extension making it no longer required for successful connection to this database.
 void unregisterReplica(IReplica replica, boolean removeCOVersion)
          Removes replica information.
 void unregisterReplicaDataset(IReplicaDataset replicaDataset, IReplica replica)
          Removes replica dataset info from the replica.
 void upgrade()
          Upgrade the database to the current release level.
 IField validateField(IField inField)
          Validate a field, performing type conversion if necessary.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Workspace

public Workspace(java.lang.Object obj)
          throws java.io.IOException
Construct a Workspace using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Workspace.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
Workspace o = (Workspace)obj; // will not work

Workspace o = new Workspace(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems Workspace theWorkspace = (Workspace) obj;
Method Detail

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

addIWorkspaceEventsListener

public void addIWorkspaceEventsListener(IWorkspaceEvents theListener)
                                 throws java.io.IOException
addIWorkspaceEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabase.IWorkspaceEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeIWorkspaceEventsListener

public void removeIWorkspaceEventsListener(IWorkspaceEvents theListener)
                                    throws java.io.IOException
removeIWorkspaceEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabase.IWorkspaceEvents interface.
Throws:
java.io.IOException - If there are communications problems.

addIWorkspaceEvents2Listener

public void addIWorkspaceEvents2Listener(IWorkspaceEvents2 theListener)
                                  throws java.io.IOException
addIWorkspaceEvents2Listener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabase.IWorkspaceEvents2 interface.
Throws:
java.io.IOException - If there are communications problems.

removeIWorkspaceEvents2Listener

public void removeIWorkspaceEvents2Listener(IWorkspaceEvents2 theListener)
                                     throws java.io.IOException
removeIWorkspaceEvents2Listener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.geodatabase.IWorkspaceEvents2 interface.
Throws:
java.io.IOException - If there are communications problems.

release

public void release()
Release a Workspace.

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.

isNameExists

public boolean isNameExists(int type,
                            java.lang.String name)
                     throws java.io.IOException,
                            AutomationException
Indicates if a dataset with the given name exists within the workspace.

Specified by:
isNameExists in interface IWorkspace2
Parameters:
type - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
name - The name (in)
Returns:
The exists
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.

addDataset

public void addDataset(IDataset datasetToAdd)
                throws java.io.IOException,
                       AutomationException
Adds a dataset to the dataset collection.

Specified by:
addDataset in interface IDatasetContainer
Parameters:
datasetToAdd - A reference to a com.esri.arcgis.geodatabase.IDataset (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startEditing

public void startEditing(boolean withUndoRedo)
                  throws java.io.IOException,
                         AutomationException
Starts editing the workspace.

Specified by:
startEditing in interface IWorkspaceEdit
Parameters:
withUndoRedo - The withUndoRedo (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stopEditing

public void stopEditing(boolean saveEdits)
                 throws java.io.IOException,
                        AutomationException
Stops editing the workspace.

Specified by:
stopEditing in interface IWorkspaceEdit
Parameters:
saveEdits - The saveEdits (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBeingEdited

public boolean isBeingEdited()
                      throws java.io.IOException,
                             AutomationException
True if the workspace is being edited.

Specified by:
isBeingEdited in interface IWorkspaceEdit
Returns:
The isBeingEdited
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startEditOperation

public void startEditOperation()
                        throws java.io.IOException,
                               AutomationException
Begins an edit operation.

Specified by:
startEditOperation in interface IWorkspaceEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stopEditOperation

public void stopEditOperation()
                       throws java.io.IOException,
                              AutomationException
Ends an edit operation.

Specified by:
stopEditOperation in interface IWorkspaceEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

abortEditOperation

public void abortEditOperation()
                        throws java.io.IOException,
                               AutomationException
Aborts an edit operation.

Specified by:
abortEditOperation in interface IWorkspaceEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasUndos

public void hasUndos(boolean[] hasUndos)
              throws java.io.IOException,
                     AutomationException
True if there are any completed edit operations that can be undone.

Specified by:
hasUndos in interface IWorkspaceEdit
Parameters:
hasUndos - The hasUndos (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

undoEditOperation

public void undoEditOperation()
                       throws java.io.IOException,
                              AutomationException
Causes an Undo to be performed on the last edit operation.

Specified by:
undoEditOperation in interface IWorkspaceEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasRedos

public void hasRedos(boolean[] hasRedos)
              throws java.io.IOException,
                     AutomationException
True if there are any completed undos that can be redone.

Specified by:
hasRedos in interface IWorkspaceEdit
Parameters:
hasRedos - The hasRedos (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

redoEditOperation

public void redoEditOperation()
                       throws java.io.IOException,
                              AutomationException
Causes a Redo to be performed on the last undo.

Specified by:
redoEditOperation in interface IWorkspaceEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enableUndoRedo

public void enableUndoRedo()
                    throws java.io.IOException,
                           AutomationException
Enables Undo and Redo of edit operations.

Specified by:
enableUndoRedo in interface IWorkspaceEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

disableUndoRedo

public void disableUndoRedo()
                     throws java.io.IOException,
                            AutomationException
Disables Undo and Redo of edit operations.

Specified by:
disableUndoRedo in interface IWorkspaceEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hasEdits

public void hasEdits(boolean[] hasEdits)
              throws java.io.IOException,
                     AutomationException
True if there are any completed edit operations that need to be saved .

Specified by:
hasEdits in interface IWorkspaceEdit
Parameters:
hasEdits - The hasEdits (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStoreEventsRequired

public void setStoreEventsRequired()
                            throws java.io.IOException,
                                   AutomationException
Indicates that insert and update cursors on simple classes cannot bypass store events

Specified by:
setStoreEventsRequired in interface IWorkspaceEditControl
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.

deleteByName

public void deleteByName(IDatasetName aName)
                  throws java.io.IOException,
                         AutomationException
Deletes an object by it's name.

Specified by:
deleteByName in interface IFeatureWorkspaceManage
Parameters:
aName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRegisteredAsVersioned

public boolean isRegisteredAsVersioned(IName aName)
                                throws java.io.IOException,
                                       AutomationException
Checks if an object is registered as versioned.

Specified by:
isRegisteredAsVersioned in interface IFeatureWorkspaceManage
Parameters:
aName - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The isRegistered
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRegisteredAsObjectClass

public boolean isRegisteredAsObjectClass(java.lang.String name)
                                  throws java.io.IOException,
                                         AutomationException
Checks if an object is registered as an object class.

Specified by:
isRegisteredAsObjectClass in interface IFeatureWorkspaceManage
Parameters:
name - The name (in)
Returns:
The isRegistered
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete(IName aName)
                  throws java.io.IOException,
                         AutomationException
Checks if an object can be deleted.

Specified by:
canDelete in interface IFeatureWorkspaceManage
Parameters:
aName - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The canDelete
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename(IName aName)
                  throws java.io.IOException,
                         AutomationException
Checks if an object can be renamed.

Specified by:
canRename in interface IFeatureWorkspaceManage
Parameters:
aName - A reference to a com.esri.arcgis.system.IName (in)
Returns:
The canRename
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

analyzeTable

public void analyzeTable(java.lang.String tableName,
                         int tableComponents)
                  throws java.io.IOException,
                         AutomationException
Analyze the table to generate DBMS statistics.

Specified by:
analyzeTable in interface IFeatureWorkspaceManage
Parameters:
tableName - The tableName (in)
tableComponents - The tableComponents (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

analyzeIndex

public void analyzeIndex(java.lang.String tableName,
                         java.lang.String index)
                  throws java.io.IOException,
                         AutomationException
Analyze the index to generate DBMS statistics.

Specified by:
analyzeIndex in interface IFeatureWorkspaceManage
Parameters:
tableName - The tableName (in)
index - The index (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateField

public IField validateField(IField inField)
                     throws java.io.IOException,
                            AutomationException
Validate a field, performing type conversion if necessary.

Specified by:
validateField in interface IFeatureWorkspaceManage
Parameters:
inField - A reference to a com.esri.arcgis.geodatabase.IField (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IField
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterInstanceCLSID

public void alterInstanceCLSID(java.lang.String name,
                               IUID instanceCLSID)
                        throws java.io.IOException,
                               AutomationException
Changes the instance COM class associated with this database class.

Specified by:
alterInstanceCLSID in interface IFeatureWorkspaceSchemaEdit
Parameters:
name - The name (in)
instanceCLSID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterClassExtensionCLSID

public void alterClassExtensionCLSID(java.lang.String name,
                                     IUID classExtensionCLSID,
                                     IPropertySet classExtensionProperties)
                              throws java.io.IOException,
                                     AutomationException
Changes the class extension COM class associated with this database class.

Specified by:
alterClassExtensionCLSID in interface IFeatureWorkspaceSchemaEdit
Parameters:
name - The name (in)
classExtensionCLSID - A reference to a com.esri.arcgis.system.IUID (in)
classExtensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanUpgrade

public boolean isCanUpgrade()
                     throws java.io.IOException,
                            AutomationException
Indicates if the geodatabase can be upgraded with this interface. If not, then another utility must be used to upgrade it.

Specified by:
isCanUpgrade in interface IGeodatabaseRelease
Returns:
The canUpgrade
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCurrentRelease

public boolean isCurrentRelease()
                         throws java.io.IOException,
                                AutomationException
Indicates if the geodatabase at the current release level.

Specified by:
isCurrentRelease in interface IGeodatabaseRelease
Returns:
The isCurrent
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMajorVersion

public int getMajorVersion()
                    throws java.io.IOException,
                           AutomationException
Geodatabase major version level.

Specified by:
getMajorVersion in interface IGeodatabaseRelease
Returns:
The versionNumber
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinorVersion

public int getMinorVersion()
                    throws java.io.IOException,
                           AutomationException
Geodatabase minor version level.

Specified by:
getMinorVersion in interface IGeodatabaseRelease
Returns:
The versionNumber
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBugfixVersion

public int getBugfixVersion()
                     throws java.io.IOException,
                            AutomationException
Geodatabase bugfix version level.

Specified by:
getBugfixVersion in interface IGeodatabaseRelease
Returns:
The versionNumber
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

upgrade

public void upgrade()
             throws java.io.IOException,
                    AutomationException
Upgrade the database to the current release level.

Specified by:
upgrade in interface IGeodatabaseRelease
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInTransaction

public boolean isInTransaction()
                        throws java.io.IOException,
                               AutomationException
Indicates if there is already a transaction in progress.

Specified by:
isInTransaction in interface ITransactions
Returns:
The inTransaction
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startTransaction

public void startTransaction()
                      throws java.io.IOException,
                             AutomationException
Begins a new transaction.

Specified by:
startTransaction in interface ITransactions
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

commitTransaction

public void commitTransaction()
                       throws java.io.IOException,
                              AutomationException
Commits the current transaction.

Specified by:
commitTransaction in interface ITransactions
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

abortTransaction

public void abortTransaction()
                      throws java.io.IOException,
                             AutomationException
Aborts the current transaction.

Specified by:
abortTransaction in interface ITransactions
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoCommitInterval

public void setAutoCommitInterval(int interval)
                           throws java.io.IOException,
                                  AutomationException
The auto commit interval is the number of modification operations before a database commit is executed.

Specified by:
setAutoCommitInterval in interface ITransactionsOptions
Parameters:
interval - The interval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAutoCommitInterval

public int getAutoCommitInterval()
                          throws java.io.IOException,
                                 AutomationException
The auto commit interval is the number of modification operations before a database commit is executed.

Specified by:
getAutoCommitInterval in interface ITransactionsOptions
Returns:
The interval
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addDomain

public int addDomain(IDomain domain)
              throws java.io.IOException,
                     AutomationException
Adds the given domain to the workspace.

Specified by:
addDomain in interface IWorkspaceDomains
Parameters:
domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
Returns:
The domainID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanDeleteDomain

public boolean isCanDeleteDomain(java.lang.String domainName)
                          throws java.io.IOException,
                                 AutomationException
Indicates if the user can delete the domain.

Specified by:
isCanDeleteDomain in interface IWorkspaceDomains
Parameters:
domainName - The domainName (in)
Returns:
The deletable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteDomain

public void deleteDomain(java.lang.String domainName)
                  throws java.io.IOException,
                         AutomationException
Deletes the given domain from the workspace.

Specified by:
deleteDomain in interface IWorkspaceDomains
Parameters:
domainName - The domainName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDomains

public IEnumDomain getDomains()
                       throws java.io.IOException,
                              AutomationException
All the domains in the workspace.

Specified by:
getDomains in interface IWorkspaceDomains
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDomain
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDomainByName

public IDomain getDomainByName(java.lang.String domainName)
                        throws java.io.IOException,
                               AutomationException
The domain with the given name from the workspace.

Specified by:
getDomainByName in interface IWorkspaceDomains
Parameters:
domainName - The domainName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDomain
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDomainsByFieldType

public IEnumDomain getDomainsByFieldType(int type)
                                  throws java.io.IOException,
                                         AutomationException
The domain with the given name from the workspace.

Specified by:
getDomainsByFieldType in interface IWorkspaceDomains
Parameters:
type - A com.esri.arcgis.geodatabase.esriFieldType constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumDomain
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterDomain

public void alterDomain(IDomain domain)
                 throws java.io.IOException,
                        AutomationException
Alters an existing domain in the workspace.

Specified by:
alterDomain in interface IWorkspaceDomains2
Parameters:
domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterDomainWithName

public void alterDomainWithName(IDomain domain,
                                java.lang.String oldDomainName)
                         throws java.io.IOException,
                                AutomationException
Alters an existing domain in the workspace.

Specified by:
alterDomainWithName in interface IWorkspaceDomains3
Parameters:
domain - A reference to a com.esri.arcgis.geodatabase.IDomain (in)
oldDomainName - The oldDomainName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fillCache

public void fillCache(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException
Fills the spatial cache using the specified extent.

Specified by:
fillCache in interface ISpatialCacheManager
Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

emptyCache

public void emptyCache()
                throws java.io.IOException,
                       AutomationException
Empties the spatial cache.

Specified by:
emptyCache in interface ISpatialCacheManager
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCacheIsFull

public boolean isCacheIsFull()
                      throws java.io.IOException,
                             AutomationException
Indicates if the spatial cache is full.

Specified by:
isCacheIsFull in interface ISpatialCacheManager
Returns:
The isFull
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheExtent

public IEnvelope getCacheExtent()
                         throws java.io.IOException,
                                AutomationException
The extent of the spatial cache.

Specified by:
getCacheExtent in interface ISpatialCacheManager
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fillCacheEx

public void fillCacheEx(IEnvelope extent,
                        double expansionFactor)
                 throws java.io.IOException,
                        AutomationException
Fills the spatial cache using the specified extent with an expansion factor.

Specified by:
fillCacheEx in interface ISpatialCacheManager2
Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
expansionFactor - The expansionFactor (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCacheExpansionFactor

public double getCacheExpansionFactor()
                               throws java.io.IOException,
                                      AutomationException
The extent expansion factor for the spatial cache.

Specified by:
getCacheExpansionFactor in interface ISpatialCacheManager2
Returns:
The expansionFactor
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createAnnotationClass

public IFeatureClass createAnnotationClass(java.lang.String name,
                                           IFields fields,
                                           IUID cLSID,
                                           IUID eXTCLSID,
                                           java.lang.String shapeFieldName,
                                           java.lang.String configKeyword,
                                           IFeatureDataset dstFeatureDataset,
                                           IFeatureClass srcFeatureClass,
                                           java.lang.Object annoProperties,
                                           java.lang.Object referenceScale,
                                           java.lang.Object symbolCollection,
                                           boolean autoCreate)
                                    throws java.io.IOException,
                                           AutomationException
Creates a new annotation feature class in the workspace.

Specified by:
createAnnotationClass in interface IFeatureWorkspaceAnno
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)
shapeFieldName - The shapeFieldName (in)
configKeyword - The configKeyword (in)
dstFeatureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)
srcFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
annoProperties - A reference to another Object (IUnknown) (in)
referenceScale - A reference to another Object (IUnknown) (in)
symbolCollection - A reference to another Object (IUnknown) (in)
autoCreate - The autoCreate (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.

addSymbolCollection

public void addSymbolCollection(java.lang.String name,
                                java.lang.Object symbolCollection)
                         throws java.io.IOException,
                                AutomationException
Updates the symbol collection in the class extension.

Specified by:
addSymbolCollection in interface IFeatureWorkspaceAnno
Parameters:
name - The name (in)
symbolCollection - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceSymbolCollection

public void replaceSymbolCollection(java.lang.String name,
                                    java.lang.Object symbolCollection)
                             throws java.io.IOException,
                                    AutomationException
Replaces the symbol collection in the class extension.

Specified by:
replaceSymbolCollection in interface IFeatureWorkspaceAnno
Parameters:
name - The name (in)
symbolCollection - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

compact

public void compact()
             throws java.io.IOException,
                    AutomationException
Compacts the database.

Specified by:
compact in interface IDatabaseCompact
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canCompact

public boolean canCompact()
                   throws java.io.IOException,
                          AutomationException
True if this dataset can be compacted.

Specified by:
canCompact in interface IDatabaseCompact
Returns:
The canCompact
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

qualifyTableName

public java.lang.String qualifyTableName(java.lang.String dbName,
                                         java.lang.String ownerName,
                                         java.lang.String tableName)
                                  throws java.io.IOException,
                                         AutomationException
Given a database, owner, and table name, return its fully qualified name.

Specified by:
qualifyTableName in interface ISQLSyntax
Parameters:
dbName - The dbName (in)
ownerName - The ownerName (in)
tableName - The tableName (in)
Returns:
The fullName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

qualifyColumnName

public java.lang.String qualifyColumnName(java.lang.String tableName,
                                          java.lang.String columnName)
                                   throws java.io.IOException,
                                          AutomationException
Given a table name and column name, returns its fully qualified name.

Specified by:
qualifyColumnName in interface ISQLSyntax
Parameters:
tableName - The tableName (in)
columnName - The columnName (in)
Returns:
The fullName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

parseTableName

public void parseTableName(java.lang.String fullName,
                           java.lang.String[] dbName,
                           java.lang.String[] ownerName,
                           java.lang.String[] tableName)
                    throws java.io.IOException,
                           AutomationException
Given a table name, determine its qualification parts.

Specified by:
parseTableName in interface ISQLSyntax
Parameters:
fullName - The fullName (in)
dbName - The dbName (out: use single element array)
ownerName - The ownerName (out: use single element array)
tableName - The tableName (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

parseColumnName

public void parseColumnName(java.lang.String fullName,
                            java.lang.String[] dbName,
                            java.lang.String[] ownerName,
                            java.lang.String[] tableName,
                            java.lang.String[] columnName)
                     throws java.io.IOException,
                            AutomationException
Given a column name, determine its qualification parts.

Specified by:
parseColumnName in interface ISQLSyntax
Parameters:
fullName - The fullName (in)
dbName - The dbName (out: use single element array)
ownerName - The ownerName (out: use single element array)
tableName - The tableName (out: use single element array)
columnName - The columnName (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFunctionName

public java.lang.String getFunctionName(int sqlFunc)
                                 throws java.io.IOException,
                                        AutomationException
DBMS dependent SQL function names.

Specified by:
getFunctionName in interface ISQLSyntax
Parameters:
sqlFunc - A com.esri.arcgis.geodatabase.esriSQLFunctionName constant (in)
Returns:
The sqlFunctionName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpecialCharacter

public java.lang.String getSpecialCharacter(int sqlSC)
                                     throws java.io.IOException,
                                            AutomationException
Special DBMS dependent SQL characters.

Specified by:
getSpecialCharacter in interface ISQLSyntax
Parameters:
sqlSC - A com.esri.arcgis.geodatabase.esriSQLSpecialCharacters constant (in)
Returns:
The specialChar
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSupportedPredicates

public int getSupportedPredicates()
                           throws java.io.IOException,
                                  AutomationException
Supported SQL predicates.

Specified by:
getSupportedPredicates in interface ISQLSyntax
Returns:
The predicates
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSupportedClauses

public int getSupportedClauses()
                        throws java.io.IOException,
                               AutomationException
Supported SQL clauses.

Specified by:
getSupportedClauses in interface ISQLSyntax
Returns:
The clauses
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIdentifierCase

public boolean getIdentifierCase()
                          throws java.io.IOException,
                                 AutomationException
True if DBMS's identifiers are case sensitive.

Specified by:
getIdentifierCase in interface ISQLSyntax
Returns:
The isCaseSensitive
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDelimitedIdentifierCase

public boolean getDelimitedIdentifierCase()
                                   throws java.io.IOException,
                                          AutomationException
True if DBMS's quoted identifiers are case sensitive.

Specified by:
getDelimitedIdentifierCase in interface ISQLSyntax
Returns:
The isCaseSensitive
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStringComparisonCase

public boolean getStringComparisonCase()
                                throws java.io.IOException,
                                       AutomationException
True if string comparisons are case sensitive.

Specified by:
getStringComparisonCase in interface ISQLSyntax
Returns:
The isCaseSensitive
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeywords

public IEnumBSTR getKeywords()
                      throws java.io.IOException,
                             AutomationException
The list of DBMS specific reserved keywords.

Specified by:
getKeywords in interface ISQLSyntax
Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInvalidCharacters

public java.lang.String getInvalidCharacters()
                                      throws java.io.IOException,
                                             AutomationException
The list of invalid characters used in literals (if any).

Specified by:
getInvalidCharacters in interface ISQLSyntax
Returns:
The invalidChars
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInvalidStartingCharacters

public java.lang.String getInvalidStartingCharacters()
                                              throws java.io.IOException,
                                                     AutomationException
The list of invalid characters used in literals (if any).

Specified by:
getInvalidStartingCharacters in interface ISQLSyntax
Returns:
The invalidChars
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConfigurationKeywords

public IEnumConfigurationKeyword getConfigurationKeywords()
                                                   throws java.io.IOException,
                                                          AutomationException
The available configuration keywords.

Specified by:
getConfigurationKeywords in interface IWorkspaceConfiguration
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumConfigurationKeyword
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReferenceInfo

public IEnumSpatialReferenceInfo getSpatialReferenceInfo()
                                                  throws java.io.IOException,
                                                         AutomationException
The defined Spatial References in the Workspace.

Specified by:
getSpatialReferenceInfo in interface IWorkspaceSpatialReferenceInfo
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumSpatialReferenceInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findExtension

public IWorkspaceExtension findExtension(IUID gUID)
                                  throws java.io.IOException,
                                         AutomationException
Finds the specified workspace extension by its globally unique id.

Specified by:
findExtension in interface IWorkspaceExtensionManager
Parameters:
gUID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceExtension
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionCount

public int getExtensionCount()
                      throws java.io.IOException,
                             AutomationException
The number of workspace extensions.

Specified by:
getExtensionCount in interface IWorkspaceExtensionManager
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

public IWorkspaceExtension getExtension(int index)
                                 throws java.io.IOException,
                                        AutomationException
The workspace extension at this index.

Specified by:
getExtension in interface IWorkspaceExtensionManager
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspaceExtension
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerExtension

public void registerExtension(java.lang.String name,
                              IUID gUID)
                       throws java.io.IOException,
                              AutomationException
Registers this workspace extension with the database making it required for successful connection to this database.

Specified by:
registerExtension in interface IWorkspaceExtensionManager
Parameters:
name - The name (in)
gUID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unRegisterExtension

public void unRegisterExtension(IUID gUID)
                         throws java.io.IOException,
                                AutomationException
UnRegisters this workspace extension making it no longer required for successful connection to this database.

Specified by:
unRegisterExtension in interface IWorkspaceExtensionManager
Parameters:
gUID - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConnectedDatabase

public java.lang.String getConnectedDatabase()
                                      throws java.io.IOException,
                                             AutomationException
The name of the connected database. It may be different from the DATABASE property in the workspace's connection properties.

Specified by:
getConnectedDatabase in interface IDatabaseConnectionInfo
Returns:
The db
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getConnectedUser

public java.lang.String getConnectedUser()
                                  throws java.io.IOException,
                                         AutomationException
The name of the connected user. It may be different from the USER property in the workspace's connection properties.

Specified by:
getConnectedUser in interface IDatabaseConnectionInfo
Returns:
The user
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRasterDataset

public IRasterDataset createRasterDataset(java.lang.String name,
                                          int numBands,
                                          int pixelType,
                                          IRasterStorageDef storageDef,
                                          java.lang.String configKeyword,
                                          IRasterDef rasterDef,
                                          IGeometryDef geometryDef)
                                   throws java.io.IOException,
                                          AutomationException
Creates a new raster dataset.

Specified by:
createRasterDataset in interface IRasterWorkspaceEx
Parameters:
name - The name (in)
numBands - The numBands (in)
pixelType - A com.esri.arcgis.geodatabase.rstPixelType constant (in)
storageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)
configKeyword - The configKeyword (in)
rasterDef - A reference to a com.esri.arcgis.geodatabase.IRasterDef (in)
geometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveAsRasterDataset

public IRasterDataset saveAsRasterDataset(java.lang.String name,
                                          IRaster raster,
                                          IRasterStorageDef storageDef,
                                          java.lang.String configKeyword,
                                          IRasterDef rasterDef,
                                          IGeometryDef geometryDef)
                                   throws java.io.IOException,
                                          AutomationException
Creates a new raster dataset from another seed Raster.

Specified by:
saveAsRasterDataset in interface IRasterWorkspaceEx
Parameters:
name - The name (in)
raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)
storageDef - A reference to a com.esri.arcgis.geodatabase.IRasterStorageDef (in)
configKeyword - The configKeyword (in)
rasterDef - A reference to a com.esri.arcgis.geodatabase.IRasterDef (in)
geometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openRasterDataset

public IRasterDataset openRasterDataset(java.lang.String name)
                                 throws java.io.IOException,
                                        AutomationException
Opens an existing raster dataset.

Specified by:
openRasterDataset in interface IRasterWorkspaceEx
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteRasterDataset

public void deleteRasterDataset(java.lang.String name)
                         throws java.io.IOException,
                                AutomationException
Deletes a raster dataset.

Specified by:
deleteRasterDataset in interface IRasterWorkspaceEx
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerAsRasterDataset

public void registerAsRasterDataset(java.lang.String name,
                                    IGeometryDef geometryDef)
                             throws java.io.IOException,
                                    AutomationException
Registers as a RasterDataset.

Specified by:
registerAsRasterDataset in interface IRasterWorkspaceEx
Parameters:
name - The name (in)
geometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRasterCatalog

public IRasterCatalog createRasterCatalog(java.lang.String name,
                                          IFields fields,
                                          java.lang.String shapeFieldName,
                                          java.lang.String rasterFieldName,
                                          java.lang.String configKeyword)
                                   throws java.io.IOException,
                                          AutomationException
Creates a new raster catalog.

Specified by:
createRasterCatalog in interface IRasterWorkspaceEx
Parameters:
name - The name (in)
fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
shapeFieldName - The shapeFieldName (in)
rasterFieldName - The rasterFieldName (in)
configKeyword - The configKeyword (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterCatalog
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openRasterCatalog

public IRasterCatalog openRasterCatalog(java.lang.String name)
                                 throws java.io.IOException,
                                        AutomationException
Opens an existing raster catalog.

Specified by:
openRasterCatalog in interface IRasterWorkspaceEx
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterCatalog
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteRasterCatalog

public void deleteRasterCatalog(java.lang.String name)
                         throws java.io.IOException,
                                AutomationException
Deletes a raster catalog.

Specified by:
deleteRasterCatalog in interface IRasterWorkspaceEx
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerAsRasterCatalog

public void registerAsRasterCatalog(java.lang.String name,
                                    java.lang.String oIDFieldName,
                                    IGeometryDef geometryDef)
                             throws java.io.IOException,
                                    AutomationException
Registers as a RasterCatalog.

Specified by:
registerAsRasterCatalog in interface IRasterWorkspaceEx
Parameters:
name - The name (in)
oIDFieldName - The oIDFieldName (in)
geometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicas

public IEnumReplica getReplicas()
                         throws java.io.IOException,
                                AutomationException
Replicas contained by or refernced by this workspace.

Specified by:
getReplicas in interface IWorkspaceReplicas
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumReplica
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaByName

public IReplica getReplicaByName(java.lang.String replicaName)
                          throws java.io.IOException,
                                 AutomationException
The replica or reference to a replica with the specified name.

Specified by:
getReplicaByName in interface IWorkspaceReplicas
Parameters:
replicaName - The replicaName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IReplica
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaByID

public IReplica getReplicaByID(int replicaID)
                        throws java.io.IOException,
                               AutomationException
The replica or reference to a replica with the specified ID.

Specified by:
getReplicaByID in interface IWorkspaceReplicas
Parameters:
replicaID - The replicaID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IReplica
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaByGuid

public IReplica getReplicaByGuid(java.lang.String replicaGuid)
                          throws java.io.IOException,
                                 AutomationException
The replica or reference to a replica with the specified ID.

Specified by:
getReplicaByGuid in interface IWorkspaceReplicas
Parameters:
replicaGuid - The replicaGuid (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IReplica
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshReplicas

public void refreshReplicas()
                     throws java.io.IOException,
                            AutomationException
Re-reads the list of replicas from the database.

Specified by:
refreshReplicas in interface IWorkspaceReplicas
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterReplica

public void alterReplica(IReplica replica)
                  throws java.io.IOException,
                         AutomationException
Updates replica information.

Specified by:
alterReplica in interface IWorkspaceReplicasAdmin
Parameters:
replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerReplica

public int registerReplica(IReplica replica)
                    throws java.io.IOException,
                           AutomationException
Creates new replica information.

Specified by:
registerReplica in interface IWorkspaceReplicasAdmin
Parameters:
replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
Returns:
The replicaID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unregisterReplica

public void unregisterReplica(IReplica replica,
                              boolean removeCOVersion)
                       throws java.io.IOException,
                              AutomationException
Removes replica information.

Specified by:
unregisterReplica in interface IWorkspaceReplicasAdmin
Parameters:
replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
removeCOVersion - The removeCOVersion (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRegisterReplicaDataset

public boolean canRegisterReplicaDataset(IReplicaDataset replicaDataset,
                                         IReplica replica)
                                  throws java.io.IOException,
                                         AutomationException
Indicates if a replica dataset can be registed with the replica.

Specified by:
canRegisterReplicaDataset in interface IWorkspaceReplicasAdmin2
Parameters:
replicaDataset - A reference to a com.esri.arcgis.geodatabase.IReplicaDataset (in)
replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
Returns:
The canRegister
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

registerReplicaDataset

public void registerReplicaDataset(IReplicaDataset rDataset,
                                   int filter,
                                   boolean useGeometry,
                                   java.lang.String queryDef,
                                   IFIDSet pSelID,
                                   IReplica pToReplica)
                            throws java.io.IOException,
                                   AutomationException
Register replica dataset info with the replica.

Specified by:
registerReplicaDataset in interface IWorkspaceReplicasAdmin2
Parameters:
rDataset - A reference to a com.esri.arcgis.geodatabase.IReplicaDataset (in)
filter - A com.esri.arcgis.geodatabase.esriRowsType constant (in)
useGeometry - The useGeometry (in)
queryDef - The queryDef (in)
pSelID - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)
pToReplica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canUnregisterReplicaDataset

public boolean canUnregisterReplicaDataset(IReplicaDataset replicaDataset)
                                    throws java.io.IOException,
                                           AutomationException
Indicates if a replica dataset can be unregisted from the replica.

Specified by:
canUnregisterReplicaDataset in interface IWorkspaceReplicasAdmin2
Parameters:
replicaDataset - A reference to a com.esri.arcgis.geodatabase.IReplicaDataset (in)
Returns:
The canUnregister
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unregisterReplicaDataset

public void unregisterReplicaDataset(IReplicaDataset replicaDataset,
                                     IReplica replica)
                              throws java.io.IOException,
                                     AutomationException
Removes replica dataset info from the replica.

Specified by:
unregisterReplicaDataset in interface IWorkspaceReplicasAdmin2
Parameters:
replicaDataset - A reference to a com.esri.arcgis.geodatabase.IReplicaDataset (in)
replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alterReplica2

public void alterReplica2(IReplica replica,
                          boolean persistParentUserInfo)
                   throws java.io.IOException,
                          AutomationException
Alter replica properties with the ability to persist userID and Password.

Specified by:
alterReplica2 in interface IWorkspaceReplicasAdmin2
Parameters:
replica - A reference to a com.esri.arcgis.geodatabase.IReplica (in)
persistParentUserInfo - The persistParentUserInfo (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReferencedByReplica

public boolean isReferencedByReplica(int datasetType,
                                     int datasetID)
                              throws java.io.IOException,
                                     AutomationException
Indicates if dataset is part of a replica.

Specified by:
isReferencedByReplica in interface IWorkspaceReplicasAdmin2
Parameters:
datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
datasetID - The datasetID (in)
Returns:
The isReferenced
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicasByDataset

public ILongArray getReplicasByDataset(int datasetType,
                                       int datasetID)
                                throws java.io.IOException,
                                       AutomationException
Indicates if dataset is part of a replica.

Specified by:
getReplicasByDataset in interface IWorkspaceReplicasAdmin3
Parameters:
datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
datasetID - The datasetID (in)
Returns:
A reference to a com.esri.arcgis.system.ILongArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaDatasetsByName

public IEnumReplicaDataset getReplicaDatasetsByName(java.lang.String replicaName)
                                             throws java.io.IOException,
                                                    AutomationException
A list of datasets based on a replica name.

Specified by:
getReplicaDatasetsByName in interface IWorkspaceReplicaDatasets
Parameters:
replicaName - The replicaName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumReplicaDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReplicaDatasetsByID

public IEnumReplicaDataset getReplicaDatasetsByID(int replicaID)
                                           throws java.io.IOException,
                                                  AutomationException
A list of datasets based on a replica ID.

Specified by:
getReplicaDatasetsByID in interface IWorkspaceReplicaDatasets
Parameters:
replicaID - The replicaID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumReplicaDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openTopology

public ITopology openTopology(java.lang.String name)
                       throws java.io.IOException,
                              AutomationException
Opens and returns the topology with the specified name.

Specified by:
openTopology in interface ITopologyWorkspace
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITopology
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD