I_CursorCmd Class Reference
[Database Server Interfaces]

Search Toolkit Book for I_CursorCmd

#include <interfaces.hpp>

Inheritance diagram for I_CursorCmd:

Inheritance graph
[legend]
Collaboration diagram for I_CursorCmd:

Collaboration graph
[legend]
List of all members.

Detailed Description

Definition at line 517 of file interfaces.hpp.

Public Member Functions

 I_CursorCmd (void)
virtual ~I_CursorCmd (void)

Protected Member Functions

virtual CDB_ResultOpen (void)=0
 Open the cursor.
virtual bool Update (const string &table_name, const string &upd_query)=0
 Update the last fetched row.
virtual bool UpdateTextImage (unsigned int item_num, CDB_Stream &data, bool log_it=true)=0
virtual CDB_SendDataCmdSendDataCmd (unsigned int item_num, size_t size, bool log_it=true)=0
virtual bool Delete (const string &table_name)=0
 Delete the last fetched row.
virtual int RowCount (void) const =0
 Get the number of fetched rows Special case: negative on error or if there is no way that this command could ever affect any rows (like PRINT).
virtual bool Close (void)=0
 Close the cursor.


Constructor & Destructor Documentation

I_CursorCmd::I_CursorCmd void   ) 
 

Definition at line 229 of file interfaces.cpp.

I_CursorCmd::~I_CursorCmd void   )  [virtual]
 

Definition at line 233 of file interfaces.cpp.


Member Function Documentation

virtual bool I_CursorCmd::Close void   )  [protected, pure virtual]
 

Close the cursor.

Return FALSE if the cursor is closed already (or not opened yet)

Implemented in CDB_CursorCmd.

virtual bool I_CursorCmd::Delete const string &  table_name  )  [protected, pure virtual]
 

Delete the last fetched row.

NOTE: the cursor must be declared for delete in CDB_Connection::Cursor()

Implemented in CDB_CursorCmd.

virtual CDB_Result* I_CursorCmd::Open void   )  [protected, pure virtual]
 

Open the cursor.

Return NULL if cursor resulted in no data. Throw exception on error.

Implemented in CDB_CursorCmd.

virtual int I_CursorCmd::RowCount void   )  const [protected, pure virtual]
 

Get the number of fetched rows Special case: negative on error or if there is no way that this command could ever affect any rows (like PRINT).

Implemented in CDB_CursorCmd.

virtual CDB_SendDataCmd* I_CursorCmd::SendDataCmd unsigned int  item_num,
size_t  size,
bool  log_it = true
[protected, pure virtual]
 

Implemented in CDB_CursorCmd.

virtual bool I_CursorCmd::Update const string &  table_name,
const string &  upd_query
[protected, pure virtual]
 

Update the last fetched row.

NOTE: the cursor must be declared for update in CDB_Connection::Cursor()

Implemented in CDB_CursorCmd.

virtual bool I_CursorCmd::UpdateTextImage unsigned int  item_num,
CDB_Stream data,
bool  log_it = true
[protected, pure virtual]
 

Implemented in CDB_CursorCmd.


The documentation for this class was generated from the following files:
Generated on Mon Dec 7 15:31:03 2009 for NCBI C++ ToolKit by  doxygen 1.4.6
Modified on Mon Dec 07 16:24:24 2009 by modify_doxy.py rev. 173732