# Sequence Class Reference

An eagerly evaluated result of a query execution. More...

`#include <Sequence.hpp>`

Inheritance diagram for Sequence:

[legend]
List of all members.

## Public Types

typedef VectorOfItems::iterator | iterator
typedef VectorOfItems::const_iterator | const_iterator
typedef VectorOfItems::reverse_iterator | reverse_iterator
typedef VectorOfItems::const_reverse_iterator | const_reverse_iterator

## Public Member Functions

| Sequence (const Item::Ptr &item, xercesc::MemoryManager *memMgr=xercesc::XMLPlatformUtils::fgMemoryManager)
| Sequence (xercesc::MemoryManager *memMgr=xercesc::XMLPlatformUtils::fgMemoryManager)
| Sequence (unsigned int n, xercesc::MemoryManager *memMgr=xercesc::XMLPlatformUtils::fgMemoryManager)
| construct and reserve space for n elements
| Sequence (const Sequence &, xercesc::MemoryManager *memMgr)
| Sequence (const Sequence &)
Sequence & | operator= (const Sequence &)
| ~Sequence ()
void | clear ()
const Item::Ptr & | first () const
const Item::Ptr & | second () const
Sequence::iterator | begin (void)
| Begin an iterator.
Sequence::const_iterator | begin (void) const
Sequence::iterator | end (void)
| Find the end of the iterator.
Sequence::const_iterator | end (void) const
Sequence::reverse_iterator | rbegin (void)
| Reverse iterator methods.
Sequence::const_reverse_iterator | rbegin (void) const
Sequence::reverse_iterator | rend (void)
Sequence::const_reverse_iterator | rend (void) const
unsigned int | getLength (void) const
| Returns the number of nodes in the list.
const Item::Ptr & | item (unsigned int index) const
| Return the indexth item in the collection.
const Item::Ptr & | item (const ATDecimalOrDerived::Ptr &index) const
| Return the indexth item in the collection - takes ATDecimalOrDerived.
void | addItem (const Item::Ptr &item)
| add an item to this sequence
void | addItemFront (const Item::Ptr &item)
| add an item to this sequence
void | joinSequence (const Sequence &s)
| combine another sequence onto this sequence
bool | isEmpty () const
| Returns true if the list is empty.
void | sortIntoDocumentOrder (const DynamicContext *context)
| sort into document order (only works for Sequences containing only Nodes)
void | sortWithCollation (const Collation *collation, const DynamicContext *context)
| sort as strings, using the given collation

## Detailed Description

An eagerly evaluated result of a query execution.

## Member Typedef Documentation

typedef VectorOfItems::const_iterator Sequence::const_iterator

typedef VectorOfItems::const_reverse_iterator Sequence::const_reverse_iterator

typedef VectorOfItems::iterator Sequence::iterator

typedef VectorOfItems::reverse_iterator Sequence::reverse_iterator

## Constructor & Destructor Documentation

Sequence::Sequence | ( | const Item::Ptr & | item,
|  | xercesc::MemoryManager * | memMgr = `xercesc::XMLPlatformUtils::fgMemoryManager`
| ) |

Sequence::Sequence | ( | xercesc::MemoryManager * | memMgr = `xercesc::XMLPlatformUtils::fgMemoryManager` | ) |

Sequence::Sequence | ( | unsigned int | n,
|  | xercesc::MemoryManager * | memMgr = `xercesc::XMLPlatformUtils::fgMemoryManager`
| ) |

| construct and reserve space for n elements

Sequence::Sequence | ( | const Sequence & | ,
|  | xercesc::MemoryManager * | memMgr
| ) |

Sequence::Sequence | ( | const Sequence & |  | ) |

Sequence::~Sequence | ( |  | ) |

## Member Function Documentation

void Sequence::addItem | ( | const Item::Ptr & | item | ) |

| add an item to this sequence

void Sequence::addItemFront | ( | const Item::Ptr & | item | ) |

| add an item to this sequence

Sequence::const_iterator Sequence::begin | ( | void |  | ) | const

Sequence::iterator Sequence::begin | ( | void |  | ) |

| Begin an iterator.

void Sequence::clear | ( |  | ) |

Sequence::const_iterator Sequence::end | ( | void |  | ) | const

Sequence::iterator Sequence::end | ( | void |  | ) |

| Find the end of the iterator.

const Item::Ptr& Sequence::first | ( |  | ) | const

unsigned int Sequence::getLength | ( | void |  | ) | const

| Returns the number of nodes in the list.

bool Sequence::isEmpty | ( |  | ) | const

| Returns true if the list is empty.

const Item::Ptr& Sequence::item | ( | const ATDecimalOrDerived::Ptr & | index | ) | const

| Return the indexth item in the collection - takes ATDecimalOrDerived.

const Item::Ptr& Sequence::item | ( | unsigned int | index | ) | const

| Return the indexth item in the collection.

void Sequence::joinSequence | ( | const Sequence & | s | ) |

| combine another sequence onto this sequence

Sequence& Sequence::operator= | ( | const Sequence & |  | ) |

Sequence::const_reverse_iterator Sequence::rbegin | ( | void |  | ) | const

Sequence::reverse_iterator Sequence::rbegin | ( | void |  | ) |

| Reverse iterator methods.

Sequence::const_reverse_iterator Sequence::rend | ( | void |  | ) | const

Sequence::reverse_iterator Sequence::rend | ( | void |  | ) |

const Item::Ptr& Sequence::second | ( |  | ) | const

void Sequence::sortIntoDocumentOrder | ( | const DynamicContext * | context | ) |

| sort into document order (only works for Sequences containing only Nodes)

void Sequence::sortWithCollation | ( | const Collation * | collation,
|  | const DynamicContext * | context
| ) |

| sort as strings, using the given collation

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

- Sequence.hpp