1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** All rights reserved.
5 ** Contact: Nokia Corporation (qt-info@nokia.com)
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
9 ** $QT_BEGIN_LICENSE:LGPL$
10 ** GNU Lesser General Public License Usage
11 ** This file may be used under the terms of the GNU Lesser General Public
12 ** License version 2.1 as published by the Free Software Foundation and
13 ** appearing in the file LICENSE.LGPL included in the packaging of this
14 ** file. Please review the following information to ensure the GNU Lesser
15 ** General Public License version 2.1 requirements will be met:
16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
18 ** In addition, as a special exception, Nokia gives you certain additional
19 ** rights. These rights are described in the Nokia Qt LGPL Exception
20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
22 ** GNU General Public License Usage
23 ** Alternatively, this file may be used under the terms of the GNU General
24 ** Public License version 3.0 as published by the Free Software Foundation
25 ** and appearing in the file LICENSE.GPL included in the packaging of this
26 ** file. Please review the following information to ensure the GNU General
27 ** Public License version 3.0 requirements will be met:
28 ** http://www.gnu.org/copyleft/gpl.html.
31 ** Alternatively, this file may be used in accordance with the terms and
32 ** conditions contained in a signed written agreement between you and Nokia.
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_XsdIdcHelper_H
53 #define Patternist_XsdIdcHelper_H
55 #include <private/qreportcontext_p.h>
56 #include <private/qschematype_p.h>
58 #include <QtXmlPatterns/QXmlItem>
68 * @short A helper class for validating identity constraints.
70 * This class represents a field node from the key-sequence as defined in
71 * the validation rules at http://www.w3.org/TR/xmlschema11-1/#d0e32243.
77 * Creates an empty field node.
82 * Creates a field node that is bound to a xml node.
84 * @param item The xml node the field is bound to.
85 * @param data The string content of that field.
86 * @param type The type that is bound to that field.
88 FieldNode(const QXmlItem &item, const QString &data, const SchemaType::Ptr &type);
91 * Returns whether this field is empty.
93 * A field can be empty, if the xpath expression selects an absent attribute
99 * Returns whether this field is equal to the @p other field.
101 * Equal means that both have the same type and there content is equal in the
104 bool isEqualTo(const FieldNode &other, const NamePool::Ptr &namePool, const ReportContext::Ptr &context, const SourceLocationReflection *const reflection) const;
107 * Returns the xml node item the field is bound to.
109 QXmlItem item() const;
114 SchemaType::Ptr m_type;
118 * @short A helper class for validating identity constraints.
120 * This class represents a target or qualified node from the target or qualified
121 * node set as defined in the validation rules at http://www.w3.org/TR/xmlschema11-1/#d0e32243.
123 * A target node is part of the qualified node set, if all of its fields are not empty.
129 * Defines a set of target nodes.
131 typedef QSet<TargetNode> Set;
134 * Creates a new target node that is bound to the xml node @p item.
136 explicit TargetNode(const QXmlItem &item);
139 * Returns the xml node item the target node is bound to.
141 QXmlItem item() const;
144 * Returns all xml node items, the fields of that target node are bound to.
146 QVector<QXmlItem> fieldItems() const;
149 * Returns the number of fields that are empty.
151 int emptyFieldsCount() const;
154 * Returns whether the target node has the same fields as the @p other target node.
156 bool fieldsAreEqual(const TargetNode &other, const NamePool::Ptr &namePool, const ReportContext::Ptr &context, const SourceLocationReflection *const reflection) const;
159 * Adds a new field to the target node with the given values.
161 void addField(const QXmlItem &item, const QString &data, const SchemaType::Ptr &type);
164 * Returns whether the target node is equal to the @p other target node.
166 bool operator==(const TargetNode &other) const;
170 QVector<FieldNode> m_fields;
174 * Creates a hash value for the given target @p node.
176 inline uint qHash(const QPatternist::TargetNode &node)
178 return qHash(node.item().toNodeModelIndex());