Collection

#include </home/jenkins/.jenkins/ubuntu-remote-queue/jenkins-BuildZorbaUbuntu-462/source/zorba/swig/Collection.h>

A Collection is a persistent sequence of node items. Instances of this class can be used to modify or retrieve the contents of a collection.The variable aNodes passed to any of the insert functions is evaluated as though it were an enclosed expression in an element constructor. The result of this step is a sequence of nodes to be inserted into the collection.

Private Attributes

zorba::Collection_t

theCollection

Public Functions

Collection(const Collection &aMgr)

Collection(zorba::Collection *aMgr)

ItemSequence

contents()

This function returns the sequence of nodes of the collection.

void

deleteNodeFirst()

This function deletes the first node from a collection.

void

deleteNodeLast()

This function deletes the last node from a collection.

void

deleteNodes(const ItemSequence &aNodes)

This function deletes zero of more nodes from a collection.

void

deleteNodesFirst(unsigned long aNumNodes)

This function deletes the n first nodes from a collection.

void

deleteNodesLast(unsigned long aNumNodes)

This function deletes the n last nodes from a collection.

Item

getName()

Get the name of the collection.

SequenceType

getType()

Retrieves the sequence type for this (static declared) collection.

long long

indexOf(const Item &aNode)

This function returns the index of the given node in the collection.

void

insertNodesAfter(const Item &aTarget, const ItemSequence &aNodes)

This function inserts copies of the given nodes into a collection at the position directly following the given target node.

void

insertNodesBefore(const Item &aTarget, const ItemSequence &aNodes)

This function inserts copies of the given nodes into a collection at the position directly preceding the given target node.

void

insertNodesFirst(const ItemSequence &aNodes)

This function inserts copies of the given nodes at the beginning of the collection.

void

insertNodesLast(const ItemSequence &aNodes)

This function inserts copies of the given nodes at the end of the collection.

bool

isStatic()

The function checks if this collection has been statically declared.

Private Attributes

theCollection

zorba::Collection_t theCollection

Public Functions

Collection

 Collection(const Collection &aMgr)

Collection

 Collection(zorba::Collection *aMgr)

contents

ItemSequence contents()

This function returns the sequence of nodes of the collection.

Returns

The sequence contained in the given collection.

deleteNodeFirst

void deleteNodeFirst()

This function deletes the first node from a collection.

Parameters

XDDY0011 if the collection doesn't contain any node.

deleteNodeLast

void deleteNodeLast()

This function deletes the last node from a collection.

Parameters

XDDY0011 if the collection doesn't contain any node.

deleteNodes

void deleteNodes(const ItemSequence &aNodes)

This function deletes zero of more nodes from a collection.

Parameters

aNodes the nodes in the collection that should be deleted.

Parameters

XDDY0011 if any nodes in the given sequence is not a member of a collection or not all nodes of the sequence belong to the same collection.

deleteNodesFirst

void deleteNodesFirst(unsigned long aNumNodes)

This function deletes the n first nodes from a collection.

Parameters

XDDY0011 if the collection doesn't contain any node.

deleteNodesLast

void deleteNodesLast(unsigned long aNumNodes)

This function deletes the n last nodes from a collection.

Parameters

XDDY0011 if the collection doesn't contain any node.

getName

Item getName()

Get the name of the collection.

Returns

The name of the collection.

getType

SequenceType getType()

Retrieves the sequence type for this (static declared) collection.

Returns

the sequence type for the said collection, or 0 if this collection is not statically declared.

Returns

isStatic()

indexOf

long long indexOf(const Item &aNode)

This function returns the index of the given node in the collection.

Parameters

aNode The node to retrieve the index from.

Returns

Returns the position of the given node in the collection.

Parameters

XDDY0011 if node is not contained in any collection.

insertNodesAfter

void insertNodesAfter(const Item &aTarget, const ItemSequence &aNodes)

This function inserts copies of the given nodes into a collection at the position directly following the given target node.

Parameters

aTarget the node in the collection after which the sequence should be inserted.
aNodes The sequences of nodes whose copies should be added to the collection.

Parameters

XDDY0011 if any nodes in the sequence is not a member of a collection or not all nodes of the sequence belong to the same collection.

insertNodesBefore

void insertNodesBefore(const Item &aTarget, const ItemSequence &aNodes)

This function inserts copies of the given nodes into a collection at the position directly preceding the given target node.

Parameters

aTarget the node in the collection before which the sequence should be inserted.
aNodes The sequences of nodes whose copies should be added to the collection.

Parameters

XDDY0011 if any nodes in the sequence is not a member of a collection or not all nodes of the sequence belong to the same collection.

insertNodesFirst

void insertNodesFirst(const ItemSequence &aNodes)

This function inserts copies of the given nodes at the beginning of the collection.

Parameters

aNodes The sequences of nodes whose copies should be added to the collection.

insertNodesLast

void insertNodesLast(const ItemSequence &aNodes)

This function inserts copies of the given nodes at the end of the collection.

Parameters

aNodes The sequences of nodes whose copies should be added to the collection.

isStatic

bool isStatic()

The function checks if this collection has been statically declared.

Returns

true if the collection is a static collection, false otherwise.