simpleresource.h

Go to the documentation of this file.

/*
   This file is part of the Nepomuk KDE project.
   Copyright (C) 2010-2011 Sebastian Trueg <trueg@kde.org>
   Copyright (C) 2010-2011 Vishesh Handa <handa.vish@gmail.com>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) version 3, or any
   later version accepted by the membership of KDE e.V. (or its
   successor approved by the membership of KDE e.V.), which shall
   act as a proxy defined in Section 6 of version 3 of the license.

   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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef SIMPLERESOURCE_H
#define SIMPLERESOURCE_H

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

#include <Soprano/Statement>

#include "nepomuk_export.h"

namespace Nepomuk2 {

typedef QMultiHash<QUrl, QVariant> PropertyHash;

class NEPOMUK_EXPORT SimpleResource
{
public:
    explicit SimpleResource(const QUrl& uri = QUrl());
    SimpleResource(const PropertyHash& properties);
    SimpleResource(const SimpleResource& other);
    virtual ~SimpleResource();

    SimpleResource& operator=(const SimpleResource& other);

    bool operator==(const SimpleResource& other) const;

    QUrl uri() const;

    void setUri( const QUrl & uri );

    bool contains(const QUrl& property) const;
    bool contains(const QUrl& property, const QVariant& value) const;
    bool containsNode(const QUrl& property, const Soprano::Node& value) const;

    void clear();

    void setProperties(const PropertyHash& properties);

    void addProperties(const PropertyHash& properties);

    void setProperty(const QUrl& property, const QVariant& value);

    void setProperty(const QUrl& property, const QVariantList& values);

    void setProperty(const QUrl& property, const SimpleResource& res);

    void setPropertyNode(const QUrl& property, const Soprano::Node& value);

    void addProperty(const QUrl& property, const QVariant& value);

    void addProperty(const QUrl& property, const SimpleResource& res);

    void addPropertyNode(const QUrl& property, const Soprano::Node& value);

    void remove(const QUrl& property, const QVariant& value);
    void remove(const QUrl& property);

    void removeAll(const QUrl& property, const QVariant& value);

    void addType(const QUrl& type);

    void setTypes(const QList<QUrl>& types);

    QVariantList property(const QUrl& property) const;

    PropertyHash properties() const;

    QList<Soprano::Statement> toStatementList() const;

    bool isValid() const;


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

NEPOMUK_EXPORT QDataStream & operator<<(QDataStream &, const Nepomuk2::SimpleResource& );
NEPOMUK_EXPORT QDataStream & operator>>(QDataStream &, Nepomuk2::SimpleResource& );
NEPOMUK_EXPORT QDebug operator<<(QDebug dbg, const Nepomuk2::SimpleResource& res);
NEPOMUK_EXPORT QDataStream & operator<<(QDataStream &, const Nepomuk2::SimpleResource& );
NEPOMUK_EXPORT QDataStream & operator>>(QDataStream &, Nepomuk2::SimpleResource& );

NEPOMUK_EXPORT uint qHash(const SimpleResource& res);
}

Q_DECLARE_TYPEINFO(Nepomuk2::SimpleResource, Q_MOVABLE_TYPE);

#endif