1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7 **
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 The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
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 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 //
43 //  W A R N I N G
44 //  -------------
45 //
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.
49 //
50 // We mean it.
51 
52 #ifndef Patternist_XsdXPathExpression_H
53 #define Patternist_XsdXPathExpression_H
54 
55 #include "qanyuri_p.h"
56 #include "qnamedschemacomponent_p.h"
57 #include "qxsdannotated_p.h"
58 
59 #include <QtCore/QList>
60 
61 QT_BEGIN_HEADER
62 
63 QT_BEGIN_NAMESPACE
64 
65 namespace QPatternist
66 {
67     /**
68      * @short Represents a XSD assertion object.
69      *
70      * @ingroup Patternist_schema
71      * @author Tobias Koenig <tobias.koenig@nokia.com>
72      * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x">XPathExpression Definition</a>
73      */
74     class XsdXPathExpression : public NamedSchemaComponent, public XsdAnnotated
75     {
76         public:
77             typedef QExplicitlySharedDataPointer<XsdXPathExpression> Ptr;
78             typedef QList<XsdXPathExpression::Ptr> List;
79 
80             /**
81              * Sets the list of namespace @p bindings of the XPath expression.
82              *
83              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x-namespace_bindings">Namespace Bindings Definition</a>
84              *
85              * @note We can't use a QSet<QXmlName> here, as the hash method does not take the prefix
86              *       in account, so we loose entries.
87              */
88             void setNamespaceBindings(const QList<QXmlName> &bindings);
89 
90             /**
91              * Returns the list of namespace bindings of the XPath expression.
92              */
93             QList<QXmlName> namespaceBindings() const;
94 
95             /**
96              * Sets the default namespace of the XPath expression.
97              *
98              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x-default_namespace">Default Namespace Definition</a>
99              */
100             void setDefaultNamespace(const AnyURI::Ptr &defaultNamespace);
101 
102             /**
103              * Returns the default namespace of the XPath expression.
104              */
105             AnyURI::Ptr defaultNamespace() const;
106 
107             /**
108              * Sets the base @p uri of the XPath expression.
109              *
110              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x-base_URI">Base URI Definition</a>
111              */
112             void setBaseURI(const AnyURI::Ptr &uri);
113 
114             /**
115              * Returns the base uri of the XPath expression.
116              */
117             AnyURI::Ptr baseURI() const;
118 
119             /**
120              * Sets the @p expression string of the XPath expression.
121              *
122              * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x-expression">Expression Definition</a>
123              */
124             void setExpression(const QString &expression);
125 
126             /**
127              * Returns the expression string of the XPath expression.
128              */
129             QString expression() const;
130 
131         private:
132             QList<QXmlName> m_namespaceBindings;
133             AnyURI::Ptr     m_defaultNamespace;
134             AnyURI::Ptr     m_baseURI;
135             QString         m_expression;
136     };
137 }
138 
139 QT_END_NAMESPACE
140 
141 QT_END_HEADER
142 
143 #endif
144