/****************************************************************************

**

** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtXmlPatterns module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

#ifndef Patternist_XsdXPathExpression_H

#define Patternist_XsdXPathExpression_H

#include "qanyuri_p.h"

#include "qnamedschemacomponent_p.h"

#include "qxsdannotated_p.h"

#include <QtCore/QList>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist

{

    /**

     * @short Represents a XSD assertion object.

     *

     * @ingroup Patternist_schema

     * @author Tobias Koenig <tobias.koenig@nokia.com>

     * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x">XPathExpression Definition</a>

     */

    class XsdXPathExpression : public NamedSchemaComponent, public XsdAnnotated

    {

        public:

            typedef QExplicitlySharedDataPointer<XsdXPathExpression> Ptr;

            typedef QList<XsdXPathExpression::Ptr> List;

            /**

             * Sets the list of namespace @p bindings of the XPath expression.

             *

             * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x-namespace_bindings">Namespace Bindings Definition</a>

             *

             * @note We can't use a QSet<QXmlName> here, as the hash method does not take the prefix

             *       in account, so we loose entries.

             */

            void setNamespaceBindings(const QList<QXmlName> &bindings);

            /**

             * Returns the list of namespace bindings of the XPath expression.

             */

            QList<QXmlName> namespaceBindings() const;

            /**

             * Sets the default namespace of the XPath expression.

             *

             * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x-default_namespace">Default Namespace Definition</a>

             */

            void setDefaultNamespace(const AnyURI::Ptr &defaultNamespace);

            /**

             * Returns the default namespace of the XPath expression.

             */

            AnyURI::Ptr defaultNamespace() const;

            /**

             * Sets the base @p uri of the XPath expression.

             *

             * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x-base_URI">Base URI Definition</a>

             */

            void setBaseURI(const AnyURI::Ptr &uri);

            /**

             * Returns the base uri of the XPath expression.

             */

            AnyURI::Ptr baseURI() const;

            /**

             * Sets the @p expression string of the XPath expression.

             *

             * @see <a href="http://www.w3.org/TR/xmlschema11-1/#x-expression">Expression Definition</a>

             */

            void setExpression(const QString &expression);

            /**

             * Returns the expression string of the XPath expression.

             */

            QString expression() const;

        private:

            QList<QXmlName> m_namespaceBindings;

            AnyURI::Ptr     m_defaultNamespace;

            AnyURI::Ptr     m_baseURI;

            QString         m_expression;

    };

}

QT_END_NAMESPACE

QT_END_HEADER

#endif