com.esri.arcgis.schematic
Class NgADOExtendedDataSource

java.lang.Object
  com.esri.arcgis.schematic.NgADOExtendedDataSource

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INgDataSource, INgDataSourceDesign, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class NgADOExtendedDataSource
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgDataSource, IPersist, IPersistStream, INgDataSourceDesign, ISupportErrorInfo, Externalizable

ADO extended datasource object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NgADOExtendedDataSource()
Constructs a NgADOExtendedDataSource using ArcGIS Engine.

NgADOExtendedDataSource(Object obj)
Construct a NgADOExtendedDataSource using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

INgRecordset	createRecordset(String request) Create a recordset by executing the 'request' request from the datasource.
boolean	equals(Object o) Compare this object with another
String	getClassID() CLSID of the schematic datasource.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
INgRecordset	getTable(String name) Table named 'name' as a recordset.
INgNames	getTableNames(boolean includeSystemTable) List of the table names contained in the datasource.
int	getType() Type of the connection used to connect the datasource.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isPersisted() Indicates if the datasource must be automatically reopened by the framework.
void	load(IStream pstm) load
void	open() Opens the datasource.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
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 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

NgADOExtendedDataSource

public NgADOExtendedDataSource()
                        throws IOException,
                               UnknownHostException

Constructs a NgADOExtendedDataSource using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NgADOExtendedDataSource

public NgADOExtendedDataSource(Object obj)
                        throws IOException

Construct a NgADOExtendedDataSource using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgADOExtendedDataSource.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems NgADOExtendedDataSource theNgADOExtendedDataSource = (NgADOExtendedDataSource) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

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.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTableNames

public INgNames getTableNames(boolean includeSystemTable)
                       throws IOException,
                              AutomationException

List of the table names contained in the datasource. By default, this list doesn't contain the system tables (That is, the includeSystemTable option is FALSE by default).

Product Availability

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

Specified by:

getTableNames in interface INgDataSourceDesign

Parameters:

includeSystemTable - The includeSystemTable (in, optional, pass false if not required)

Returns:

A reference to a com.esri.arcgis.schematic.INgNames

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public INgRecordset getTable(String name)
                      throws IOException,
                             AutomationException

Table named 'name' as a recordset.

Product Availability

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

Specified by:

getTable in interface INgDataSourceDesign

Parameters:

name - The name (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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

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

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException