com.esri.arcgis.schematic
Class INgDataSourceProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.schematic.INgDataSourceProxy
All Implemented Interfaces:
INgDataSource, Externalizable, Serializable

public class INgDataSourceProxy
extends com.esri.arcgis.interop.Dispatch
implements INgDataSource, 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.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  INgDataSourceProxy()
           
  INgDataSourceProxy(Object obj)
           
protected INgDataSourceProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 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.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

INgDataSourceProxy

public INgDataSourceProxy()

INgDataSourceProxy

public INgDataSourceProxy(Object obj)
                   throws IOException
Throws:
IOException

INgDataSourceProxy

protected INgDataSourceProxy(Object obj,
                             String iid)
                      throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getDescription

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

Product Availability

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

Specified by:
getDescription in interface INgDataSource
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

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

Product Availability

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

Specified by:
getName in interface INgDataSource
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public 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.

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

isPersisted

public 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.

Specified by:
isPersisted in interface INgDataSource
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPersisted

public 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.

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

getType

public 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.

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

getObject

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

Product Availability

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

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

setObjectByRef

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

Product Availability

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

Specified by:
setObjectByRef in interface INgDataSource
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

public 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.

Specified by:
getInitString in interface INgDataSource
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInitString

public 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.

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

open

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

Product Availability

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

Specified by:
open in interface INgDataSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRecordset

public 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.

Specified by:
createRecordset in interface INgDataSource
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

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

Product Availability

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

Specified by:
getClassID in interface INgDataSource
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException