Projects/Nepomuk/Resources - Revision history

AnneW: Marked this version for translation

2012-12-11T13:55:06Z

Marked this version for translation

Show changes

AnneW at 13:54, 11 December 2012

2012-12-11T13:54:54Z

Yurchor: separate headings

2012-12-11T13:47:33Z

separate headings

AnneW at 11:54, 11 December 2012

2012-12-11T11:54:09Z

Vishesh: /* Managing Properties */ Added Vocabulary stuff

2012-08-23T15:11:54Z

‎Managing Properties: Added Vocabulary stuff

Vishesh: /* Managing Properties */

2012-08-23T13:38:56Z

‎Managing Properties

Vishesh at 13:21, 23 August 2012

2012-08-23T13:21:38Z

Vishesh: /* Usage in CMake */

2012-08-23T13:14:21Z

‎Usage in CMake

Vishesh: /* Nepomuk Resource Generator */

2012-08-23T08:56:55Z

‎Nepomuk Resource Generator

Vishesh at 08:53, 23 August 2012

2012-08-23T08:53:09Z

@@ Line 25: / Line 25: @@
 == Managing Properties ==
-When using the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html <code>Resource</code>] class, one can easily access certain properties such as ratings and tags via convenience functions. However, if one wishes to access more properties then that is performed via the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a9a59f482f21c6150bc9cb39dd47a7d77 <code>property</code>], [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a8ffb9cb55cb641e022479e80b9fc0dcf <code>setProperty</code>] and [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a7dcb083459a2e967a4ddfbf5f6fbcf9e <code>addProperty</code>] functions.
+When using the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html <tt>Resource</tt>] class, one can easily access certain properties such as ratings and tags via convenience functions. However, if one wishes to access more properties then that is performed via the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a9a59f482f21c6150bc9cb39dd47a7d77 <tt>property</tt>], [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a8ffb9cb55cb641e022479e80b9fc0dcf <tt>setProperty</tt>] and [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a7dcb083459a2e967a4ddfbf5f6fbcf9e <tt>addProperty</tt>] functions.
-It's important to know which properties are available in each resource. The simplest way would be to check they keys in [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#ac26aeaa49c264ce6e3778e028aa4dc85 <code>properties</code>].
+It's important to know which properties are available in each resource. The simplest way would be to check they keys in [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#ac26aeaa49c264ce6e3778e028aa4dc85 <tt>properties</tt>].
 === Accessing the Vocabularies ===
@@ Line 73: / Line 73: @@
 == Nepomuk Resource Generator ==
-While it is fairly convenient to use the <code>setProperty</code> and <code>getProperty</code> methods. It requires you to explicitly define the property which you need modify. This can get quite cumbersome and destroys readability of the code.
+While it is fairly convenient to use the <tt>setProperty</tt> and <tt>getProperty</tt> methods. It requires you to explicitly define the property which you need modify. This can get quite cumbersome and destroys readability of the code.
 In order to improve this situation we have provided a resource generator, which generates custom <code>Resource</code> classes from the ontologies. It relies on a CMake macro to accomplish that.
@@ Line 118: / Line 118: @@
 </syntaxhighlight>
-[[Category|Documentation]]
+[[Category:Documentation]]
-[[Category|Development]]
+[[Category:Development]]
-[[Category|Tutorials]]
+[[Category:Tutorials]]
 </translate>

@@ Line 2: / Line 2: @@
 <translate>
 == Introduction ==
 The ''Nepomuk Resource'' class provides a convenient wrapper over the '''Nepomuk''' data. It does so by keeping a cache of the relevant data and using the ''Resource Watcher'' to keep it up to date.
@@ Line 9: / Line 10: @@
 === Saving New Resources ===
 A new resource will automatically be saved the first time it is used.

