IndexKeyEqualCursor Class Reference

#include <TableCursors.h>

Inherits Table::Cursor.

List of all members.

---

Detailed Description

Cursor that takes an expression and returns the value for the matching key in the index.

Public Member Functions
virtual bool	avail () const
	Returns true iff there are more rows..
const char *	rowData () const
	Returns a pointer to the data of the current row.
virtual void	deleteRow () const
	Delete the current row from the database.
virtual void	setTuple (const char *tuple)
	Set the input tuple in this cursors internal context.
virtual void	reset ()
	Point the cursor at the first valid row.
virtual IndexKeyEqualCursor &	operator++ ()
	Move forward to the next valid row Set that row data as the index 1 duple in the eval context.
virtual string	as_string () const
	String representation of this cursor.
	IndexKeyEqualCursor (Table *table, TableIndex *table_index, size_t key_size, ptr< Expression > value)
virtual	~IndexKeyEqualCursor ()
	Close the database cursor on destruction.
Static Public Member Functions
ptr< IndexKeyEqualCursor >	factory (Table *table, ptr< SQLWhereClause > wc)

---

Constructor & Destructor Documentation

IndexKeyEqualCursor::IndexKeyEqualCursor (  Table *  table, TableIndex *  table_index, size_t  key_size, ptr< Expression >  value )

virtual IndexKeyEqualCursor::~IndexKeyEqualCursor (   )  [virtual]

Close the database cursor on destruction. TODO: Some kind of pool of these, maybe.

---

Member Function Documentation

virtual string IndexKeyEqualCursor::as_string (   )  const [virtual]

String representation of this cursor. Reimplemented from Table::Cursor.

virtual bool IndexKeyEqualCursor::avail (   )  const [virtual]

Returns true iff there are more rows.. Implements Table::Cursor.

virtual void IndexKeyEqualCursor::deleteRow (   )  const [virtual]

Delete the current row from the database. Valid only if avail(). Implements Table::Cursor.

ptr< IndexKeyEqualCursor > IndexKeyEqualCursor::factory (  Table *  table, ptr< SQLWhereClause >  wc )  [static]

virtual IndexKeyEqualCursor& IndexKeyEqualCursor::operator++ (   )  [virtual]

Move forward to the next valid row Set that row data as the index 1 duple in the eval context. Implements Table::Cursor.

virtual void IndexKeyEqualCursor::reset (   )  [virtual]

Point the cursor at the first valid row. This will need to be called before the cursor is valid after construction. Implements Table::Cursor.

const char* IndexKeyEqualCursor::rowData (   )  const [virtual]

Returns a pointer to the data of the current row. Valid only if avail(). Implements Table::Cursor.

virtual void IndexKeyEqualCursor::setTuple (  const char *  tuple  )  [virtual]

Set the input tuple in this cursors internal context. Must be called before reset, if the cursor is going to use data from the input tuple. Implements Table::Cursor.

---

The documentation for this class was generated from the following files:

• TableCursors.h
• TableCursors.cc

---