src/xmlpatterns/schema/qxsdxpathexpression_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   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.
  17 **
  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.
  21 **
  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.
  29 **
  30 ** Other Usage
  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.
  33 **
  34 **
  35 **
  36 **
  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 <private/qanyuri_p.h>
  56 #include <private/qnamedschemacomponent_p.h>
  57 #include <private/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