com.esri.arcgis.schematic
Class NgDAORecordset

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INgRecordset, Serializable

public class NgDAORecordset
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgRecordset

DAO Jet recordset object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

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

Method Summary

void	close() Closes the recordset.
boolean	equals(Object o) Compare this object with another
void	findRecord(String identifier) Points to the 'identifier' record in the recordset.
INgDataSource	getDataSource() Datasource related to the recordset.
String	getIdentifier() List of the field values that defines the object identifier.
INgParameters	getParameters() List of the parameters names specified for the recordset.
Object	getValue(String fieldName) Value of the field named 'FieldName' in the recordset.
int	hashCode() the hashcode for this object
boolean	isBOF() Indicates if the current record is positioned before the first record in the recordset.
boolean	isEOF() Indicates if the current record is positioned after the first record in the recordset.
void	moveFirst() Points to the first record in the recordset.
void	moveNext() Moves to the next record in the recordset.
void	open() Opens the recordset.
void	refresh() Refreshes the recordset; that is, reexecute the query.
void	setIdentifierFieldNames(INgNames names) List of the field names used to build the object identifier.
void	setParameterValues(INgValues values) List of the parameters values for the recordset.
void	update() Updates the recordset.

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

NgDAORecordset

public NgDAORecordset(Object obj)
               throws IOException

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

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

Throws:

IOException - if there are interop problems NgDAORecordset theNgDAORecordset = (NgDAORecordset) obj;

Method Detail

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

getDataSource

public INgDataSource getDataSource()
                            throws IOException,
                                   AutomationException

Datasource related to the recordset.

Product Availability

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

Specified by:

getDataSource in interface INgRecordset

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

public Object getValue(String fieldName)
                throws IOException,
                       AutomationException

Value of the field named 'FieldName' in the recordset.

Product Availability

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

Specified by:

getValue in interface INgRecordset

Parameters:

fieldName - The fieldName (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIdentifier

public String getIdentifier()
                     throws IOException,
                            AutomationException

List of the field values that defines the object identifier.

Product Availability

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

Specified by:

getIdentifier in interface INgRecordset

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

public INgParameters getParameters()
                            throws IOException,
                                   AutomationException

List of the parameters names specified for the recordset.

Product Availability

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

Specified by:

getParameters in interface INgRecordset

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public void open()
          throws IOException,
                 AutomationException

Opens the recordset.

Product Availability

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

Specified by:

open in interface INgRecordset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#close()

close

public void close()
           throws IOException,
                  AutomationException

Closes the recordset.

Product Availability

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

Specified by:

close in interface INgRecordset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#open()

refresh

public void refresh()
             throws IOException,
                    AutomationException

Refreshes the recordset; that is, reexecute the query.

Product Availability

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

Specified by:

refresh in interface INgRecordset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#update()

update

public void update()
            throws IOException,
                   AutomationException

Updates the recordset. Uses to update a field value contained in the recordset.

Product Availability

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

Specified by:

update in interface INgRecordset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#refresh()

setParameterValues

public void setParameterValues(INgValues values)
                        throws IOException,
                               AutomationException

List of the parameters values for the recordset.

Product Availability

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

Specified by:

setParameterValues in interface INgRecordset

Parameters:

values - A reference to a com.esri.arcgis.schematic.INgValues (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIdentifierFieldNames

public void setIdentifierFieldNames(INgNames names)
                             throws IOException,
                                    AutomationException

List of the field names used to build the object identifier.

Product Availability

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

Specified by:

setIdentifierFieldNames in interface INgRecordset

Parameters:

names - A reference to a com.esri.arcgis.schematic.INgNames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveFirst

public void moveFirst()
               throws IOException,
                      AutomationException

Points to the first record in the recordset.

Product Availability

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

Specified by:

moveFirst in interface INgRecordset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#isBOF(), com.esri.arcgis.schematic.INgRecordSet#moveNext(), com.esri.arcgis.schematic.INgRecordSet#isEOF(), com.esri.arcgis.schematic.INgRecordSet#findRecord(String)

moveNext

public void moveNext()
              throws IOException,
                     AutomationException

Moves to the next record in the recordset.

Product Availability

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

Specified by:

moveNext in interface INgRecordset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#isBOF(), com.esri.arcgis.schematic.INgRecordSet#moveFirst(), com.esri.arcgis.schematic.INgRecordSet#isEOF(), com.esri.arcgis.schematic.INgRecordSet#findRecord(String)

findRecord

public void findRecord(String identifier)
                throws IOException,
                       AutomationException

Points to the 'identifier' record in the recordset.

Product Availability

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

Specified by:

findRecord in interface INgRecordset

Parameters:

identifier - The identifier (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#isBOF(), com.esri.arcgis.schematic.INgRecordSet#moveFirst(), com.esri.arcgis.schematic.INgRecordSet#moveNext(), com.esri.arcgis.schematic.INgRecordSet#isEOF()

isBOF

public boolean isBOF()
              throws IOException,
                     AutomationException

Indicates if the current record is positioned before the first record in the recordset.

Product Availability

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

Specified by:

isBOF in interface INgRecordset

Returns:

The bof

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#moveFirst(), com.esri.arcgis.schematic.INgRecordSet#moveNext(), com.esri.arcgis.schematic.INgRecordSet#isEOF()

isEOF

public boolean isEOF()
              throws IOException,
                     AutomationException

Indicates if the current record is positioned after the first record in the recordset.

Product Availability

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

Specified by:

isEOF in interface INgRecordset

Returns:

The eof

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#isBOF(), com.esri.arcgis.schematic.INgRecordSet#moveFirst(), com.esri.arcgis.schematic.INgRecordSet#moveNext()