pool::ICollectionCursor Class Reference

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

#include <Collection/ICollectionCursor.h>

Inheritance diagram for pool::ICollectionCursor:

Collaboration diagram for pool::ICollectionCursor:

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

Detailed Description

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

Definition at line 21 of file ICollectionCursor.h.

Constructor & Destructor Documentation

~ICollectionCursor()

virtual pool::ICollectionCursor::~ICollectionCursor ( )

inlinevirtual

Empty destructor.

Definition at line 44 of file ICollectionCursor.h.

{}

Member Function Documentation

close()

virtual void pool::ICollectionCursor::close ( )

pure virtual

Cleanup.

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

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::ImplicitCollectionIterator, pool::RootCollection::RNTCollectionCursor, and pool::RootCollection::RootCollectionCursor.

eventRef()

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

pure virtual

Returns the event reference Token for the current row.

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

next()

virtual bool pool::ICollectionCursor::next ( )

pure virtual

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

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

seek()

virtual bool pool::ICollectionCursor::seek ( std::size_t position )

pure virtual

Seek to a given position in the collection.

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

size()

virtual std::size_t pool::ICollectionCursor::size ( )

pure virtual

Returns the size of the collection.

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

---

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

• ICollectionCursor.h