pool::ICollectionCursor Class Reference

#include <CollectionBase/ICollectionCursor.h>

Inheritance diagram for pool::ICollectionCursor:

Collaboration diagram for pool::ICollectionCursor:

Public Member Functions
virtual bool	next ()=0
	Advances the cursor to the next row of the query result set. More...
virtual const pool::CollectionRowBuffer &	currentRow () const =0
	Returns the selected Tokens and Attributes for the current row of the query result set. More...
virtual const Token &	eventRef () const =0
	Returns the event reference Token for the current row. More...
virtual void	close ()=0
	Cleanup. More...
virtual	~ICollectionCursor ()
	Empty destructor. More...

Detailed Description

An interface used to navigate the result of a query on a collection.

Definition at line 20 of file ICollectionCursor.h.

Constructor & Destructor Documentation

~ICollectionCursor()

virtual pool::ICollectionCursor::~ICollectionCursor ( )

inlinevirtual

Empty destructor.

Definition at line 37 of file ICollectionCursor.h.

{}

Member Function Documentation

close()

virtual void pool::ICollectionCursor::close ( )

pure virtual

Cleanup.

Implemented in pool::RootCollection::RNTCollectionCursor, pool::RootCollection::RootCollectionCursor, and pool::ImplicitCollectionIterator.

currentRow()

virtual const pool::CollectionRowBuffer& pool::ICollectionCursor::currentRow ( ) const

pure virtual

Returns the selected Tokens and Attributes for the current row of the query result set.

Implemented in pool::RootCollection::RNTCollectionCursor, pool::RootCollection::RootCollectionCursor, and pool::ImplicitCollectionIterator.

eventRef()

virtual const Token& pool::ICollectionCursor::eventRef ( ) const

pure virtual

Returns the event reference Token for the current row.

Implemented in pool::RootCollection::RNTCollectionCursor, pool::RootCollection::RootCollectionCursor, and pool::ImplicitCollectionIterator.

next()

virtual bool pool::ICollectionCursor::next ( )

pure virtual

Advances the cursor to the next row of the query result set.

Implemented in pool::RootCollection::RNTCollectionCursor, pool::RootCollection::RootCollectionCursor, and pool::ImplicitCollectionIterator.

---

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

• ICollectionCursor.h