com.esri.arcgis.schematic
Interface INgDataSource

All Superinterfaces:
Serializable
All Known Implementing Classes:
INgDataSourceProxy, NgADODataSource, NgADOExtendedDataSource, NgDAOJetEngineDataSource, NgDAOOdbcDirectDataSource, SchematicAccessGDB, SchematicFileGDB, SchematicOleDBGDB, SchematicSdeGDB

public interface INgDataSource
extends Serializable

Provides access to members that control the datasource.

Description

The data source defines the data used as input to or output from the schematic diagrams and their contents (that is, the elements contained in the diagrams). Supported data sources include any type of database (Access, SDE, ESRI geodatabase...).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 INgRecordset createRecordset(String request)
          Create a recordset by executing the 'request' request from the datasource.
 String getClassID()
          CLSID of the schematic datasource.
 String getDescription()
          Description of the datasource.
 String getInitString()
          Name of the UDL Microsoft component used for connecting to the database.
 String getName()
          Name allowing the datasource to be referenced.
 Object getObject()
          COM object related to the datasource.
 int getType()
          Type of the connection used to connect the datasource.
 boolean isPersisted()
          Indicates if the datasource must be automatically reopened by the framework.
 void open()
          Opens the datasource.
 void setInitString(String pVal)
          Name of the UDL Microsoft component used for connecting to the database.
 void setName(String pVal)
          Name allowing the datasource to be referenced.
 void setObjectByRef(Object pVal)
          COM object related to the datasource.
 void setPersisted(boolean pVal)
          Indicates if the datasource must be automatically reopened by the framework.
 

Method Detail

getDescription

String getDescription()
                      throws IOException,
                             AutomationException
Description of the datasource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException
Name allowing the datasource to be referenced.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

void setName(String pVal)
             throws IOException,
                    AutomationException
Name allowing the datasource to be referenced.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPersisted

boolean isPersisted()
                    throws IOException,
                           AutomationException
Indicates if the datasource must be automatically reopened by the framework.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPersisted

void setPersisted(boolean pVal)
                  throws IOException,
                         AutomationException
Indicates if the datasource must be automatically reopened by the framework.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

int getType()
            throws IOException,
                   AutomationException
Type of the connection used to connect the datasource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A com.esri.arcgis.schematic.esriNgDataSourceType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObject

Object getObject()
                 throws IOException,
                        AutomationException
COM object related to the datasource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectByRef

void setObjectByRef(Object pVal)
                    throws IOException,
                           AutomationException
COM object related to the datasource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInitString

String getInitString()
                     throws IOException,
                            AutomationException
Name of the UDL Microsoft component used for connecting to the database.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInitString

void setInitString(String pVal)
                   throws IOException,
                          AutomationException
Name of the UDL Microsoft component used for connecting to the database.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

open

void open()
          throws IOException,
                 AutomationException
Opens the datasource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRecordset

INgRecordset createRecordset(String request)
                             throws IOException,
                                    AutomationException
Create a recordset by executing the 'request' request from the datasource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
request - The request (in)
Returns:
A reference to a com.esri.arcgis.schematic.INgRecordset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

String getClassID()
                  throws IOException,
                         AutomationException
CLSID of the schematic datasource.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.