Projects/Nepomuk/DataFeeders - Revision history

AnneW: Marked this version for translation

2012-12-11T14:36:50Z

Marked this version for translation

Show changes

AnneW: Prepare for translation

2012-12-11T14:36:32Z

Prepare for translation

Show changes

Vishesh: /* Identification */ Added an example

2012-08-22T10:10:53Z

‎Identification: Added an example

Vishesh: /* StoreResources */ Added links

2012-08-11T08:32:19Z

‎StoreResources: Added links

Vishesh: /* Using the data after pushing */

2012-08-09T15:51:02Z

‎Using the data after pushing

Vishesh: /* Using the data after pushing */

2012-08-09T15:50:37Z

‎Using the data after pushing

Vishesh: /* SimpleResources */ Added KJob::finished signal link

2012-08-09T15:49:48Z

‎SimpleResources: Added KJob::finished signal link

Vishesh: Added Using the data after pushing

2012-08-09T15:47:20Z

Added Using the data after pushing

Vishesh: /* Common Errors */ Mark the errors with bold

2012-08-09T15:38:08Z

‎Common Errors: Mark the errors with bold

Vishesh: Common Errors

2012-08-09T15:37:25Z

Common Errors

@@ Line 65: / Line 65: @@
 * At least one defining property matches.
-- Provide an example -
+=== Example ===
-All blank uris are either mapped to existing resources or new resources are created.
+If the following resource already exists in the Nepomuk Repository -
 == Merging ==

@@ Line 47: / Line 47: @@
 = StoreResources =
