datamanagement.h

Go to the documentation of this file.

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

   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 DATAMANAGEMENT_H
#define DATAMANAGEMENT_H

#include <QtCore/QObject>

#include <KComponentData>
#include <KGlobal>

#include <Soprano/Global>

#include "nepomuk_export.h"

class KJob;
class KUrl;


namespace Nepomuk2 {
    class DescribeResourcesJob;
    class StoreResourcesJob;
    class CreateResourceJob;
    class SimpleResourceGraph;

    enum RemovalFlag {
        NoRemovalFlags = 0,

        RemoveSubResoures = 1
    };
    Q_DECLARE_FLAGS(RemovalFlags, RemovalFlag)

    
    NEPOMUK_EXPORT KJob* addProperty(const QList<QUrl>& resources,
                                                     const QUrl& property,
                                                     const QVariantList& values,
                                                     const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT KJob* setProperty(const QList<QUrl>& resources,
                                                     const QUrl& property,
                                                     const QVariantList& values,
                                                     const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT KJob* removeProperty(const QList<QUrl>& resources,
                                                        const QUrl& property,
                                                        const QVariantList& values,
                                                        const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT KJob* removeProperties(const QList<QUrl>& resources,
                                                          const QList<QUrl>& properties,
                                                          const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT CreateResourceJob* createResource(const QList<QUrl>& types,
                                                                     const QString& label,
                                                                     const QString& description,
                                                                     const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT KJob* removeResources(const QList<QUrl>& resources,
                                                         Nepomuk2::RemovalFlags flags = Nepomuk2::NoRemovalFlags,
                                                         const KComponentData& component = KGlobal::mainComponent());

    enum StoreIdentificationMode {
        IdentifyNew = 0,

        IdentifyNone = 2
    };

    enum StoreResourcesFlag {
        NoStoreResourcesFlags = 0x0,

        OverwriteProperties = 0x1,

        LazyCardinalities = 0x2,

        OverwriteAllProperties = 0x4,

        MergeDuplicateResources = 0x8
    };
    Q_DECLARE_FLAGS(StoreResourcesFlags, StoreResourcesFlag)

    
    enum DescribeResourcesFlag {
        NoDescribeResourcesFlags = 0,

        ExcludeDiscardableData = 1,

        ExcludeRelatedResources = 2,

        AnonymizeNepomukUris = 4
    };
    Q_DECLARE_FLAGS(DescribeResourcesFlags, DescribeResourcesFlag)

    
    NEPOMUK_EXPORT KJob* removeDataByApplication(const QList<QUrl>& resources,
                                                                 Nepomuk2::RemovalFlags flags = Nepomuk2::NoRemovalFlags,
                                                                 const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT KJob* removeDataByApplication(Nepomuk2::RemovalFlags flags = Nepomuk2::NoRemovalFlags,
                                                                 const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT KJob* mergeResources(const QUrl& resource1,
                                                        const QUrl& resource2,
                                                        const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT KJob* mergeResources(const QList<QUrl>& resources,
                                        const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT StoreResourcesJob* storeResources(const Nepomuk2::SimpleResourceGraph& resources,
                                                     Nepomuk2::StoreIdentificationMode identificationMode = Nepomuk2::IdentifyNew,
                                                     Nepomuk2::StoreResourcesFlags flags = Nepomuk2::NoStoreResourcesFlags,
                                                     const QHash<QUrl, QVariant>& additionalMetadata = QHash<QUrl, QVariant>(),
                                                     const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT KJob* importResources(const KUrl& url,
                                                         Soprano::RdfSerialization serialization,
                                                         const QString& userSerialization = QString(),
                                                         StoreIdentificationMode identificationMode = IdentifyNew,
                                                         StoreResourcesFlags flags = NoStoreResourcesFlags,
                                                         const QHash<QUrl, QVariant>& additionalMetadata = QHash<QUrl, QVariant>(),
                                                         const KComponentData& component = KGlobal::mainComponent());

    NEPOMUK_EXPORT DescribeResourcesJob* describeResources(const QList<QUrl>& resources,
                                                                           DescribeResourcesFlags flags = NoDescribeResourcesFlags,
                                                                           const QList<QUrl>& targetParties = QList<QUrl>() );

}

Q_DECLARE_OPERATORS_FOR_FLAGS(Nepomuk2::RemovalFlags)
Q_DECLARE_OPERATORS_FOR_FLAGS(Nepomuk2::StoreResourcesFlags)
Q_DECLARE_OPERATORS_FOR_FLAGS(Nepomuk2::DescribeResourcesFlags)

#endif