Main Page   Class Hierarchy   Compound List   File List   Compound Members  

dbAnyCursor Class Reference

#include <cursor.h>

Inheritance diagram for dbAnyCursor:

dbL2List dbCursor< T > List of all members.

Public Methods

int getNumberOfRecords () const
void remove ()
bool isEmpty () const
bool isUpdateCursor () const
bool isLimitReached () const
oid_t * toArrayOfOid (oid_t *arr) const
int select (dbQuery &query, dbCursorType aType, void *paramStruct=NULL)
int select (dbQuery &query, void *paramStruct=NULL)
int select (char const *condition, dbCursorType aType, void *paramStruct=NULL)
int select (char const *condition, void *paramStruct=NULL)
int select (dbCursorType aType)
int select ()
int selectByKey (char const *key, void const *value)
int selectByKeyRange (char const *key, void const *minValue, void const *maxValue)
void update ()
void removeAll ()
void removeAllSelected ()
void setSelectionLimit (size_t lim)
void unsetSelectionLimit ()
void setPrefetchMode (bool mode)
void reset ()
bool isLast () const
bool isFirst () const
void freeze ()
void unfreeze ()
bool skip (int n)
int seek (oid_t oid)
dbTableDescriptorgetTable ()
void setTable (dbTableDescriptor *aTable)
void setRecord (void *rec)
void * getRecord ()
bool isInSelection (oid_t oid)
void fetch ()
bool hasNext () const

Detailed Description

Base class for all cursors


Member Function Documentation

void dbAnyCursor::fetch   [inline]
 

Fetch current record. You should use this method only if prefetch mode is disabled

void dbAnyCursor::freeze  
 

Freeze cursor. This method makes it possible to save current state of cursor, close transaction to allow other threads to proceed, and then later restore state of the cursor using unfreeze method and continue traversal through selected records.

int dbAnyCursor::getNumberOfRecords   const [inline]
 

Get number of selected records

Returns:
number of selected records

void* dbAnyCursor::getRecord   [inline]
 

Get pointer to the location where fields of the current record are fetched

Returns:
pointer to the memory location set by cursor constructor or setRecord method

dbTableDescriptor* dbAnyCursor::getTable   [inline]
 

Get table for which cursor is opened

bool dbAnyCursor::hasNext  
 

Check if there is more records in the selection

bool dbAnyCursor::isEmpty   const [inline]
 

Checks whether selection is empty

Returns:
true if there is no current record

bool dbAnyCursor::isFirst  
 

Check whether current record is the first one in the selection

Returns:
true if prev() method will return NULL

bool dbAnyCursor::isInSelection oid_t    oid
 

Check if record with specified OID is in selection

Returns:
true if record with such OID was selected

bool dbAnyCursor::isLast  
 

Check whether current record is the last one in the selection

Returns:
true if next() method will return NULL

bool dbAnyCursor::isLimitReached   const [inline]
 

Checks whether limit for number of selected reacord is reached

Returns:
true if limit is reached

bool dbAnyCursor::isUpdateCursor   const [inline]
 

Check whether this cursor can be used for update

Returns:
true if it is update cursor

void dbAnyCursor::remove  
 

Remove current record

void dbAnyCursor::removeAll   [inline]
 

Remove all records in the table

void dbAnyCursor::removeAllSelected  
 

Remove all selected records

void dbAnyCursor::reset  
 

Reset cursor

Reimplemented from dbL2List.

int dbAnyCursor::seek oid_t    oid
 

Position cursor on the record with the specified OID

Parameters:
oid  object identifier of record
Returns:
poistion of the record in the selection or -1 if record with such OID is not in selection

int dbAnyCursor::select   [inline]
 

Select all records from the table with default cursor type

Returns:
number of selected records

int dbAnyCursor::select dbCursorType    aType [inline]
 

Select all records from the table

Parameters:
aType  cursor type: dbCursorForUpdate, dbCursorViewOnly
Returns:
number of selected records

int dbAnyCursor::select char const *    condition,
void *    paramStruct = NULL
[inline]
 

Execute query with default cursor type.

Parameters:
condition  selection criteria
paramStruct  pointer to structure with parameters.
Returns:
number of selected records

int dbAnyCursor::select char const *    condition,
dbCursorType    aType,
void *    paramStruct = NULL
[inline]
 

Execute query.

Parameters:
condition  selection criteria
aType  cursor type: dbCursorForUpdate, dbCursorViewOnly
paramStruct  pointer to structure with parameters.
Returns:
number of selected records

int dbAnyCursor::select dbQuery   query,
void *    paramStruct = NULL
[inline]
 

Execute query with default cursor type.

Parameters:
query  selection criteria
paramStruct  pointer to structure with parameters.
Returns:
number of selected records

int dbAnyCursor::select dbQuery   query,
dbCursorType    aType,
void *    paramStruct = NULL
[inline]
 

Execute query.

Parameters:
query  selection criteria
aType  cursor type: dbCursorForUpdate, dbCursorViewOnly
paramStruct  pointer to structure with parameters. If you want to create reentrant precompiled query, i.e. query which can be used concurrently by different threadsm you should avoid to use static variables in such query, and instead of it place paramters into some structure, specify in query relative offsets to the parameters, fill local structure and pass pointer to it to select method.
Returns:
number of selected records

int dbAnyCursor::selectByKey char const *    key,
void const *    value
 

Select all records from the table with specfied value of the key

Parameters:
key  name of the key field
value  searched value of the key
Returns:
number of selected records

int dbAnyCursor::selectByKeyRange char const *    key,
void const *    minValue,
void const *    maxValue
 

Select all records from the table with specfied range of the key values

Parameters:
key  name of the key field
minValue  inclusive low bound for key values, if NULL then there is no low bound
maxValue  inclusive high bound for key values, if NULL then there is no high bound
Returns:
number of selected records

void dbAnyCursor::setPrefetchMode bool    mode [inline]
 

Set prefetch mode. By default, current record is fetch as soon as it is becomes current. But sometimesyou need only OIDs of selected records. In this case setting prefetchMode to false can help.

Parameters:
mode  if false then current record is not fetched. You should explicitly call fetch method if you want to fetch it.

void dbAnyCursor::setRecord void *    rec [inline]
 

Set destination for selected record rec - buffer to which fields of current record will be fetched

void dbAnyCursor::setSelectionLimit size_t    lim [inline]
 

Specify maximal number of records to be selected

void dbAnyCursor::setTable dbTableDescriptor   aTable [inline]
 

Set table for the cursor

Parameters:
aTable  table which records will be iterated

bool dbAnyCursor::skip int    n
 

Skip specified number of records

Parameters:
n  if positive then skip n records forward, if negative then skip -n records backward
Returns:
true if specified number of records was successfully skipped, false if there is no next (n > 0) or previous (n < 0) record in the selction.

oid_t* dbAnyCursor::toArrayOfOid oid_t *    arr const
 

Extract OIDs of selected recrods in array

Parameters:
arr  if arr is not null, then this array is used as destination (it should be at least selection.nRows long)
If arr is null, then new array is created by new oid_t[] and returned by this method
Returns:
if arr is not null, then arr, otherwise array created by this method

void dbAnyCursor::unfreeze  
 

Unfreeze cursor. This method starts new transaction and restore state of the cursor

void dbAnyCursor::unsetSelectionLimit   [inline]
 

Remove selection limit

void dbAnyCursor::update   [inline]
 

Update current record. You should changed value of current record before and then call update method to save changes to the database


The documentation for this class was generated from the following file:
Generated on Mon Oct 23 13:23:58 2006 for FastDB by doxygen1.2.18