pool::ImplicitCollectionIterator Class Reference

#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. More...
virtual pool::ICollectionCursor &	execute ()
	Processes the query and returns a cursor over the query result. More...
virtual bool	next ()
	Retrieves the next token in the collection. More...
virtual Token *	token () const
	Returns the token of the current position. More...
virtual const Token &	eventRef () const
	Returns the event reference Token for the current row. More...
virtual const CollectionRowBuffer &	currentRow () const
	Returns the selected Tokens and Attributes for the current row of the query result set. More...
virtual bool	seek (std::size_t position)
	Seek to a given position in the collection. More...
virtual std::size_t	size ()
	Return the size of the collection. More...
virtual	~ImplicitCollectionIterator ()
	Destructor. More...
virtual void	selectAllAttributes ()
	Adds all Attribute columns to the query select list. More...
virtual void	selectAllTokens ()
	Adds all Token columns to the query select list. More...
virtual void	selectAll ()
	Adds all Token and Attribute columns to the query select list. More...
virtual void	close ()
	Cleanup. More...

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

Detailed Description

Iterator over an implicit collection. Single class implementing both Query and Cursor interfaces to simplify backward compatibility

Definition at line 33 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 87 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 57 of file ImplicitCollectionIterator.h.

{ return *token(); }

execute()

virtual pool::ICollectionCursor& pool::ImplicitCollectionIterator::execute ( )

virtual

Processes the query and returns a cursor over the query result.

this method returns self

Implements pool::ICollectionQuery.

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.

selectAll()

virtual void pool::ImplicitCollectionIterator::selectAll ( )

inlinevirtual

Adds all Token and Attribute columns to the query select list.

Implements pool::ICollectionQuery.

Definition at line 85 of file ImplicitCollectionIterator.h.

{}

selectAllAttributes()

virtual void pool::ImplicitCollectionIterator::selectAllAttributes ( )

inlinevirtual

Adds all Attribute columns to the query select list.

Implements pool::ICollectionQuery.

Definition at line 83 of file ImplicitCollectionIterator.h.

{}

selectAllTokens()

virtual void pool::ImplicitCollectionIterator::selectAllTokens ( )

inlinevirtual

Adds all Token columns to the query select list.

Implements pool::ICollectionQuery.

Definition at line 84 of file ImplicitCollectionIterator.h.

{}

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 91 of file ImplicitCollectionIterator.h.

m_rowBuffer

CollectionRowBuffer pool::ImplicitCollectionIterator::m_rowBuffer

mutableprotected

Definition at line 95 of file ImplicitCollectionIterator.h.

m_token

Token* pool::ImplicitCollectionIterator::m_token

protected

Definition at line 93 of file ImplicitCollectionIterator.h.

m_tokenIterator

ITokenIterator* pool::ImplicitCollectionIterator::m_tokenIterator

protected

Definition at line 92 of file ImplicitCollectionIterator.h.

---

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

• ImplicitCollectionIterator.h