User-Defined Function API  9.0
 All Classes Functions Typedefs Enumerations Enumerator
marklogic::Sequence Class Reference

A sequence of Item values. More...

#include <MarkLogic.h>

Public Member Functions

  Sequence (SequenceImpl *=0)
 
  Sequence (const Sequence &)
 
Sequence operator= (const Sequence &)
 
  operator bool () const
  Test for an empty sequence.
 
void  next ()
  Advance to the next item in the sequence. If the sequence is exhausted, XDMP-UDFSEQEND is raised.
 
bool  done () const
  Test whether or not there are more items in the sequence.
 
Item::Type  type () const
  Determine the type of the current item.
 
uint64_t  frequency () const
  Determine the number of times the current value occurs in the sequence.
 
Value Extraction

Extract the current item value.

void  value (int &) const
 
void  value (unsigned &) const
 
void  value (int64_t &) const
 
void  value (uint64_t &) const
 
void  value (float &) const
 
void  value (double &) const
 
void  value (Decimal &) const
 
void  value (DateTime &) const
 
void  value (Date &) const
 
void  value (Time &) const
 
void  value (GYearMonth &) const
 
void  value (GYear &) const
 
void  value (GMonth &) const
 
void  value (GDay &) const
 
void  value (YearMonthDuration &) const
 
void  value (DayTimeDuration &) const
 
void  value (String &) const
 
void  value (bool &) const
 
void  value (Point &) const
 
void  value (Map &) const
 
void  value (LangString &) const
 

Detailed Description

A sequence of Item values.

Items in a sequence can be atomic values, points (cts:point in XQuery), or maps (map:map in XQuery). A Sequence encapsulates an iterator over the values.

This type represents a sequence of XQuery Item values. For details on how values are converted between C++ and XQuery, see "Type Conversions in Aggregate UDFs" in the ** Application Developer's Guide.


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