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, java.io.Externalizable, java.io.Serializable

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

COM Class 'RecordSet'. Generated 9/21/2023 10:01:43 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'Esri Record Set object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabase.IRecordSet2

IID, IID2d6cb9cc_c6a0_437f_a431_9c9b7fdc4862, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IRecordSet

IID4510a65b_acd1_4046_b8b0_10f9d0da673f

Fields inherited from interface com.esri.arcgis.geodatabase.IRecordSetInit

IID, IID40d32697_0b40_4023_8d73_20e004b5377b, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Constructor Summary

Constructors

Constructor and Description
RecordSet() Constructs a RecordSet using ArcGIS Engine.
RecordSet(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RecordSet theRecordSet = (RecordSet) obj;

Method Summary

Modifier and Type	Method and Description
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(java.lang.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 java.lang.String	getClsid() getClsid.
ICursor	getCursor(boolean recycling) A cursor over the rows or features in the recordset.
IFields	getFields() The fields of the recordset.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
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(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
ITable	saveAsTable(IWorkspace workspace, java.lang.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(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

RecordSet

public RecordSet()
          throws java.io.IOException,
                 java.net.UnknownHostException

Constructs a RecordSet using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RecordSet

public RecordSet(java.lang.Object obj)
          throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException

The fields of the recordset.

Specified by:

getFields in interface IRecordSet

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCursor

public ICursor getCursor(boolean recycling)
                  throws java.io.IOException,
                         AutomationException

A cursor over the rows or features in the recordset.

Specified by:

getCursor in interface IRecordSet

Parameters:

recycling - The recycling (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFeatureCollection

public boolean isFeatureCollection()
                            throws java.io.IOException,
                                   AutomationException

Indicates if the recordset is a feature collection.

Specified by:

isFeatureCollection in interface IRecordSet

Returns:

The isFeatureCollection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws java.io.IOException,
                       AutomationException

The source table or feature class for the recordset.

Specified by:

getTable in interface IRecordSet

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveAsTable

public ITable saveAsTable(IWorkspace workspace,
                          java.lang.String tableName)
                   throws java.io.IOException,
                          AutomationException

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detachTable

public void detachTable()
                 throws java.io.IOException,
                        AutomationException

Detach Recordset from table and apply the subfield of QueryFilter.

Specified by:

detachTable in interface IRecordSet2

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRecordCount

public int getMaxRecordCount()
                      throws java.io.IOException,
                             AutomationException

The maximum number of records for the recordset.

Specified by:

getMaxRecordCount in interface IRecordSetInit

Returns:

The maxRecordCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRecordCount

public void setMaxRecordCount(int maxRecordCount)
                       throws java.io.IOException,
                              AutomationException

The maximum number of records for the recordset.

Specified by:

setMaxRecordCount in interface IRecordSetInit

Parameters:

maxRecordCount - The maxRecordCount (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTable

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

Sets the source table or feature class for a Recordset.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceQueryDef

public void setSourceQueryDef(IQueryDef queryDef)
                       throws java.io.IOException,
                              AutomationException

Sets the source QueryDef for a Recordset.

Specified by:

setSourceQueryDef in interface IRecordSetInit

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createTable

public void createTable(IFields fields)
                 throws java.io.IOException,
                        AutomationException

Creates an empty table or feature class for a Recordset.

Specified by:

createTable in interface IRecordSetInit

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRowBuffer

public IRowBuffer createRowBuffer()
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:

createRowBuffer in interface IRecordSetInit

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

public ICursor insert()
               throws java.io.IOException,
                      AutomationException

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

Specified by:

insert in interface IRecordSetInit

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException