result.h

Go to the documentation of this file.

/*
   This file is part of the Nepomuk KDE project.
   Copyright (C) 2008-2010 Sebastian Trueg <trueg@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
 */

#ifndef _NEPOMUK_QUERY_RESULT_H_
#define _NEPOMUK_QUERY_RESULT_H_

#include <QtCore/QSharedDataPointer>
#include <QtCore/QUrl>
#include <QtCore/QList>
#include <QtCore/QHash>

#include <Soprano/Statement>
#include <Soprano/BindingSet>

#include "nepomukquery_export.h"

namespace Nepomuk {

    class Resource;
    class Variant;
    namespace Types {
        class Property;
    }

    namespace Query {
        class NEPOMUKQUERY_EXPORT Result
        {
        public:
            Result();

            Result( const Nepomuk::Resource& resource, double score = 0.0 );

            Result( const Result& );

            ~Result();

            Result& operator=( const Result& );

            double score() const;

            Resource resource() const;

            void setScore( double score );

            void addRequestProperty( const Types::Property& property, const Soprano::Node& value );

            QHash<Types::Property, Soprano::Node> requestProperties() const;

            Soprano::Node operator[]( const Types::Property& property ) const;

            Soprano::Node requestProperty( const Types::Property& property ) const;

            void setAdditionalBindings( const Soprano::BindingSet& bindings );

            Soprano::BindingSet additionalBindings() const;

            Variant additionalBinding( const QString& name ) const;

            void setExcerpt( const QString& text );

            QString excerpt() const;

            bool operator==( const Result& ) const;

        private:
            class Private;
            QSharedDataPointer<Private> d;
        };
    }
}

#endif