1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
46 // This file is not part of the Qt API. It exists purely as an
47 // implementation detail. This header file may change from version to
48 // version without notice, or even be removed.
52 #ifndef Patternist_XsdInstanceReader_H
53 #define Patternist_XsdInstanceReader_H
55 #include "qabstractxmlnodemodel.h"
56 #include <private/qpullbridge_p.h>
57 #include <private/qxsdschemacontext_p.h>
66 * @short The schema instance reader.
68 * This class reads in a xml instance document from a QAbstractXmlNodeModel
69 * and provides a QXmlStreamReader like interface with some additional context
72 * @ingroup Patternist_schema
73 * @author Tobias Koenig <tobias.koenig@nokia.com>
75 class XsdInstanceReader
78 typedef QExplicitlySharedDataPointer<XsdInstanceReader> Ptr;
81 * Creates a new instance reader that will read the data from
84 * @param model The model the data are read from.
85 * @param context The context that is used for error reporting etc.
87 XsdInstanceReader(const QAbstractXmlNodeModel *model, const XsdSchemaContext::Ptr &context);
91 * Returns @c true if the end of the document is reached, @c false otherwise.
96 * Reads the next node from the document.
101 * Returns whether the current node is a start element.
103 bool isStartElement() const;
106 * Returns whether the current node is an end element.
108 bool isEndElement() const;
111 * Returns whether the current node has a text node among its children.
113 bool hasChildText() const;
116 * Returns whether the current node has an element node among its children.
118 bool hasChildElement() const;
121 * Returns the name of the current node.
123 QXmlName name() const;
126 * Returns whether the current node has an attribute with the given @p name.
128 bool hasAttribute(const QXmlName &name) const;
131 * Returns the attribute with the given @p name of the current node.
133 QString attribute(const QXmlName &name) const;
136 * Returns the list of attribute names of the current node.
138 QSet<QXmlName> attributeNames() const;
141 * Returns the concatenated text of all direct child text nodes.
143 QString text() const;
146 * Converts a qualified name into a QXmlName according to the namespace
147 * mappings of the current node.
149 QXmlName convertToQName(const QString &name) const;
152 * Returns a source location object for the current position.
154 QSourceLocation sourceLocation() const;
157 * Returns the QXmlItem for the current position.
159 QXmlItem item() const;
162 * Returns the QXmlItem for the attribute with the given @p name at the current position.
164 QXmlItem attributeItem(const QXmlName &name) const;
167 * Returns the namespace bindings for the given node model @p index.
169 QVector<QXmlName> namespaceBindings(const QXmlNodeModelIndex &index) const;
172 * The shared schema context.
174 XsdSchemaContext::Ptr m_context;
178 QHash<QXmlName, QString> m_cachedAttributes;
179 QHash<QXmlName, QXmlItem> m_cachedAttributeItems;
180 QSourceLocation m_cachedSourceLocation;
181 QXmlItem m_cachedItem;