com.esri.arcgis.datasourcesGDB.SqlWorkspace
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class SqlWorkspace
Sql workspace
| Constructor Summary | |
|---|---|
SqlWorkspace(Object obj)
Construct a SqlWorkspace using a reference to such an object returned from ArcGIS Engine or Server. |
|
| Method Summary | |
|---|---|
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(String name,
IQueryDescription pQueryDescription,
String[] pNewName)
Returns unique name in the workspace. |
IDataset |
copy(String copyName,
IWorkspace copyWorkspace)
Copies this dataset to a new dataset with the specified name. |
IFeatureClass |
createFeatureClass(String name,
IFields fields,
IUID cLSID,
IUID eXTCLSID,
int featureType,
String shapeFieldName,
String configKeyword)
Creates a new standalone feature class under the workspace. |
IFeatureDataset |
createFeatureDataset(String name,
ISpatialReference spatialReference)
Creates a new feature dataset. |
IQueryDef |
createQueryDef()
Create a query definition object. |
IRelationshipClass |
createRelationshipClass(String relClassName,
IObjectClass originClass,
IObjectClass destinationClass,
String forwardLabel,
String backwardLabel,
int cardinality,
int notification,
boolean isComposite,
boolean isAttributed,
IFields relAttrFields,
String originPrimaryKey,
String destPrimaryKey,
String originForeignKey,
String destForeignKey)
Creates a new relationship class. |
ITable |
createTable(String name,
IFields fields,
IUID cLSID,
IUID eXTCLSID,
String configKeyword)
Creates a new table. |
void |
delete()
Deletes this dataset. |
boolean |
equals(Object o)
Compare this object with another |
void |
executeSQL(String sqlStmt)
Executes the specified SQL statement. |
boolean |
exists()
Checks if the workspace exists. |
String |
getBrowseName()
The browse name of the dataset. |
String |
getCategory()
The category of the dataset. |
void |
getColumns(String tableName,
IStringArray[] ppColumnName,
IStringArray[] ppColumnType,
IVariantArray[] ppIsNullable,
ILongArray[] ppSize,
ILongArray[] ppPrecision,
ILongArray[] ppScale)
Returns column information for a table. |
IEnumConfigurationKeyword |
getConfigurationKeywords()
The available configuration keywords. |
String |
getConnectedDatabase()
The name of the connected database. |
String |
getConnectedUser()
The name of the connected user. |
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. |
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. |
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. |
String |
getInvalidCharacters()
The list of invalid characters used in literals (if any). |
String |
getInvalidStartingCharacters()
The list of invalid characters used in literals (if any). |
IEnumBSTR |
getKeywords()
The list of DBMS specific reserved keywords. |
String |
getName()
The name of the Dataset. |
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(String query)
Get query properties including spatial based on the first record of the query. |
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. |
IFeatureClass |
openFeatureClass(String name)
Opens an existing feature class. |
IFeatureDataset |
openFeatureDataset(String name)
Opens an existing feature dataset. |
IFeatureDataset |
openFeatureQuery(String queryName,
IQueryDef queryDef)
Opens a feature dataset containing a single feature class defined by the specified Query. |
ITable |
openQueryClass(String name,
IQueryDescription pQueryDescription)
Returns a table or a feature class based on a query. |
ICursor |
openQueryCursor(String query)
Returns a cursor based on a query. |
IRelationshipClass |
openRelationshipClass(String name)
Opens an existing relationship class. |
ITable |
openRelationshipQuery(IRelationshipClass relClass,
boolean joinForward,
IQueryFilter srcQueryFilter,
ISelectionSet srcSelectionSet,
String targetColumns,
boolean doNotPushJoinToDB)
The table of a relationship join query. |
ITable |
openTable(String name)
Opens an existing table. |
void |
parseColumnName(String fullName,
String[] dbName,
String[] ownerName,
String[] tableName,
String[] columnName)
Given a column name, determine its qualification parts. |
void |
parseTableName(String fullName,
String[] dbName,
String[] ownerName,
String[] tableName)
Given a table name, determine its qualification parts. |
String |
qualifyColumnName(String tableName,
String columnName)
Given a table name and column name, returns its fully qualified name. |
String |
qualifyTableName(String dbName,
String ownerName,
String tableName)
Given a database, owner, and table name, return its fully qualified name. |
void |
rename(String name)
Renames this Dataset. |
void |
setBrowseName(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 |
| Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
|---|
getJintegraDispatch, release |
| Constructor Detail |
|---|
public SqlWorkspace(Object obj)
throws IOException
obj to SqlWorkspace. *
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
IOException - if there are interop problems
SqlWorkspace theSqlWorkspace = (SqlWorkspace) obj;| Method Detail |
|---|
public boolean equals(Object o)
equals in class Objectpublic int hashCode()
hashCode in class Object
public String getName()
throws IOException,
AutomationException
getName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IName getFullName()
throws IOException,
AutomationException
getFullName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getBrowseName()
throws IOException,
AutomationException
getBrowseName in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setBrowseName(String name)
throws IOException,
AutomationException
setBrowseName in interface IDatasetname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getType()
throws IOException,
AutomationException
// Assume we have a reference to an IfeatureClass (pFeatureClass) IDataset pDataset = null;
pDataset = new IDatasetProxy(pFeatureClass);
System.out.println(pDataset.getName() + " " + pDataset.getType());
if(pFeatureClass != null){
pDataset = pFeatureClass.getFeatureDataset();
System.out.println(pDataset.getName() + " " + pDataset.getType());
}
pDataset = new IDatasetProxy(pDataset.getWorkspace());
System.out.println(pDataset.getName() + " " +
pDataset.getType());
getType in interface IDatasetgetType in interface IWorkspaceIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getCategory()
throws IOException,
AutomationException
IDataset::Category returns a description of the category of the dataset. The description returned from the Category property is the same value that is displayed in the Type column within the Contents tab in ArcCatalog. The value will contain a description of the dataset such as "Topology" prefixed with a description of the type of workspace containing the dataset such as "File Geodatabase".
The description returned from IDataset::Category may change between releases of ArcGIS. In addition to this, returned strings are localized, meaning that code relying on a specific string being provided may fail when deployed with a different version of ArcGIS than it was developed with, or when deployed to a client using a different language than it was developed with.
getCategory in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumDataset getSubsets()
throws IOException,
AutomationException
The Subsets property returns other Dataset objects contained in this dataset.
IDataset::Subsets is not supported for Graph objects such as a Geometric Network. To return the feature classes contained in a Geometric Network, use the IFeatureClassContainer interface.
getSubsets in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IWorkspace getWorkspace()
throws IOException,
AutomationException
The Workspace property returns the containing workspace for this dataset.
getWorkspace in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getPropertySet()
throws IOException,
AutomationException
The PropertySet property is used to return any additional intrinsic properties (but not metadata properties) that may apply to the dataset. One use of this property is to distinguish between the types of File Geodatabase datafile formats. If called on a Feature Class or Table in a File Geodatabase the Datafile Format property can either be esriFGDBStandardDatafile or esriFGDBCompressedDatafile.
Most datasets do not implement this property and will either raise an error or return a null value if it's called. There are a handful of exceptions that will return property sets; these include the datasets from file geodatabases (as mentioned above) and coverages.
Examples of intrinsic properties for which explicit methods exist include the SpatialReference and the Extent methods available on the IGeoDataset interface. In most cases this PropertySet will be empty.
IDataset::PropertySet is not supported for Graph objects such as a Geometric Network.
getPropertySet in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canCopy()
throws IOException,
AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
The CanCopy method is supported by:
canCopy in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IDataset copy(String copyName,
IWorkspace copyWorkspace)
throws IOException,
AutomationException
IDataset::Copy should only be used with datasets from file-based data sources, such as shapefiles and coverages.
copy in interface IDatasetcopyName - The copyName (in)copyWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canDelete()
throws IOException,
AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canDelete in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void delete()
throws IOException,
AutomationException
Certain feature classes, such as network and topology feature classes, cannot be deleted until their containing objects are deleted.
delete in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean canRename()
throws IOException,
AutomationException
The CanCopy, CanDelete, and CanRename properties are meant to be used in conjunction with the Copy, Delete, and Rename methods and signify whether a dataset is supported by these methods. For example, you may not delete or rename a network feature class nor can you use the Copy method on a Geodatabase feature class. To copy Geodatabase datasets, including feature classes, geometric networks, topologies, etc., use the IGeoDBDataTransfer interface.
canRename in interface IDatasetIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void rename(String name)
throws IOException,
AutomationException
IDataset::Rename does not support the renaming of Graph objects such as a Geometric Network. In addition, certain feature classes, such as network feature classes, cannot be renamed.
rename in interface IDatasetname - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IPropertySet getConnectionProperties()
throws IOException,
AutomationException
The ConnectionProperties property of a workspace returns the set of named connection properties for this workspace.
getConnectionProperties in interface IWorkspaceIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IWorkspaceFactory getWorkspaceFactory()
throws IOException,
AutomationException
The WorkspaceFactory property can be used to get a reference back to the workspace factory for this workspace.
getWorkspaceFactory in interface IWorkspaceIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumDataset getDatasets(int datasetType)
throws IOException,
AutomationException
getDatasets in interface IWorkspacedatasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumDatasetName getDatasetNames(int datasetType)
throws IOException,
AutomationException
getDatasetNames in interface IWorkspacedatasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getPathName()
throws IOException,
AutomationException
getPathName in interface IWorkspaceIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean isDirectory()
throws IOException,
AutomationException
isDirectory in interface IWorkspaceIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean exists()
throws IOException,
AutomationException
This method can be used with workspaces from file-based data sources to detect if they've been deleted by another application. For example, a shapefile workspace is a directory and can be deleted while the workspace is open.
exists in interface IWorkspaceIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void executeSQL(String sqlStmt)
throws IOException,
AutomationException
The ExecuteSQL method can be used to send an arbitrary SQL statement to the underlying database for execution. The statement can be any DDL (data definition language) or DML (data manipulation language) statement but can not return any result sets. The syntax for the SQL is as required by the underlying database. The workspace supports an optional ISQLSyntax interface that provides information to applications on aspects of the SQL Syntax for the underlying database.
To determine if a workspace supports the ExecutesSQL method, an application can check the value of the canExecuteSQLworkspace property via the optional IWorkspaceProperties interface. In general, this method is only supported on local and remote database workspaces.
executeSQL in interface IWorkspacesqlStmt - The sqlStmt (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IWorkspaceProperty getProperty(int propertyGroup,
int propertyType)
throws IOException,
AutomationException
getProperty in interface IWorkspacePropertiespropertyGroup - A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)propertyType - The propertyType (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void setProperty(int propertyGroup,
int propertyType,
IWorkspaceProperty workspaceProperty)
throws IOException,
AutomationException
setProperty in interface IWorkspacePropertiespropertyGroup - A com.esri.arcgis.geodatabase.esriWorkspacePropertyGroupType constant (in)propertyType - The propertyType (in)workspaceProperty - A reference to a com.esri.arcgis.geodatabase.IWorkspaceProperty (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String qualifyTableName(String dbName,
String ownerName,
String tableName)
throws IOException,
AutomationException
Applications should use the QualifyTableName and QualifyColumnName methods to construct fully qualified dataset and column names.
qualifyTableName in interface ISQLSyntaxdbName - The dbName (in)ownerName - The ownerName (in)tableName - The tableName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String qualifyColumnName(String tableName,
String columnName)
throws IOException,
AutomationException
Applications should use the QualifyTableName and QualifyColumnName methods to construct fully qualified dataset and column names.
qualifyColumnName in interface ISQLSyntaxtableName - The tableName (in)columnName - The columnName (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void parseTableName(String fullName,
String[] dbName,
String[] ownerName,
String[] tableName)
throws IOException,
AutomationException
Applications should use the ParseTableName method to split the fully qualified name of a table into its components (database, owner, table). ParseTableName can also be used to return the components of any fully qualified name of a dataset such as feature classes, feature datasets, geometric networks and topologies.
Applications that wish to be RDBMS independent should not assume that ‘.’ is the delimiter used to separate the components of a fully qualified dataset name. Use the QualifyTableName method to determine the qualified name of a dataset for a given workspace.
The FullName parameter refers to the fully qualified name of the dataset and is returned by the IDataset::Name property for a dataset in a geodatabase and the IDatasetName::Name property for a dataset name object. Both methods return the fully qualified name for the dataset.
Empty strings will be returned for arguments that do not apply to the underlying DBMS. For example, supplying a FullName parameter of "MyTable" to a Personal or File Geodatabase will result in:
dbName = ""
ownerName = ""
TableName = "MyTable"
While supplying a FullName parameter of "gdb.MyTable" to an ArcSDE Geodatabase on Oracle will result in:
dbName = ""
ownerName = "gdb"
TableName = "MyTable"
parseTableName in interface ISQLSyntaxfullName - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void parseColumnName(String fullName,
String[] dbName,
String[] ownerName,
String[] tableName,
String[] columnName)
throws IOException,
AutomationException
Applications should use the ParseColumnName method to split the fully qualified name for a column in a table into its components (database, owner, table, column).
Applications that wish to be RDBMS independent should not assume that ‘.’ is the delimiter used to separate the components of a fully qualified dataset name. Use the QualifyColumnName method to determine the qualified name of a column of a table for a given workspace.
The FullName paramter can be returned from the IDataset::Name property for a dataset in a Geodatabase and the IDatasetName::Name property for a dataset name object. Both methods return the fully qualified name for the dataset (the name object for the dataset is itself obtained using the IDataset::FullName property).
Empty strings will be returned for arguments that do not apply to the underlying DBMS. For example, supplying a FullName parameter of "gdb.Greeley_Parcels_1.AREA" to an ArcSDE Geodatabase on Oracle will result in:
dbName = ""
ownerName = "gdb"
TableName = "Greeley_Parcels_1"
columnName = "AREA"
parseColumnName in interface ISQLSyntaxfullName - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getFunctionName(int sqlFunc)
throws IOException,
AutomationException
getFunctionName in interface ISQLSyntaxsqlFunc - A com.esri.arcgis.geodatabase.esriSQLFunctionName constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getSpecialCharacter(int sqlSC)
throws IOException,
AutomationException
The GetSpecialCharacter can be used to return the DBMS dependent character that represents an SQL special character, including the following:
• esriSQL_WildcardManyMatch ( % in SQL_92, * in Jet 4.0)
• esriSQL_WildcardSingleMatch ( _ in SQL_92, ? in Jet 4.0)
• esriSQL_DelimitedIdentifierPrefix ( " in SQL_92, [ in Jet 4.0)
• esriSQL_DelimitedIdentifierSuffix (" in SQL_92, ] in Jet 4.0)
getSpecialCharacter in interface ISQLSyntaxsqlSC - A com.esri.arcgis.geodatabase.esriSQLSpecialCharacters constant (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSupportedPredicates()
throws IOException,
AutomationException
GetSupportedPredicates returns a Long value that indicates which of the esriSQLPredicates are supported.
A value of -1 indicates that all predicates are supported by the workspace, while a value of 0 indicates that no predicates are supported by the workspace. Bitwise AND operations can be used with the esriSQLPredicates enumeration's values to determine support for individual predicates.
getSupportedPredicates in interface ISQLSyntaxIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getSupportedClauses()
throws IOException,
AutomationException
GetSupportedClauses returns a Long value that indicates which of the esriSQLClauses are supported.
A value of -1 indicates that all clauses are supported by the workspace, while a value of 0 indicates that no clauses are supported by the workspace. Bitwise AND operations can be used with the esriSQLClauses enumeration's values to determine support for individual clauses.
getSupportedClauses in interface ISQLSyntaxIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean getIdentifierCase()
throws IOException,
AutomationException
getIdentifierCase in interface ISQLSyntaxIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean getDelimitedIdentifierCase()
throws IOException,
AutomationException
getDelimitedIdentifierCase in interface ISQLSyntaxIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public boolean getStringComparisonCase()
throws IOException,
AutomationException
getStringComparisonCase in interface ISQLSyntaxIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumBSTR getKeywords()
throws IOException,
AutomationException
getKeywords in interface ISQLSyntaxIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getInvalidCharacters()
throws IOException,
AutomationException
getInvalidCharacters in interface ISQLSyntaxIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getInvalidStartingCharacters()
throws IOException,
AutomationException
getInvalidStartingCharacters in interface ISQLSyntaxIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getConnectionDBMS()
throws IOException,
AutomationException
Returns an enumeration value corresponding to the connected DBMS. This might be particularly useful when implementing code that must access a number of different remote database types and depending on the underlying DBMS, change the code accordingly.
getConnectionDBMS in interface IDatabaseConnectionInfo2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public Object getConnectionCurrentDateTime()
throws IOException,
AutomationException
getConnectionCurrentDateTime in interface IDatabaseConnectionInfo2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public int getGeodatabaseServerClass()
throws IOException,
AutomationException
getGeodatabaseServerClass in interface IDatabaseConnectionInfo2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getConnectionServer()
throws IOException,
AutomationException
getConnectionServer in interface IDatabaseConnectionInfo2IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getConnectedDatabase()
throws IOException,
AutomationException
If the underlying DBMS does not support multiple databases or is a Personal or File Geodatabase, the ConnectedDatabase property will return an empty string.
getConnectedDatabase in interface IDatabaseConnectionInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public String getConnectedUser()
throws IOException,
AutomationException
If used with a Personal or File Geodatabase, the ConnectedUser property will return an empty string.
getConnectedUser in interface IDatabaseConnectionInfoIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IQueryDescription getQueryDescription(String query)
throws IOException,
AutomationException
getQueryDescription in interface ISqlWorkspacequery - The query (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable openQueryClass(String name,
IQueryDescription pQueryDescription)
throws IOException,
AutomationException
If ID mapping was defined in the query description passed into this method, the returned query class will include a virtual column containing unique IDs. Aside from cases where conflicts will occur, this column is named "ESRI_OID".
openQueryClass in interface ISqlWorkspacename - The name (in)pQueryDescription - A reference to a com.esri.arcgis.geodatabase.IQueryDescription (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ICursor openQueryCursor(String query)
throws IOException,
AutomationException
A query cursor generally behaves like a non-recycling search cursor that returns read-only rows.
openQueryCursor in interface ISqlWorkspacequery - The query (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IStringArray getTables()
throws IOException,
AutomationException
getTables in interface ISqlWorkspaceIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void getColumns(String tableName,
IStringArray[] ppColumnName,
IStringArray[] ppColumnType,
IVariantArray[] ppIsNullable,
ILongArray[] ppSize,
ILongArray[] ppPrecision,
ILongArray[] ppScale)
throws IOException,
AutomationException
getColumns in interface ISqlWorkspacetableName - The tableName (in)ppColumnName - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)ppColumnType - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)ppIsNullable - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)ppSize - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)ppPrecision - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)ppScale - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void checkDatasetName(String name,
IQueryDescription pQueryDescription,
String[] pNewName)
throws IOException,
AutomationException
checkDatasetName in interface ISqlWorkspacename - The name (in)pQueryDescription - A reference to a com.esri.arcgis.geodatabase.IQueryDescription (in)pNewName - The pNewName (out: use single element array)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public void interfaceSupportsErrorInfo(GUID riid)
throws IOException,
AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo in interface ISupportErrorInforiid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable openTable(String name)
throws IOException,
AutomationException
openTable in interface IFeatureWorkspacename - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable createTable(String name,
IFields fields,
IUID cLSID,
IUID eXTCLSID,
String configKeyword)
throws IOException,
AutomationException
The CreateTable method can be used to create a new table or object class in the workspace.
The optional CLSID and EXTCLSID parameters allow the calling application to specify the GUIDs for the objects that implement the instance and the class extension behavior for an object class. If no CLSID is passed in, then the resulting table is not registered in the geodatabase object class data dictionary (It will support the IObjectClass interface but will have an ObjectClassID of –1). Valid values for CLSID are esriGeoDatabase.Object or any non-spatial object that extends esriGeoDatabase.Object. CLSID must be set in order to apply a class extension with the EXTCLSID parameter.
The Fields object passed to the Fields parameter should not be an object retrieved from another class. If the new class is going to have the same fields as an existing class, cast the existing class' fields collection to the IClone interface, clone it, and use the cloned fields collection as input for this method.
The optional configurationKeyword parameter allows the application to control the physical layout for this table in the underlying RDBMS. For example, in an Oracle database, the configuration keyword controls the tablespace in which the table is created, the initial and next extents, and other properties. The configuration keywords for an ArcSDE instance are set up by the ArcSDE data administrator, the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfiguration interface.
Note: Table or feature class names with the following prefixes are not supported:
createTable in interface IFeatureWorkspacename - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFeatureClass openFeatureClass(String name)
throws IOException,
AutomationException
The OpenFeatureClass method can be used to open any existing feature class in the workspace given its fully qualified name. Note that every feature class in a geodatabase has a unique fully qualified name, and the OpenFeatureClass method can be used to directly open feature classes that are part of a feature dataset (the feature dataset name does not need to be specified).
Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable). ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a feature class. Use the NameExists method on the IWorkspace2 interface to determine if a feature class with the appropriate name exists in a geodatabase.
Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.
openFeatureClass in interface IFeatureWorkspacename - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFeatureClass createFeatureClass(String name,
IFields fields,
IUID cLSID,
IUID eXTCLSID,
int featureType,
String shapeFieldName,
String configKeyword)
throws IOException,
AutomationException
The CreateFeatureClass method can be used to create a stand-alone feature class that is not part of a feature dataset. It takes, in addition to all the parameters that CreateTable takes, an esriFeatureType parameter that specifies the category of features to be stored in this feature class (i.e., esriFTSimple, esriFTComplexEdgeFeature) and a shape field name. The shape field name identifies the name of the field in the input fields collection that represents the shape field for the feature class.
The Fields object passed to the Fields parameter should not be an object retrieved from another class. If the new class is going to have the same fields as an existing class, cast the existing class' fields collection to the IClone interface, clone it, and use the cloned fields collection as input for this method.
The GeometryDef object associated with the shape field object must be fully setup with a spatial reference, grid properties, and the geometry type before calling CreateFeatureClass.
The following esriGeometryType enumeration values represent the valid geometry types for a new feature class' GeometryDef object: esriGeometryPoint, esriGeometryMultipoint, esriGeometryPolyline, esriGeometryPolygon, and esriGeometryMultiPatch.
If the feature class is being created in geodatabase then the fields collection must contain, at a minimum, an Object ID field and a Shape field. The required fields can be obtained from the class description for the type of object you wish to create (see the RequiredFields property on IObjectClassDescription).
The CLSID parameter is used to specify what type of feature will be contained by the class. If a null value is passed in for the CLSID, the geodatabase will return Feature instances from the class. In most cases, this is the desired behavior. If the feature class is used to store custom features, the GUID of the custom feature should be provided. Alternatively, the IClassSchemaEdit interface can be used to change the feature class' CLSID following creation.
The EXTCLSID parameter is used to specify what class will be instantiated as the feature class extension. This object must at least support the IClassExtension interface. If a null value is passed in for the EXTCLSID parameter, the feature class will not have a class extension associated with it. Since class extensions are not required, this is often the desired behavior. If the feature class should have an associated extension, the GUID of the class extension should be provided. Alternatively, the IClassSchemaEdit interface can be used to associate a class extension following creation.
The configurationKeywordparameter allows the application to control the physical layout for this table in the underlying RDBMS. For example, in the case of an Oracle database, the configuration keyword controls the tablespace in which the table is created, the initial and next extents, and other properties. The configuration keywords for an ArcSDE instance are set up by the ArcSDE data administrator, and the list of available keywords supported by a workspace may be obtained using the IWorkspaceConfigurationinterface.
If the workspace the feature class will be created in is a pre-9.2 geodatabase, you must ensure the GeometryDef references a low precision spatial reference. 9.1 and earlier versions of the geodatabase only support low precision spatial references, while 9.2 geodatabases require high precision spatial references. Use IControlPrecision2::IsHighPrecision to manage the precision level of the spatial reference used to create the feature class. Use the IGeodatabaseRelease interface to determine the release of the geodatabase.
Developers should be aware that calling this method on a shapefile workspace when a shapefile of the same name already exists will cause the existing shapefile to be deleted. To prevent this, check for the existence of a shapefile prior to calling this method.
Note:Table or feature class names with the following prefixes are not supported:
createFeatureClass in interface IFeatureWorkspacename - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFeatureDataset openFeatureDataset(String name)
throws IOException,
AutomationException
The OpenFeatureDataset method can be used to open any existing feature dataset in the workspace given its fully qualified name.
Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable). ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a feature dataset.
openFeatureDataset in interface IFeatureWorkspacename - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFeatureDataset createFeatureDataset(String name,
ISpatialReference spatialReference)
throws IOException,
AutomationException
The CreateFeatureDataset method can be used to create a new FeatureDataset given its name and spatial reference. Methods supported by the returned feature dataset allow creation of feature classes in the feature dataset.
If the workspace the FeatureDataset will be created in is a pre-9.2 Geodatabase, you must ensure the spatial reference is a low precision spatial reference. 9.1 and earlier versions of the Geodatabase only support low precision spatial references, while 9.2 Geodatabases require high precision spatial references. Use IControlPrecision2::IsHighPrecision to manage the precision level of the spatial reference used to create the FeatureDataset. Use the IGeodatabaseRelease interface to determine the release of the geodatabase
createFeatureDataset in interface IFeatureWorkspacename - The name (in)spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IQueryDef createQueryDef()
throws IOException,
AutomationException
The CreateQueryDef method can be used to create a new query definition object that can be evaluated by returning a cursor.
createQueryDef in interface IFeatureWorkspaceIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IFeatureDataset openFeatureQuery(String queryName,
IQueryDef queryDef)
throws IOException,
AutomationException
The OpenFeatureQuery can be used to open a virtual feature class whose definition is based on a QueryDef created using the CreateQueryDef method. The QueryDef can involve multiple tables as long as one of them is a feature class; the resulting virtual feature class can be used to construct a feature layer that can be added to a map. The shape column is required as part of the SubFields parameter of the QueryDef.
openFeatureQuery in interface IFeatureWorkspacequeryName - The queryName (in)queryDef - A reference to a com.esri.arcgis.geodatabase.IQueryDef (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRelationshipClass openRelationshipClass(String name)
throws IOException,
AutomationException
The OpenRelationshipClass method can be used to open any existing relationship class in the workspace given its fully qualified name.
Use the IDatabaseConnectionInfo interface to determine the User and Database (if applicable). ISQLSyntax::QualifyTableName can be used to determine the fully qualified name for a relationship class.
openRelationshipClass in interface IFeatureWorkspacename - The name (in)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IRelationshipClass createRelationshipClass(String relClassName,
IObjectClass originClass,
IObjectClass destinationClass,
String forwardLabel,
String backwardLabel,
int cardinality,
int notification,
boolean isComposite,
boolean isAttributed,
IFields relAttrFields,
String originPrimaryKey,
String destPrimaryKey,
String originForeignKey,
String destForeignKey)
throws IOException,
AutomationException
The CreateRelationshipClass method can be used to create a new stand-alone relationship class that is not part of a feature dataset. The relationship class is implemented as a separate data table whose name is the name of the relationship class if the cardinality is many-to-many or if the relationship class is attributed. The relAttribFields parameter is optional, and a null value may be passed in for non-attributed relationship classes.
Many-to-many or attributed relationship classes require specification of all four key fields—the OriginPrimaryKey and the destPrimaryKey parameters are the primary key fields for the origin and destination object classes. The OriginForeignKey and destForeignKey parameters are the names of the corresponding foreign keys that will be created in the data table representing the relationship class. If the relationship class is one-to-one or one-to-many and not attributed, then the relationship class is implemented as a foreign key field in the destination object class (the OriginForeignKey) that references the primary key field in the origin object class (the OriginPrimaryKey). In this case, the OriginPrimaryKey, the OriginForeignKey, and the destPrimaryKey must be supplied.
The Fields object passed to the relAttrFields parameter should not be an object retrieved from another class. If the new class is going to have the same fields as an existing class, cast the existing class' fields collection to the IClone interface, clone it, and use the cloned fields collection as input for this method.
createRelationshipClass in interface IFeatureWorkspacerelClassName - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public ITable openRelationshipQuery(IRelationshipClass relClass,
boolean joinForward,
IQueryFilter srcQueryFilter,
ISelectionSet srcSelectionSet,
String targetColumns,
boolean doNotPushJoinToDB)
throws IOException,
AutomationException
openRelationshipQuery in interface IFeatureWorkspacerelClass - 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)
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
public IEnumConfigurationKeyword getConfigurationKeywords()
throws IOException,
AutomationException
Returns an enumeration of all the of the configuration keywords for an ArcSDE or File geodatabase workspace.
getConfigurationKeywords in interface IWorkspaceConfigurationIOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||