Zorba

> The XQuery Processor

 

zorba::Iterator Class Reference

Interface for an Iterator over an instance of the XML Data Model. More...

#include <zorba/iterator.h>

Inheritance diagram for zorba::Iterator:

List of all members.

Public Member Functions
virtual void	close ()=0
	Stop iterating.
virtual bool	next (Item &aItem)=0
	Get the next Item of the sequence.
virtual void	open ()=0
	Start iterating.
virtual	~Iterator ()
	Destructor.

---

Detailed Description

Interface for an Iterator over an instance of the XML Data Model.

Definition at line 26 of file iterator.h.

---

Constructor & Destructor Documentation

virtual zorba::Iterator::~Iterator

(

)

[inline, virtual]

Destructor.

Definition at line 31 of file iterator.h.

---

Member Function Documentation

virtual void zorba::Iterator::close

(

)

[pure virtual]

Stop iterating.

In order to call Iterator::next, open has to been called.

Implemented in zorba::ResultIterator.

virtual bool zorba::Iterator::next

(

Item &

aItem

)

[pure virtual]

Get the next Item of the sequence.

Parameters:

aItem

the next Item of the result sequence if true is returned by the function.

Returns:

true if the sequence is not exhausted, false otherwise.

Exceptions:

ZorbaException

if an error occurs during query execution or the Iterator has not been opened.

Implements zorba::ItemSequence.

Implemented in zorba::ResultIterator.

virtual void zorba::Iterator::open

(

)

[pure virtual]

Start iterating.

This function needs to be called before calling next.

Exceptions:

ZorbaException

if an error occurs.

Implemented in zorba::ResultIterator.

---

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

• iterator.h

---