com.esri.arcgis.geodatabase
Class RecordSet

java.lang.Object
  com.esri.arcgis.geodatabase.RecordSet

All Implemented Interfaces:

IRecordSet, IRecordSet2, IRecordSetInit, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class RecordSet
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRecordSet, IRecordSet2, IRecordSetInit, IXMLSerialize, IPersist, IPersistStream, IClone, Externalizable

Esri Record Set object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RecordSet()
Constructs a RecordSet using ArcGIS Engine.

RecordSet(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RecordSet theRecordSet = (RecordSet) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
IRowBuffer	createRowBuffer() Creates a row buffer that can be used with an insert cursor.
void	createTable(IFields fields) Creates an empty table or feature class for a Recordset.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	detachTable() Detach Recordset from table and apply the subfield of QueryFilter.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
ICursor	getCursor(boolean recycling) A cursor over the rows or features in the recordset.
IFields	getFields() The fields of the recordset.
int	getMaxRecordCount() The maximum number of records for the recordset.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITable	getTable() The source table or feature class for the recordset.
int	hashCode() the hashcode for this object
ICursor	insert() Returns a cursor that can be used to insert new rows.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isFeatureCollection() Indicates if the recordset is a feature collection.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
ITable	saveAsTable(IWorkspace workspace, String tableName) Saves the recordset to a table of feature class in the provided workspace.
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setMaxRecordCount(int maxRecordCount) The maximum number of records for the recordset.
void	setSourceQueryDef(IQueryDef queryDef) Sets the source QueryDef for a Recordset.
void	setSourceTable(ITable table, IQueryFilter queryFilter) Sets the source table or feature class for a Recordset.
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

RecordSet

public RecordSet()
          throws IOException,
                 UnknownHostException

Constructs a RecordSet using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RecordSet

public RecordSet(Object obj)
          throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RecordSet theRecordSet = (RecordSet) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

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

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

The fields of the recordset.

Remarks

When using a recordset class, the Fields property is used to return the fields in the RecordSet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFields in interface IRecordSet

Returns:

A reference to a com.esri.arcgis.geodatabase.IFields

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCursor

public ICursor getCursor(boolean recycling)
                  throws IOException,
                         AutomationException

A cursor over the rows or features in the recordset.

Product Availability

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

Specified by:

getCursor in interface IRecordSet

Parameters:

recycling - The recycling (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ICursor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFeatureCollection

public boolean isFeatureCollection()
                            throws IOException,
                                   AutomationException

Indicates if the recordset is a feature collection.

Remarks

When using a recordset class, the IsFeatureCollection property is used to return true and is read only if the RecordSet is a feature collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFeatureCollection in interface IRecordSet

Returns:

The isFeatureCollection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws IOException,
                       AutomationException

The source table or feature class for the recordset.

Remarks

When using a recordset class, the Table property is used to return the source table or feature class for a RecordSet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTable in interface IRecordSet

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAsTable

public ITable saveAsTable(IWorkspace workspace,
                          String tableName)
                   throws IOException,
                          AutomationException

Saves the recordset to a table of feature class in the provided workspace.

Remarks

SaveAsTable will save the recordset into the specified table or feature class in the provided workspace. SaveAsTable supports Personal, File and ArcSDE geodatabases as well as shapefile workspaces.

Product Availability

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

Specified by:

saveAsTable in interface IRecordSet2

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IWorkspace (in)

tableName - The tableName (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detachTable

public void detachTable()
                 throws IOException,
                        AutomationException

Detach Recordset from table and apply the subfield of QueryFilter.

Remarks

When using a record set, the DetachTable property is used to detach a recordset from a table and apply the subfield of a query filter.

Product Availability

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

Specified by:

detachTable in interface IRecordSet2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IRecordSet2.saveAsTable(com.esri.arcgis.geodatabase.IWorkspace, String)

getMaxRecordCount

public int getMaxRecordCount()
                      throws IOException,
                             AutomationException

The maximum number of records for the recordset.

Remarks

When using a recordset class, the MaxRecordCount property is used to return the maximum number of records for the recordset.

Product Availability

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

Specified by:

getMaxRecordCount in interface IRecordSetInit

Returns:

The maxRecordCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRecordCount

public void setMaxRecordCount(int maxRecordCount)
                       throws IOException,
                              AutomationException

The maximum number of records for the recordset.

Product Availability

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

Specified by:

setMaxRecordCount in interface IRecordSetInit

Parameters:

maxRecordCount - The maxRecordCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTable

public void setSourceTable(ITable table,
                           IQueryFilter queryFilter)
                    throws IOException,
                           AutomationException

Sets the source table or feature class for a Recordset.

Remarks

When using a recordset class, the SetSourceTable property is used to set the source table or feature class for a Recordset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSourceTable in interface IRecordSetInit

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.ITable (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceQueryDef

public void setSourceQueryDef(IQueryDef queryDef)
                       throws IOException,
                              AutomationException

Sets the source QueryDef for a Recordset.

Remarks

When using a recordset class, the SetSourceQueryDef property is used to sets the source QueryDef for a Recordset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSourceQueryDef in interface IRecordSetInit

Parameters:

queryDef - A reference to a com.esri.arcgis.geodatabase.IQueryDef (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createTable

public void createTable(IFields fields)
                 throws IOException,
                        AutomationException

Creates an empty table or feature class for a Recordset.

Remarks

When using a recordset class, the CreateTable property is used to create an empty table or feature class for a RecordSet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createTable in interface IRecordSetInit

Parameters:

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws IOException,
                                  AutomationException

Creates a row buffer that can be used with an insert cursor.

Remarks

When using a recordset class, the CreateRowBuffer property is used to create a row buffer that can be used with an insert cursor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createRowBuffer in interface IRecordSetInit

Returns:

A reference to a com.esri.arcgis.geodatabase.IRowBuffer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert()
               throws IOException,
                      AutomationException

Returns a cursor that can be used to insert new rows.

Remarks

When using a recordset class, the Insert property is used to return a cursor that can be used to insert new rows into a RecordSet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

insert in interface IRecordSetInit

Returns:

A reference to a com.esri.arcgis.geodatabase.ICursor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

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.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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