Zorba

> The XQuery Processor

 

zorba::Collection Class Reference

A Collection is a sequence of Node Items. More...

#include <zorba/collection.h>

List of all members.

Public Member Functions
virtual bool	addDocument (std::istream &aInStream)=0
	Adds the document retrieved from the given input stream to the Collection.
virtual bool	addItem (const Item &aItem)=0
	Adds a Node Item to the Collection.
virtual bool	addItems (const ResultIterator_t &aResultIterator)=0
	Adds the Node Items retrieved from the given ResultIterator to the Collection.
virtual bool	deleteItem (const Item &aItem)=0
	Deletes the given Item from the Collection.
virtual Item	getUri ()=0
	Get the URI of a collection as an anyURI Item.
virtual	~Collection ()
	Destructor.

---

Detailed Description

A Collection is a sequence of Node Items.

Each Collection is created by the XmlDataManager and referenced by a URI. The URI can be accessed in a query's fn:collection function.

Definition at line 29 of file collection.h.

---

Constructor & Destructor Documentation

virtual zorba::Collection::~Collection

(

)

[inline, virtual]

Destructor.

Definition at line 34 of file collection.h.

---

Member Function Documentation

virtual bool zorba::Collection::addDocument

(

std::istream &

aInStream

)

[pure virtual]

Adds the document retrieved from the given input stream to the Collection.

Parameters:

aInStream

the input stream from which to parse the document.

Returns:

true if the document was added to the collection (e.g. was a valid document), false otherwise.

virtual bool zorba::Collection::addItem

(

const Item &

aItem

)

[pure virtual]

Adds a Node Item to the Collection.

Parameters:

aItem

the Node Item to add.

Returns:

true if the Node Item was added to the Collection, false otherwise.

virtual bool zorba::Collection::addItems

(

const ResultIterator_t &

aResultIterator

)

[pure virtual]

Adds the Node Items retrieved from the given ResultIterator to the Collection.

Parameters:

aResultIterator

the ResultIterator that produces the Node Items to add.

Returns:

true if all the Node Items of the given ResultIterator were added to the Collection, false otherwise.

virtual bool zorba::Collection::deleteItem

(

const Item &

aItem

)

[pure virtual]

Deletes the given Item from the Collection.

Parameters:

aItem

the Node Item to delete

Returns:

true if the given Node Item was deleted, false otherwise.

virtual Item zorba::Collection::getUri

(

)

[pure virtual]

Get the URI of a collection as an anyURI Item.

Returns:

Item the anyURI Item of the Collection.

---

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

• collection.h

---