-Calling the <code>SimpleResourceGraph::save</code> operational, internally calls the <code>StoreResourcesJob</code> with its default parameters. For more specialized use cases storeResources can directly be called.
+Calling the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1SimpleResourceGraph.html#a9af47ab6961f1f7a5b348c50398fa1dd <code>SimpleResourceGraph::save</code>] operational, internally calls the [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/classNepomuk2_1_1StoreResourcesJob.html <code>StoreResourcesJob</code>] with its default parameters. For more specialized use cases [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gac094511c6157fb1f96f3a3344d48128d storeResources] can directly be called.
-The storeResources is a lengthy procedure that has performs multiple operations on the data after which it pushes the data into Nepomuk. The two main parts of the job are outlined below.
+The [http://api.kde.org/4.x-api/kdelibs-apidocs/nepomuk-core/html/group__nepomuk__datamanagement.html#gac094511c6157fb1f96f3a3344d48128d storeResources] function is a lengthy procedure that has performs multiple operations on the data after which it pushes the data into Nepomuk. The two main parts of the job are outlined below.
 == Identification ==
@@ Line 71: / Line 71: @@
 == Merging ==
 Once the identification process has been completed, each SimpleResource goes through a series of checks which check if the domain, range and carnality of properties is correct, and then pushes the data into the database after merging the graphs for the statements that already exist, and creating a new graph for the new statements.
 = Common Errors =

@@ Line 114: / Line 114: @@
 <syntaxhighlight lang="cpp-qt">
-Nepomuk2::Resource contactRes( contactUri );
+    Nepomuk2::Resource contactRes( contactUri );
-const QString fullname = contactRes.property( NCO::fullname() ).toString();
+    const QString fullname = contactRes.property( NCO::fullname() ).toString();
 </syntaxhighlight>

@@ Line 88: / Line 88: @@
 Example -
 <syntaxhighlight lang="cpp-qt">
      SimpleResource email;
      email.addType( NCO::EmailAddress() );
@@ Line 115: / Line 117: @@
 const QString fullname = contactRes.property( NCO::fullname() ).toString();
 </syntaxhighlight>
 = Who else is using it? =

← Older revision		Revision as of 15:49, 9 August 2012
Line 41:		Line 41:


−	The save operation returns a KJob which has already begun execution. This operation will continue asynchronously, and on completion will emit ~~the~~ signal ~~completed~~.	+	The save operation returns a KJob which has already begun execution. This operation will continue asynchronously, and on completion will emit a [http://api.kde.org/4.8-api/kdelibs-apidocs/kdecore/html/classKJob.html#a67b6c63fc5eb7bd31234960e7a5487d9 signal] on completion.

	The completed signals also return the respective KJob. This job can then be checked for errors, which may have occurred if we tried to save invalid data. It is up to the programmer to make sure that the data is valid. Invalid valid data is completely ignored and an error is given.		The completed signals also return the respective KJob. This job can then be checked for errors, which may have occurred if we tried to save invalid data. It is up to the programmer to make sure that the data is valid. Invalid valid data is completely ignored and an error is given.

← Older revision		Revision as of 15:47, 9 August 2012
Line 81:		Line 81:

	If <Resource> is of the form <code>_:identifier</code> then it means that your SimpleResource with identifier <Resource> is missing the types given. Otherwise if it is of the form <code>nepomuk:/res/unique-uuid</code> that implies that either your SimpleResource was identifier as <Resource> and that resource does not have the respective types, or that you are trying to map it to a resource which does not contain that type.		If <Resource> is of the form <code>_:identifier</code> then it means that your SimpleResource with identifier <Resource> is missing the types given. Otherwise if it is of the form <code>nepomuk:/res/unique-uuid</code> that implies that either your SimpleResource was identifier as <Resource> and that resource does not have the respective types, or that you are trying to map it to a resource which does not contain that type.
		+
		+	= Using the data after pushing =
		+
		+	In some applications you may need to access the data after you have pushed it into Nepomuk using <code>storeResources</code>. Fortunately there is a convenient way to do that. The SimpleResourceJob provides a function calling mappings, which lets you map the SimpleResource uris to the actual nepomuk uris once they have been saved.
		+
		+	Example -
		+	<syntaxhighlight lang="cpp-qt">
		+	SimpleResource email;
		+	email.addType( NCO::EmailAddress() );
		+	email.addProperty( NCO::emailAddress(), QLatin1String("spiderman@kde.org") );
		+
		+	SimpleResource contact;
		+	contact.addType( NCO::Contact() );
		+	contact.setProperty( NCO::fullname(), QLatin1String("Peter Parker") );
		+	contact.addProperty( NCO::hasEmailAddress(), email );
		+
		+	SimpleResourceGraph graph;
		+	graph << contact << email;
		+
		+	StoreResourcesJob* job = graph.save();
		+	job->exec();
		+	QASSERT( !job->error() );
		+
		+	QUrl emailUri = job->mappings().value( email.uri() );
		+	QUrl contactUri = job->mappings().value( contact.uri() );
		+	</syntaxhighlight>
		+
		+
		+	Here the <code>email.uri()</code> function will return a uri of the form <code>_:identifier</code>. Same is the case with <code>contact.uri()</code>. The <code>StoreResourcesJob::mappings</code> returns a <code>QHash</code> which maps these blank uris to their respective nepomuk uris. They can then be used as follows -
		+
		+	<syntaxhighlight lang="cpp-qt">
		+	Nepomuk2::Resource contactRes( contactUri );
		+	const QString fullname = contactRes.property( NCO::fullname() ).toString();
		+	</syntaxhighlight>
		+

	= Who else is using it? =		= Who else is using it? =

@@ Line 74: / Line 74: @@
 = Common Errors =
-. <Property> has a max cardinality of <value>. Provided <n> values - <list>. Existing - <list>
+. '''<Property> has a max cardinality of <value>. Provided <n> values - <list>. Existing - <list>'''
 The error indicates that you're not following the cardinality restrictions that are present in the ontologies. For example [http://oscaf.sourceforge.net/nco.html#nco:fullname nco:fullname] has a max cardinality 1. That means that any resource can at max have one full name. You have probably given your SimpleResource Contact two full names.
-. <Property> has rdfs:domain/rdfs:range of <Type>. <Resource> only has the following types
+. '''<Property> has rdfs:domain/rdfs:range of <Type>. <Resource> only has the following types'''
 If <Resource> is of the form <code>_:identifier</code> then it means that your SimpleResource with identifier <Resource> is missing the types given. Otherwise if it is of the form <code>nepomuk:/res/unique-uuid</code> that implies that either your SimpleResource was identifier as <Resource> and that resource does not have the respective types, or that you are trying to map it to a resource which does not contain that type.

← Older revision		Revision as of 15:37, 9 August 2012
Line 72:		Line 72:

	Once the identification process has been completed, each SimpleResource goes through a series of checks which check if the domain, range and carnality of properties is correct, and then pushes the data into the database after merging the graphs for the statements that already exist, and creating a new graph for the new statements.		Once the identification process has been completed, each SimpleResource goes through a series of checks which check if the domain, range and carnality of properties is correct, and then pushes the data into the database after merging the graphs for the statements that already exist, and creating a new graph for the new statements.
		+
		+	= Common Errors =
		+	1. <Property> has a max cardinality of <value>. Provided <n> values - <list>. Existing - <list>
		+
		+	The error indicates that you're not following the cardinality restrictions that are present in the ontologies. For example [http://oscaf.sourceforge.net/nco.html#nco:fullname nco:fullname] has a max cardinality 1. That means that any resource can at max have one full name. You have probably given your SimpleResource Contact two full names.
		+
		+	2. <Property> has rdfs:domain/rdfs:range of <Type>. <Resource> only has the following types
		+
		+	If <Resource> is of the form <code>_:identifier</code> then it means that your SimpleResource with identifier <Resource> is missing the types given. Otherwise if it is of the form <code>nepomuk:/res/unique-uuid</code> that implies that either your SimpleResource was identifier as <Resource> and that resource does not have the respective types, or that you are trying to map it to a resource which does not contain that type.

	= Who else is using it? =		= Who else is using it? =