com.esri.arcgis.util.dataset
Class AGSRecordSet

java.lang.Object
  extended by com.esri.arcgis.util.dataset.AGSRecordSet
All Implemented Interfaces:
Serializable

public class AGSRecordSet
extends Object
implements Serializable

These are native java objects, This serializes a com.esri.arcgis.geodatabase.IRecordSet Object and parses the XML to retrive the Fields & Records. Contains a collections of AGSRecord and AGSFields objects.

See Also:
Serialized Form

Constructor Summary
AGSRecordSet(IRecordSet rSet, IXMLSerializer serializer, boolean parseGeometry)
          Populate the recordsets objects with fields, records and geometry
AGSRecordSet(IRecordSet rSet, IXMLSerializer serializer, IPropertySet pSet, IXMLFlags xmlFlags, boolean parseGeometry)
          Populate the recordsets objects with fields, records and geometry
AGSRecordSet(String xmlStr, boolean parseGeometry)
          Populate the recordsets objects with fields, records and geometry
 
Method Summary
 boolean addRecord(AGSRecord object)
          Adds the given AGSRecord objects to a records object collection in this Recordset.
 void clearRecordset()
          Clears all AGSRecord, and Geometry objects from the Recordset object.
 AGSFields getFields()
          Returns the AGSFields associated with this Recordset object.
 AGSRecord getRecord(int index)
          Returns the AGSRecord object at given index in this Recordset.
 int getRecordsCount()
          Returns the number of records that are actually in the Recordset
 void setFields(AGSFields object)
          Sets the AGSFields object of the Recordset object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AGSRecordSet

public AGSRecordSet(IRecordSet rSet,
                    IXMLSerializer serializer,
                    IPropertySet pSet,
                    IXMLFlags xmlFlags,
                    boolean parseGeometry)
             throws IOException,
                    Exception,
                    AutomationException
Populate the recordsets objects with fields, records and geometry

Parameters:
rSet - the IRecordSet that needs to be parsed.
serializer - as IXMLSerializer object.
pSet - as IPropertySet object.
xmlFlags - as IXMLFlags object.
geometry - is set to true if geometry needs to be parsed.
Throws:
IOException
Exception
AutomationException

AGSRecordSet

public AGSRecordSet(String xmlStr,
                    boolean parseGeometry)
             throws IOException,
                    Exception,
                    AutomationException
Populate the recordsets objects with fields, records and geometry

Parameters:
xml - as String
Throws:
IOException
Exception
AutomationException

AGSRecordSet

public AGSRecordSet(IRecordSet rSet,
                    IXMLSerializer serializer,
                    boolean parseGeometry)
             throws IOException,
                    Exception,
                    AutomationException
Populate the recordsets objects with fields, records and geometry

Parameters:
rSet - the IRecordSet that needs to be parsed.
serializer - as IXMLSerializer object.
geometry - is set to true if geometry needs to be parsed.
Throws:
IOException
Exception
AutomationException
Method Detail

getRecordsCount

public int getRecordsCount()
Returns the number of records that are actually in the Recordset

Returns:
the count as integer.

getRecord

public AGSRecord getRecord(int index)
Returns the AGSRecord object at given index in this Recordset. Example:
AGSRecord records = recordset.getRecords(0);

Parameters:
index - the AGSRecord object to return.
Returns:
AGSRecord

getFields

public AGSFields getFields()
Returns the AGSFields associated with this Recordset object. Example:
AGSFields field = recordset.getField();

Returns:
the AGSFields object.

addRecord

public boolean addRecord(AGSRecord object)
Adds the given AGSRecord objects to a records object collection in this Recordset.


setFields

public void setFields(AGSFields object)
Sets the AGSFields object of the Recordset object. Is used after the SERVICEINFO response is received and parsed.

Parameters:
object - the AGSFields object.

clearRecordset

public void clearRecordset()
Clears all AGSRecord, and Geometry objects from the Recordset object. Example:
recordset.clearRecordset();