@@ Line 1: / Line 1: @@
-The Nepomuk Resource class provides a convenient wrapper over the Nepomuk data. It does so by keeping a cache of the relevant data and using the Resource Watcher to keep it up to date.
+<languages />
-= Saving Resources =
+== Saving Resources ==
 Resources are a real-time view of the data in the virtuoso database. They are automatically saved after each change, and all other resources across the different applications are updated.
 === Saving New Resources ===
@@ Line 17: / Line 21: @@
 </syntaxhighlight>
-= Managing Properties =
+== Managing Properties ==
 When using the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html <code>Resource</code>] class, one can easily access certain properties such as ratings and tags via convenience functions. However, if one wishes to access more properties then that is performed via the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a9a59f482f21c6150bc9cb39dd47a7d77 <code>property</code>], [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a8ffb9cb55cb641e022479e80b9fc0dcf <code>setProperty</code>] and [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a7dcb083459a2e967a4ddfbf5f6fbcf9e <code>addProperty</code>] functions.
@@ Line 24: / Line 28: @@
 === Accessing the Vocabularies ===
 In order to modify any of the properties in Nepomuk, one must access the ontologies. The recommended way of doing that is by using the pre-generated ontologies headers which are shipped with Soprano and NepomukCore.
 <syntaxhighlight lang="cpp-qt">
@@ Line 45: / Line 50: @@
 === Setting Properties ===
-When setting a property of a resource. It is imperative that the domain, range and cardinality of the property be correct. Otherwise the setProperty call will silently fail and output an error as a debug message. In future releases we will provide other ways to get notified of the errors.
+When setting a property of a resource. It is imperative that the domain, range and cardinality of the property be correct. Otherwise the <tt>setProperty</tt> call will silently fail and output an error as a debug message. In future releases we will provide other ways to get notified of the errors.
 Example -
@@ Line 64: / Line 69: @@
 </syntaxhighlight>
-= Nepomuk Resource Generator =
+== Nepomuk Resource Generator ==
 While it is fairly convenient to use the <code>setProperty</code> and <code>getProperty</code> methods. It requires you to explicitly define the property which you need modify. This can get quite cumbersome and destroys readability of the code.
@@ Line 72: / Line 77: @@
 ===Usage in CMake===
-The resource generator is best used through the CMake macro provided by Nepomuk. The syntax is fairly simple and similar to the macro for adding ui files to a list of sources:
+The resource generator is best used through the CMake macro provided by '''Nepomuk'''. The syntax is fairly simple and similar to the macro for adding ui files to a list of sources:
 <syntaxhighlight lang="text">
@@ Line 89: / Line 94: @@
 ==== Example ====
 <syntaxhighlight lang="cmake">
 include(Nepomuk2AddOntologyClasses)
@@ Line 109: / Line 115: @@
 QString name = spiderman.fullname();
 </syntaxhighlight>

