Author: anuzzolese
Date: Mon Jan 16 11:29:29 2012
New Revision: 1231936
URL: http://svn.apache.org/viewvc?rev=1231936&view=rev
Log:
[STANBOL-453] Committed patch propose by Alberto Musetti. It is about the
documentation of the Refactor.
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/refactor.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/store.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/refactor.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/refactor.mdtext?rev=1231936&r1=1231935&r2=1231936&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/refactor.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/refactor.mdtext
Mon Jan 16 11:29:29 2012
@@ -1,22 +1,48 @@
-Title: Refactor
-
-The Refactor is a service which allows to interpret rules in order to perform
refactoring of RDF graphs. For the refactoring the set of rules in the recipes
are interpreted and run as SPARQL CONTRUCT in which the where clause is derived
from the body of the rule and the construct clause is derived from the head of
the rule. The output of a refactoring is a transformed graph which satisfies
the constraints expressed in the rules. The refactoring in useful for tasks of
semantic harmonization of RDF graphs expressed with different
ontologies/vocabularies towards their representation with a single ontology or
vocagulary. The output of a refactoring is a transformed graph which satisfies
the constraints expressed in the rules.
-
-## Terminology
-
-* A __Recipe__ is a set of rules defined according to a specific task. Rules
are written in a specific syntax, and can then be executed for refactoring (as
SPARQL queries) or through reasoning services.
-* __Refactoring__ is the task aimed to perform the transformation of RDF
graphs. The transformation is driven by refactoring rules, basically Stanbol
Rules interpreted as SPARQL CONSTRUCT clauses.
-* __Reasoning__ is the activity of interpreting axioms for inferring new
knowledge, classifying, checking the consistency of an ontology, etc...
## Usage Scenarios
-Supposing we have configured the IKS (i.e. Stanbol EntityHub) in order to
fetch entities about persons from DBpedia. Now we want to represent these
entities adopting the vocabulary from schema.org and produce schemaOrg Rich
Snippets in order to provide to the IKS search engine optimization
capabilities. What we need to do is to write a recipe and calling the Refactor
via HTTP REST passing to it the recipe itself and the entities we have fetched
frol Linked Data.
+Supposing we want to use some dataset in Linked
+Data as external knowledge bases for the IKS. Now the problem how to use data
+from those datasets expressed with some external and heterogeneous vocabularies
+or ontologies within the IKS has. Furthermore the IKS has its own way to
+formalize knowledge, namely the its Ontology Network managed by [Stanbol
OntoNet](../ontologymanager/ontonet.html).
+The solution is provided by Refactor which allows to interpret the rules of
+inference as refactoring rules in order harmonize external data to the
+Stanbol's ontologies. Figure 1 gives a very quick idea about
+how the IKS can benefit from the Refactor showing how external data can be
+aligned and used within the IKS.
+
+<figure>
+
+<figcaption>Figure 1: the refactor is used to
+ align external data to the ontologies used in the IKS.</figcaption>
+</figure>
+
+We can specify a concrete scenario for a better understanding of the
+Refactor. Suppose we have configured the IKS (i.e. [Stanbol
EntityHub](../entityhub.html)) in order
+to fetch entities about persons from DBpedia. Now we want to represent these
+entities adopting the vocabulary from schema.org and produce
+schemaOrg Rich Snippets in order to provide to the IKS search engine
+optimization capabilities. What we need to do is to write a recipe and call
+the Refactor via HTTP REST passing to it the recipe itself and the entities we
+have fetched from Linked Data.
+
+## Features
+
+todo...
+
+## Service Endpoints
+
+The Refactor RESTful API is structured as follows:
+_(Please note, that the following links to the actual service endpoint link to
a running instance of Apache Stanbol. If you use other domains or ports than
"localhost:8080", then please change accordingly)_
-## Usage
+### Refactor Engine ("/refactor"):
+- The Refactor Engine __@/refactor__ performs a refactoring applying an
existing recipe in the rule store to the provided RDF graph.
-### Service Endpoints
+### Refactor Engine ("/refactor/apply"):
+- Refactor Engine __@/refactor/apply__ performs a refactoring applying an
recipe as string to the provided RDF graph as input source.
____
_[Back to Stanbol Rules](../rules.html)_
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/store.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/store.mdtext?rev=1231936&r1=1231935&r2=1231936&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/store.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/rules/store.mdtext
Mon Jan 16 11:29:29 2012
@@ -11,6 +11,6 @@ _(Please note, that the following links
### Recipe Manager ("/rules/recipe"):
-- The Recipe Manager @ [/rules/rule](http://localhost:8080/rules/rule) allows
to manage, store and retrieve pre-defined rule sequences, or __recipes__.
+- The Recipe Manager @ [/rules/recipe](http://localhost:8080/rules/recipe)
allows to manage, store and retrieve pre-defined rule sequences, or __recipes__.
TODO
\ No newline at end of file
