API Reference OSGeo FDO Provider for SDF
Main Page | Alphabetical List | Class List | File List | Class Members | File Members

SdfIScrollableFeatureReader Class Reference

#include <IScrollableFeatureReader.h>

List of all members.


Public Member Functions

virtual int Count ()=0
 Returns number of records.
virtual unsigned int IndexOf (FdoPropertyValueCollection *key)=0
 Given a key of a feature, IndexOf will return the one based index or the record number of the feature within the returned query result.
virtual bool ReadAt (FdoPropertyValueCollection *key)=0
 Provides the ad-hoc access to the query result.
virtual bool ReadAtIndex (unsigned int recordindex)=0
 Provides an ad-hoc access to the query result.
virtual bool ReadFirst ()=0
 Returns true if a record is found or false if the result is empty.
virtual bool ReadLast ()=0
 Returns true if a record is found or false if the result is empty.
virtual bool ReadPrevious ()=0
 Advances the reader to the previous item.

Member Function Documentation

virtual int SdfIScrollableFeatureReader::Count  )  [pure virtual]
 

Returns number of records.

Returns:

virtual unsigned int SdfIScrollableFeatureReader::IndexOf FdoPropertyValueCollection *  key  )  [pure virtual]
 

Given a key of a feature, IndexOf will return the one based index or the record number of the feature within the returned query result.

Remarks:
If the record is not found, then zero is retuned. This is the mirror function of the GetAtIndex function. This method does not affect the reader position. GetAtIndex need to be called to move the reader to the returned index.
Parameters:
key The key that identifies a record.
Returns:
Returns true if a record is found or false otherwise.

virtual bool SdfIScrollableFeatureReader::ReadAt FdoPropertyValueCollection *  key  )  [pure virtual]
 

Provides the ad-hoc access to the query result.

Remarks:
It positions the position of the reader at a given record defined by the key. If the record is not found, then the reader position is unset and false value is returned. Once the reader’s position becames unset, the caller needs to call ReadFirst, ReadLast or ReadAt to re-position the reader at a valid location.
Parameters:
key The key that identifies a record.
Returns:
Returns true if a record is found or false otherwise.

virtual bool SdfIScrollableFeatureReader::ReadAtIndex unsigned int  recordindex  )  [pure virtual]
 

Provides an ad-hoc access to the query result.

Remarks:
The recordindex is the one-based nth item in the query result. If successful, this method will position the reader at the feature identified by the recordindex.
Parameters:
recordindex The index of the row.
Returns:
Returns true if a record is found or false otherwise.

virtual bool SdfIScrollableFeatureReader::ReadFirst  )  [pure virtual]
 

Returns true if a record is found or false if the result is empty.

Returns:

virtual bool SdfIScrollableFeatureReader::ReadLast  )  [pure virtual]
 

Returns true if a record is found or false if the result is empty.

Returns:

virtual bool SdfIScrollableFeatureReader::ReadPrevious  )  [pure virtual]
 

Advances the reader to the previous item.

Returns:
Returns true if a record is found or false if reading is complete.

The documentation for this class was generated from the following file:
Comments?