1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #include "qxmlresultitems.h"
43 #include "qxmlresultitems_p.h"
49 \class QXmlResultItems
50 \brief The QXmlResultItems class iterates through the results of evaluating an XQuery in QXmlQuery.
54 \inmodule QtXmlPatterns
56 QXmlResultItems presents the evaluation of an associated query as a
57 sequence of \l{QXmlItem}{QXmlItems}. The sequence is traversed by
58 repeatedly calling next(), which actually produces the sequence by
59 lazy evaluation of the query.
61 \snippet code/src_xmlpatterns_api_qxmlresultitems.cpp 0
63 An effect of letting next() produce the sequence by lazy evaluation
64 is that a query error can occur on any call to next(). If an error
65 occurs, both next() and current() will return the null QXmlItem, and
66 hasError() will return true.
68 QXmlResultItems can be thought of as an "iterator" that traverses
69 the sequence of query results once, in the forward direction. Each
70 call to next() advances the iterator to the next QXmlItem in the
71 sequence and returns it, and current() always returns the QXmlItem
72 that next() returned the last time it was called.
74 \note When using the QXmlResultItems overload of QXmlQuery::evaluateTo()
75 to execute a query, it is advisable to create a new instance of this
76 class for each new set of results rather than reusing an old instance.
78 \sa QXmlItem::isNode(), QXmlItem::isAtomicValue(), QXmlNodeModelIndex
82 Constructs an instance of QXmlResultItems.
84 QXmlResultItems::QXmlResultItems() : d_ptr(new QXmlResultItemsPrivate())
89 Destroys this instance of QXmlResultItems.
91 QXmlResultItems::~QXmlResultItems()
96 Returns the next result in the sequence produced by lazy evaluation
97 of the associated query. When the returned QXmlItem is null, either
98 the evaluation terminated normally without producing another result,
99 or an error occurred. Call hasError() to determine whether the null
100 item was caused by normal termination or by an error.
102 Returns a null QXmlItem if there is no associated QXmlQuery.
104 QXmlItem QXmlResultItems::next()
106 Q_D(QXmlResultItems);
112 d->current = QPatternist::Item::toPublic(d->iterator->next());
115 catch(const QPatternist::Exception)
117 d->current = QXmlItem();
124 Returns the current item. The current item is the last item
125 that was produced and returned by next().
127 Returns a null QXmlItem if there is no associated QXmlQuery.
129 QXmlItem QXmlResultItems::current() const
131 Q_D(const QXmlResultItems);
141 If an error occurred during evaluation of the query, true is
144 Returns false if query evaluation has been done.
146 bool QXmlResultItems::hasError() const
148 Q_D(const QXmlResultItems);