resource.h

Go to the documentation of this file.

/*
 * This file is part of the Nepomuk KDE project.
 * Copyright (C) 2006-2009 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 as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * 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_RESOURCE_H_
#define _NEPOMUK_RESOURCE_H_

#include <QtCore/QHash>
#include <QtCore/QStringList>

#include <kurl.h>

#include "class.h"

#include "nepomuk_export.h"

namespace Nepomuk {

    class ResourceManager;
    class ResourceData;
    class Variant;
    class Tag;
    class Thing;
    class File;
    namespace Types {
        class Property;
    }

    enum ErrorCode {
        NoError = 0,
        CommunicationError, 
        InvalidType,
        UnknownError
    };

    // FIXME: add the uri of the resource as parameter
    NEPOMUK_EXPORT QString errorString( ErrorCode code );

    class NEPOMUK_EXPORT Resource
    {
    public:
        Resource();

        Resource( ResourceManager* manager );

        Resource( const Resource& );

        Resource( const QString& pathOrIdentifier, const QUrl& type = QUrl() );

        Resource( const QString& pathOrIdentifier, const QUrl& type, ResourceManager* manager );

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED Resource( const QString& pathOrIdentifier, const QString& type );
#endif

        Resource( const QUrl& uri, const QUrl& type = QUrl() );

        Resource( const QUrl& uri, const QUrl& type, ResourceManager* manager );

        Resource( ResourceData* );

        virtual ~Resource();

        Resource& operator=( const Resource& other );

        Resource& operator=( const QUrl& uri );

        ResourceManager* manager() const;

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED QString uri() const;
#endif

        QUrl resourceUri() const;

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED QString type() const;
#endif

        QUrl resourceType() const;

        QList<QUrl> types() const;

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

        void addType( const QUrl& type );

        bool hasType( const QUrl& typeUri ) const;

        QString className() const;

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED QHash<QString, Variant> allProperties() const;
#endif

        QHash<QUrl, Variant> properties() const;

        bool hasProperty( const QUrl& uri ) const;

        bool hasProperty( const Types::Property& p, const Variant& v ) const;

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED bool hasProperty( const QString& uri ) const;
#endif

        Variant property( const QUrl& uri ) const;

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED Variant property( const QString& uri ) const;
#endif

        void setProperty( const QUrl& uri, const Variant& value );

        void addProperty( const QUrl& uri, const Variant& value );

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED void setProperty( const QString& uri, const Variant& value );
#endif

        void removeProperty( const QUrl& uri );

        void removeProperty( const QUrl& uri, const Variant& value );

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED void removeProperty( const QString& uri );
#endif

        void remove();

        bool exists() const;

        bool isValid() const;

        QString genericLabel() const;

        QString genericDescription() const;

        QString genericIcon() const;

        Thing pimoThing();

        bool operator==( const Resource& ) const;

        bool operator!=( const Resource& ) const;

        QString description() const;

        void setDescription( const QString& value );

        static QString descriptionUri();

        QStringList identifiers() const;

        void setIdentifiers( const QStringList& value );

        void addIdentifier( const QString& value );

        static QString identifierUri();

        QStringList altLabels() const;

        void setAltLabels( const QStringList& value );

        void addAltLabel( const QString& value );

        static QString altLabelUri();

        QList<Resource> annotations() const;

        void setAnnotations( const QList<Resource>& value );

        void addAnnotation( const Resource& value );

        static QString annotationUri();

        QList<Tag> tags() const;

        void setTags( const QList<Tag>& value );

        void addTag( const Tag& value );

        static QString tagUri();

        QList<Resource> topics() const;

        void setTopics( const QList<Resource>& value );

        void addTopic( const Resource& value );

        static QString topicUri();

        QList<Resource> isTopicOfs() const;

        void setIsTopicOfs( const QList<Resource>& value );

        void addIsTopicOf( const Resource& value );

        static QString isTopicOfUri();

        QList<Resource> isRelateds() const;

        void setIsRelateds( const QList<Resource>& value );

        void addIsRelated( const Resource& value );

        static QString isRelatedUri();

        QString label() const;

        void setLabel( const QString& value );

        static QString labelUri();

        quint32 rating() const;

        void setRating( const quint32& value );

        static QString ratingUri();

        QStringList symbols() const;

        void setSymbols( const QStringList& value );

        void addSymbol( const QString& value );

        static QString symbolUri();

        QList<Resource> annotationOf() const;

        QList<Resource> isRelatedOf() const;

        static QList<Resource> allResources();

        int usageCount() const;

        void increaseUsageCount();

        bool isFile() const;

        File toFile() const;

        static Resource fromResourceUri( const KUrl& uri, const Nepomuk::Types::Class& type = Nepomuk::Types::Class(), ResourceManager* manager = 0 );

    private:
        void determineFinalResourceData() const;

        ResourceData* m_data;

        class Private;
        Private* d; // unused

        friend class ResourceData;
    };

    NEPOMUK_EXPORT uint qHash( const Resource& res );
}

#endif