Difference between revisions of "Projects/Nepomuk/BulkChanges"

Jump to: navigation, search
(DataManagement)
(Added examples)
Line 1: Line 1:
 
Quite often one needs to apply some changes to a large number of resources. Instead of using the <code>Resource</code> class which is synchronous. They are easier ways, which are asynchronous.
 
Quite often one needs to apply some changes to a large number of resources. Instead of using the <code>Resource</code> class which is synchronous. They are easier ways, which are asynchronous.
 
= DataManagement =
 
  
 
With KDE 4.9 the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html Nepomuk Datamanagement libraries] finally became public and allow clients to make large bulk changes to Nepomuk. In fact they are now the defacto method of modifying data. All other client libraries are now built on top of the Data Management library.
 
With KDE 4.9 the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html Nepomuk Datamanagement libraries] finally became public and allow clients to make large bulk changes to Nepomuk. In fact they are now the defacto method of modifying data. All other client libraries are now built on top of the Data Management library.
  
== Includes and Libraries ==
+
= Includes and Libraries =
 
Since the datamanagement libraries are so prevalent, they come bundled together with the NepomukCore library.
 
Since the datamanagement libraries are so prevalent, they come bundled together with the NepomukCore library.
  
 
The appropriate functions are included in the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html <code>Nepomuk/DataManagement</code>] include file.
 
The appropriate functions are included in the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html <code>Nepomuk/DataManagement</code>] include file.
  
==Jobs==
+
=Jobs=
  
 
Each Datamanagement function returns a <code>KJob</code> which performs the jobs and returns a signal on completion. These jobs are automatically started, and like all other <code>KJob</code>s they are automatically deleted on completion.
 
Each Datamanagement function returns a <code>KJob</code> which performs the jobs and returns a signal on completion. These jobs are automatically started, and like all other <code>KJob</code>s they are automatically deleted on completion.
Line 17: Line 15:
  
 
While these jobs are quite easy to use, they have inbuilt error checking that verifies the domain, range and cardinality of the properties that are being changed. Therefore it is important to check the error code of the job when it returns. A better error message can be received via <code>KJob::errorString</code>
 
While these jobs are quite easy to use, they have inbuilt error checking that verifies the domain, range and cardinality of the properties that are being changed. Therefore it is important to check the error code of the job when it returns. A better error message can be received via <code>KJob::errorString</code>
 +
 +
= Examples =
 +
 +
Setting the tags for a large number of resources -
 +
<syntaxhighlight lang="cpp-qt">
 +
    QList<QUrl> resourceList;
 +
    QVariantList tagResources;
 +
 +
    KJob* job = setProperty( resourceList, NAO::hasTag(), tagResources );
 +
    connect( job, SIGNAL(result(KJob*)), this, SLOT(slotTagUpdateDone()) );
 +
</syntaxhighlight>
 +
 +
 +
This can also be done synchronously by running an event loop in the background -
 +
<syntaxhighlight lang="cpp-qt">
 +
    KJob* job = setProperty( resourceList, NAO::hasTag(), tagResources );
 +
    job->exec();
 +
    if( job->error() )
 +
        kError() << job->errorString();
 +
</syntaxhighlight>

Revision as of 11:12, 24 August 2012

Quite often one needs to apply some changes to a large number of resources. Instead of using the Resource class which is synchronous. They are easier ways, which are asynchronous.

With KDE 4.9 the Nepomuk Datamanagement libraries finally became public and allow clients to make large bulk changes to Nepomuk. In fact they are now the defacto method of modifying data. All other client libraries are now built on top of the Data Management library.

Contents

Includes and Libraries

Since the datamanagement libraries are so prevalent, they come bundled together with the NepomukCore library.

The appropriate functions are included in the Nepomuk/DataManagement include file.

Jobs

Each Datamanagement function returns a KJob which performs the jobs and returns a signal on completion. These jobs are automatically started, and like all other KJobs they are automatically deleted on completion.

Errors

While these jobs are quite easy to use, they have inbuilt error checking that verifies the domain, range and cardinality of the properties that are being changed. Therefore it is important to check the error code of the job when it returns. A better error message can be received via KJob::errorString

Examples

Setting the tags for a large number of resources -

    QList<QUrl> resourceList;
    QVariantList tagResources;
 
    KJob* job = setProperty( resourceList, NAO::hasTag(), tagResources );
    connect( job, SIGNAL(result(KJob*)), this, SLOT(slotTagUpdateDone()) );


This can also be done synchronously by running an event loop in the background -

    KJob* job = setProperty( resourceList, NAO::hasTag(), tagResources );
    job->exec();
    if( job->error() )
        kError() << job->errorString();

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal