pool::ImplicitCollectionIterator Class Reference

Iterator over an implicit collection. More...

#include <Implicitcollection/ImplicitCollectionIterator.h>

Inheritance diagram for pool::ImplicitCollectionIterator:

Collaboration diagram for pool::ImplicitCollectionIterator:

Public Member Functions
	ImplicitCollectionIterator (IContainer &container, const pool::ICollectionDescription &description)
	Constructor.
virtual bool	next ()
	Retrieves the next token in the collection.
virtual Token *	token () const
	Returns the token of the current position.
virtual const Token &	eventRef () const
	Returns the event reference Token for the current row.
virtual const CollectionRowBuffer &	currentRow () const
	Returns the selected Tokens and Attributes for the current row of the query result set.
virtual bool	seek (std::size_t position)
	Seek to a given position in the collection.
virtual std::size_t	size ()
	Return the size of the collection.
virtual	~ImplicitCollectionIterator ()
	Destructor.
virtual void	close ()
	Cleanup.

Protected Attributes
IContainer &	m_container
ITokenIterator *	m_tokenIterator
Token *	m_token
CollectionRowBuffer	m_rowBuffer

Detailed Description

Iterator over an implicit collection.

Class implementing Cursor interface

Definition at line 30 of file ImplicitCollectionIterator.h.

Constructor & Destructor Documentation

ImplicitCollectionIterator()

pool::ImplicitCollectionIterator::ImplicitCollectionIterator	(	IContainer &	container,
		const pool::ICollectionDescription &	description )

Constructor.

~ImplicitCollectionIterator()

virtual pool::ImplicitCollectionIterator::~ImplicitCollectionIterator ( )

virtual

Destructor.

Member Function Documentation

close()

virtual void pool::ImplicitCollectionIterator::close ( )

inlinevirtual

Cleanup.

Implements pool::ICollectionCursor.

Definition at line 72 of file ImplicitCollectionIterator.h.

{}

currentRow()

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

virtual

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

Implements pool::ICollectionCursor.

eventRef()

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

inlinevirtual

Returns the event reference Token for the current row.

Implements pool::ICollectionCursor.

Definition at line 46 of file ImplicitCollectionIterator.h.

{ return *token(); }

next()

virtual bool pool::ImplicitCollectionIterator::next ( )

virtual

Retrieves the next token in the collection.

Returns false if the end of the collection has been reached.

Implements pool::ICollectionCursor.

seek()

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

virtual

Seek to a given position in the collection.

Parameters

position

The position to which to seek.

Returns

True if successful, false otherwise.

Implements pool::ICollectionCursor.

size()

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

virtual

Return the size of the collection.

Implements pool::ICollectionCursor.

token()

virtual Token * pool::ImplicitCollectionIterator::token ( ) const

virtual

Returns the token of the current position.

Member Data Documentation

m_container

IContainer& pool::ImplicitCollectionIterator::m_container

protected

Definition at line 76 of file ImplicitCollectionIterator.h.

m_rowBuffer

CollectionRowBuffer pool::ImplicitCollectionIterator::m_rowBuffer

mutableprotected

Definition at line 80 of file ImplicitCollectionIterator.h.

m_token

Token* pool::ImplicitCollectionIterator::m_token

protected

Definition at line 78 of file ImplicitCollectionIterator.h.

m_tokenIterator

ITokenIterator* pool::ImplicitCollectionIterator::m_tokenIterator

protected

Definition at line 77 of file ImplicitCollectionIterator.h.

---

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

• ImplicitCollectionIterator.h