com.esri.arcgis.datasourcesGDB

Class SqlWorkspace

java.lang.Object

com.esri.arcgis.datasourcesGDB.SqlWorkspace

All Implemented Interfaces:

IDatabaseConnectionInfo, IDatabaseConnectionInfo2, IDataset, IFeatureWorkspace, ISQLSyntax, ISqlWorkspace, ISqlWorkspace2, IWorkspace, IWorkspaceConfiguration, IWorkspaceProperties, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class SqlWorkspace
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDataset, IWorkspace, IWorkspaceProperties, ISQLSyntax, IDatabaseConnectionInfo2, ISqlWorkspace2, ISupportErrorInfo, IFeatureWorkspace, IWorkspaceConfiguration

COM Class 'SqlWorkspace'. Generated 5/5/2025 2:28:33 PM from 'X:\ArcGIS\com\server\esriDataSourcesGDB.tlb'

Description 'Sql workspace' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

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

IID, IID2d04c042_7766_11d0_b77d_00805f7ced21, xxDummy

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

IID, IIDd4803ee1_79f4_11d0_97fc_0080c7f79481, xxDummy

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

IID, IID0f1b2257_e2d8_4046_b749_7ff1b058a943, 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.IDatabaseConnectionInfo2

IID, IID6557f590_8a8e_4f2c_a910_4eac2785f986, xxDummy

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

IID2808cad6_e0fa_4478_be5b_0e645a2bc7ed

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

IID, IIDfee0522b_4882_47df_b0e8_894d9f697935, xxDummy

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

IIDeed692f3_04e5_42d8_a232_4aad0085e471

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, 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.IWorkspaceConfiguration

IID, IID9e8f5c35_7888_4df9_862c_9dd74eff9062, xxDummy

Constructor Summary

Constructors

Constructor and Description
SqlWorkspace(java.lang.Object obj) Construct a SqlWorkspace using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

Modifier and Type	Method and Description
boolean	canCopy() True if this dataset can be copied.
boolean	canDelete() True if this dataset can be deleted.
boolean	canRename() True if this dataset can be renamed.
void	checkDatasetName(java.lang.String name, IQueryDescription queryDescription, java.lang.String[] newName) Returns unique name in the workspace.
IDataset	copy(java.lang.String copyName, IWorkspace copyWorkspace) Copies this dataset to a new dataset with the specified name.
IFeatureClass	createFeatureClass(java.lang.String name, IFields fields, IUID cLSID, IUID eXTCLSID, int featureType, java.lang.String shapeFieldName, java.lang.String configKeyword) Creates a new standalone feature class under the workspace.
IFeatureDataset	createFeatureDataset(java.lang.String name, ISpatialReference spatialReference) Creates a new feature dataset.
IQueryDef	createQueryDef() Create a query definition object.
IRelationshipClass	createRelationshipClass(java.lang.String relClassName, IObjectClass originClass, IObjectClass destinationClass, java.lang.String forwardLabel, java.lang.String backwardLabel, int cardinality, int notification, boolean isComposite, boolean isAttributed, IFields relAttrFields, java.lang.String originPrimaryKey, java.lang.String destPrimaryKey, java.lang.String originForeignKey, java.lang.String destForeignKey) Creates a new relationship class.
ITable	createTable(java.lang.String name, IFields fields, IUID cLSID, IUID eXTCLSID, java.lang.String configKeyword) Creates a new table.
void	delete() Deletes this dataset.
boolean	equals(java.lang.Object o) Compare this object with another
void	executeSQL(java.lang.String sqlStmt) Executes the specified SQL statement.
boolean	exists() Checks if the workspace exists.
java.lang.String	getBrowseName() The browse name of the dataset.
java.lang.String	getCategory() The category of the dataset.
void	getColumns(java.lang.String tableName, IStringArray[] columnName, IStringArray[] columnType, IVariantArray[] isNullable, ILongArray[] size, ILongArray[] precision, ILongArray[] scale) Returns column information for a table.
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.
java.lang.Object	getConnectionCurrentDateTime() The current DBMS date/time.
int	getConnectionDBMS() The type of DBMS this workspace is connected to.
IPropertySet	getConnectionProperties() The connection properties of the workspace.
java.lang.String	getConnectionServer() The server this workspace is connected to.
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.
IName	getFullName() The associated name object.
java.lang.String	getFunctionName(int sqlFunc) DBMS dependent SQL function names.
int	getGeodatabaseServerClass() The ArcSDE server class.
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() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IEnumBSTR	getKeywords() The list of DBMS specific reserved keywords.
java.lang.String	getName() The name of the Dataset.
java.lang.String	getPathName() The file system full path of the workspace.
IWorkspaceProperty	getProperty(int propertyGroup, int propertyType) Information about this particular property.
IPropertySet	getPropertySet() The set of properties for the dataset.
IQueryDescription	getQueryDescription(java.lang.String query) Get query properties including spatial based on the first record of the query.
IQueryDescription	getQueryDescription2(java.lang.String query, boolean discoverSpatialProperties) Get query properties, optionally including spatial based on the first record of the query.
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.
IStringArray	getTables() Returns names of all the table.
int	getType() The type of the Dataset.
IWorkspace	getWorkspace() The workspace containing this dataset.
IWorkspaceFactory	getWorkspaceFactory() The factory that created the workspace.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isDirectory() TRUE if the workspace is a file system directory.
IDataset	openExtensionDataset(int extensionDatasetType, java.lang.String extensionDatasetName) Opens an existing extension dataset.
IFeatureClass	openFeatureClass(java.lang.String name) Opens an existing feature class.
IFeatureDataset	openFeatureDataset(java.lang.String name) Opens an existing feature dataset.
IFeatureDataset	openFeatureQuery(java.lang.String queryName, IQueryDef queryDef) Opens a feature dataset containing a single feature class defined by the specified Query.
ITable	openQueryClass(java.lang.String name, IQueryDescription queryDescription) Returns a table or a feature class based on a query.
ICursor	openQueryCursor(java.lang.String query) Returns a cursor based on a query.
IRelationshipClass	openRelationshipClass(java.lang.String name) Opens an existing relationship class.
ITable	openRelationshipQuery(IRelationshipClass relClass, boolean joinForward, IQueryFilter srcQueryFilter, ISelectionSet srcSelectionSet, java.lang.String targetColumns, boolean doNotPushJoinToDB) The table of a relationship join query.
ITable	openTable(java.lang.String name) Opens an existing table.
void	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	release() Release this COM object reference
void	rename(java.lang.String name) Renames this Dataset.
void	setBrowseName(java.lang.String name) The browse name of the dataset.
void	setProperty(int propertyGroup, int propertyType, IWorkspaceProperty workspaceProperty) Information about this particular property.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlWorkspace

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

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

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