← Older revision		Revision as of 15:11, 23 August 2012
Line 22:		Line 22:

	It's important to know which properties are available in each resource. The simplest way would be to check they keys in [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#ac26aeaa49c264ce6e3778e028aa4dc85 <code>properties</code>].		It's important to know which properties are available in each resource. The simplest way would be to check they keys in [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#ac26aeaa49c264ce6e3778e028aa4dc85 <code>properties</code>].
		+
		+	=== Accessing the Vocabularies ===
		+	In order to modify any of the properties in Nepomuk, one must access the ontologies. The recommended way of doing that is by using the pre-generated ontologies headers which are shipped with Soprano and NepomukCore.
		+
		+	<syntaxhighlight lang="cpp-qt">
		+	#include <Soprano/Vocabulary/RDF>
		+	#include <Soprano/Vocabulary/RDFS>
		+	#include <Soprano/Vocabulary/NRL>
		+	#include <Soprano/Vocabulary/NAO>
		+
		+	#include <Nepomuk2/Vocabulary/NIE>
		+	#include <Nepomuk2/Vocabulary/NFO>
		+	#include <Nepomuk2/Vocabulary/NMM>
		+	#include <Nepomuk2/Vocabulary/NCO>
		+	#include <Nepomuk2/Vocabulary/PIMO>
		+	#include <Nepomuk2/Vocabulary/NCAL>
		+
		+	using namespace Neppomuk2::Vocabulary;
		+	using namespace Soprano::Vocabulary;
		+	</syntaxhighlight>

	=== Setting Properties ===		=== Setting Properties ===

← Older revision		Revision as of 13:38, 23 August 2012
Line 18:		Line 18:

	= Managing Properties =		= Managing Properties =
		+
		+	When using the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html <code>Resource</code>] class, one can easily access certain properties such as ratings and tags via convenience functions. However, if one wishes to access more properties then that is performed via the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a9a59f482f21c6150bc9cb39dd47a7d77 <code>property</code>], [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a8ffb9cb55cb641e022479e80b9fc0dcf <code>setProperty</code>] and [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#a7dcb083459a2e967a4ddfbf5f6fbcf9e <code>addProperty</code>] functions.
		+
		+	It's important to know which properties are available in each resource. The simplest way would be to check they keys in [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1Resource.html#ac26aeaa49c264ce6e3778e028aa4dc85 <code>properties</code>].
		+
		+	=== Setting Properties ===
		+
		+	When setting a property of a resource. It is imperative that the domain, range and cardinality of the property be correct. Otherwise the setProperty call will silently fail and output an error as a debug message. In future releases we will provide other ways to get notified of the errors.
		+
		+	Example -
		+	<syntaxhighlight lang="cpp-qt">
		+	Nepomuk2::Resource res;
		+	res.addType( NCO::Contact() );
		+
		+	res.setProperty( NFO::fileName(), "Fire" ); // Will silently fail
		+	res.property( NFO::fileName() ).toString(); // Will be empty
		+
		+	res.addProperty( NCO::fullname(), QLatin1String("Tom Marvolo Riddle") ); // Will work
		+	res.addProperty( NCO::fullname(), QLatin1String("Lord Voldemort") ); // Will fail - nco:fullname has a max cardinality of 1
		+
		+	QString origName = res.property( NCO::fullname() ).toString(); // will return "Tom Marvolo Riddle"
		+	res.setProperty( NCO::fullname(), QLatin1String("Lord Voldemort") ); // will work this time - we're using setProperty
		+
		+	QString newName = res.property( NCO::fullname() ).toString(); // Will return You-know-who
		+	</syntaxhighlight>

	= Nepomuk Resource Generator =		= Nepomuk Resource Generator =

← Older revision		Revision as of 13:21, 23 August 2012
Line 1:		Line 1:
−	The Nepomuk Resource class ~~is undoubtedly~~ the ~~most user visible and used class~~. It ~~serves as~~ a ~~very convenient abstraction over~~ the ~~statements~~.	+	The Nepomuk Resource class provides a convenient wrapper over the Nepomuk data. It does so by keeping a cache of the relevant data and using the Resource Watcher to keep it up to date.
		+
		+	= Saving Resources =
		+	Resources are a real-time view of the data in the virtuoso database. They are automatically saved after each change, and all other resources across the different applications are updated.
		+
		+	=== Saving New Resources ===
		+	A new resource will automatically be saved the first time it is used.
		+
		+	<syntaxhighlight lang="cpp-qt">
		+	Nepomuk2::Resource res;
		+	res.exists(); // Will return false
		+	res.uri(); // Will be blank
		+
		+	res.setRating( 5 ); // Will be created and saved
		+	res.exists(); // Will return true
		+	res.uri(); // Will return its unique identifier
		+	</syntaxhighlight>
		+
		+	= Managing Properties =

	= Nepomuk Resource Generator =		= Nepomuk Resource Generator =

@@ Line 6: / Line 6: @@
 In order to improve this situation we have provided a resource generator, which generates custom <code>Resource</code> classes from the ontologies. It relies on a CMake macro to accomplish that.
 <syntaxhighlight lang="cmake">
 nepomuk2_add_ontology_classes (SRCS
      ONTOLOGIES