Throws:

java.io.IOException - if there are interop problems SqlWorkspace theSqlWorkspace = (SqlWorkspace) 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()

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

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

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.

getType

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

The type of the Dataset.

Specified by:

getType in interface IDataset

Specified by:

getType in interface IWorkspace

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

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.

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.

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.

getProperty

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

Information about this particular property.

Specified by:

getProperty in interface IWorkspaceProperties

Parameters:

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

propertyType - The propertyType (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProperty

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

Information about this particular property.

Specified by:

setProperty in interface IWorkspaceProperties

Parameters:

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

propertyType - The propertyType (in)

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

Throws:

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.

getConnectionDBMS

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

The type of DBMS this workspace is connected to.

Specified by:

getConnectionDBMS in interface IDatabaseConnectionInfo2

Returns:

A com.esri.arcgis.geodatabase.esriConnectionDBMS constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionCurrentDateTime

public java.lang.Object getConnectionCurrentDateTime()
                                              throws java.io.IOException,
                                                     AutomationException

The current DBMS date/time.

Specified by:

getConnectionCurrentDateTime in interface IDatabaseConnectionInfo2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeodatabaseServerClass

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

The ArcSDE server class.

Specified by:

getGeodatabaseServerClass in interface IDatabaseConnectionInfo2

Returns:

A com.esri.arcgis.geodatabase.esriGeodatabaseServerClassType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConnectionServer

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

The server this workspace is connected to.

Specified by:

getConnectionServer in interface IDatabaseConnectionInfo2

Returns:

The server

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.

getQueryDescription2

public IQueryDescription getQueryDescription2(java.lang.String query,
                                              boolean discoverSpatialProperties)
                                       throws java.io.IOException,
                                              AutomationException

Get query properties, optionally including spatial based on the first record of the query.

Specified by:

getQueryDescription2 in interface ISqlWorkspace2

Parameters:

query - The query (in)

discoverSpatialProperties - The discoverSpatialProperties (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getQueryDescription

public IQueryDescription getQueryDescription(java.lang.String query)
                                      throws java.io.IOException,
                                             AutomationException

Get query properties including spatial based on the first record of the query.

Specified by:

getQueryDescription in interface ISqlWorkspace

Parameters:

query - The query (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openQueryClass

public ITable openQueryClass(java.lang.String name,
                             IQueryDescription queryDescription)
                      throws java.io.IOException,
                             AutomationException

Returns a table or a feature class based on a query.

Specified by:

openQueryClass in interface ISqlWorkspace

Parameters:

name - The name (in)

queryDescription - A reference to a com.esri.arcgis.geodatabase.IQueryDescription (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.

openQueryCursor

public ICursor openQueryCursor(java.lang.String query)
                        throws java.io.IOException,
                               AutomationException

Returns a cursor based on a query.

Specified by:

openQueryCursor in interface ISqlWorkspace

Parameters:

query - The query (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTables

public IStringArray getTables()
                       throws java.io.IOException,
                              AutomationException

Returns names of all the table.

Specified by:

getTables in interface ISqlWorkspace

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColumns

public void getColumns(java.lang.String tableName,
                       IStringArray[] columnName,
                       IStringArray[] columnType,
                       IVariantArray[] isNullable,
                       ILongArray[] size,
                       ILongArray[] precision,
                       ILongArray[] scale)
                throws java.io.IOException,
                       AutomationException

Returns column information for a table.

Specified by:

getColumns in interface ISqlWorkspace

Parameters:

tableName - The tableName (in)

columnName - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

columnType - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

isNullable - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)

size - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

precision - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

scale - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkDatasetName

public void checkDatasetName(java.lang.String name,
                             IQueryDescription queryDescription,
                             java.lang.String[] newName)
                      throws java.io.IOException,
                             AutomationException

Returns unique name in the workspace.

Specified by:

checkDatasetName in interface ISqlWorkspace

Parameters:

name - The name (in)

queryDescription - A reference to a com.esri.arcgis.geodatabase.IQueryDescription (in)

newName - The newName (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openTable

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

Opens an existing table.

Specified by:

openTable in interface IFeatureWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createTable

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

Creates a new table.

Specified by:

createTable in interface IFeatureWorkspace

Parameters:

name - The name (in)

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

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

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

configKeyword - The configKeyword (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openFeatureClass

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

Opens an existing feature class.

Specified by:

openFeatureClass in interface IFeatureWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFeatureClass

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

Creates a new standalone feature class under the workspace.

Specified by:

createFeatureClass in interface IFeatureWorkspace

Parameters:

name - The name (in)

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

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

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

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

shapeFieldName - The shapeFieldName (in)

configKeyword - The configKeyword (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openFeatureDataset

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

Opens an existing feature dataset.

Specified by:

openFeatureDataset in interface IFeatureWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createFeatureDataset

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

Creates a new feature dataset.

Specified by:

createFeatureDataset in interface IFeatureWorkspace

Parameters:

name - The name (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createQueryDef

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

Create a query definition object.

Specified by:

createQueryDef in interface IFeatureWorkspace

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openFeatureQuery

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

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

Specified by:

openFeatureQuery in interface IFeatureWorkspace

Parameters:

queryName - The queryName (in)

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openRelationshipClass

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

Opens an existing relationship class.

Specified by:

openRelationshipClass in interface IFeatureWorkspace

Parameters:

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createRelationshipClass

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

Creates a new relationship class.

Specified by:

createRelationshipClass in interface IFeatureWorkspace

Parameters:

relClassName - The relClassName (in)

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

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

forwardLabel - The forwardLabel (in)

backwardLabel - The backwardLabel (in)

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

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

isComposite - The isComposite (in)

isAttributed - The isAttributed (in)

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

originPrimaryKey - The originPrimaryKey (in)

destPrimaryKey - The destPrimaryKey (in)

originForeignKey - The originForeignKey (in)

destForeignKey - The destForeignKey (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openRelationshipQuery

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

The table of a relationship join query.

Specified by:

openRelationshipQuery in interface IFeatureWorkspace

Parameters:

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

joinForward - The joinForward (in)

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

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

targetColumns - The targetColumns (in)

doNotPushJoinToDB - The doNotPushJoinToDB (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openExtensionDataset

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

Opens an existing extension dataset.

Specified by:

openExtensionDataset in interface IFeatureWorkspace

Parameters:

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

extensionDatasetName - The extensionDatasetName (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

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.