Author: fchrist
Date: Mon Jan 16 10:00:26 2012
New Revision: 1231889
URL: http://svn.apache.org/viewvc?rev=1231889&view=rev
Log:
STANBOL-456 Extended FactStore description
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/index.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/index.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/index.mdtext?rev=1231889&r1=1231888&r2=1231889&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/index.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/factstore/index.mdtext
Mon Jan 16 10:00:26 2012
@@ -2,15 +2,21 @@ Title: Factstore
The FactStore is a component that let's use store relations between entities
identified by their URIs. A relation between two or more entities is called a
*fact*. The FactStore let's you store N-ary facts according to a user defined
fact schema. In consequence you can store relations between N participating
entities.
+The FactStore only stores the relation and not the entities itself. It only
uses references to entities by using the entities' URI. The entities itself
should be handled by another component, e.g. the
[EntityHub](../entityhub.html). A fact is defined by a fact schema which is
defined over types of entities.
+
+A fact schema can be defined between an arbitrary number of entities. In most
cases a fact schema is defined between two or three entities. For example, the
fact schema 'works-for' can be defined as a relation between entities of type
'Person' and 'Organization'. The Fact Store interface allows the creation of
custom fact schemata and to store facts according to these custom schemata.
+
+The Fact Store provides a simple to define and store facts. This component is
meant to be used in scenarios where a simple solution is sufficient and it is
not required to define a complex ontology with reasoning support.
+
Read on and have a look at a concrete example or go to the [FactStore
specification](specification.html) page for more details. If you need some
information about its realization, read the notes about its [implementation
concept](implementation.html).
## Example
Imagine you want to store the fact that the person named John Doe works for
the company Winzigweich. John Doe is represented by the URI
http://www.doe.com/john and the company by http://www.winzigweich.de. This fact
is stored as a relation between the entity http://www.doe.com/john and
http://www.winzigweich.de.
-For this, we first need to create a so called fact schema that tells the
FactStore what we would like to store. A fact schema has a unique name (often
an URI is used) to identify it. To specify what kinds of entities we would like
to store, we specify the type of the entities. Each type has an URI and should
be defined by some ontology. For example, we can use the ontology specified by
http://schema.org/.
+For this, we first need to create a so called fact schema that tells the
FactStore what we would like to store. A fact schema has a unique name (often
an URI is used) to identify it. To specify what kinds of entities we would like
to store, we specify the type of the entities. Each type has an URI and should
be defined by some ontology. For example, we can use the ontology specified by
[schema.org](http://schema.org/).
-According to http://schema.org/ a person is of type http://schema.org/Person
and an organization is of type http://schema.org/Organization. We will use
these type information to specify the fact schema
http://factschema.org/worksFor. The specification of a fact schema is written
in JSON-LD, like this:
+According to [schema.org](http://schema.org/) is a person of type
[http://schema.org/Person](http://schema.org/Person) and an organization is of
type [http://schema.org/Organization](http://schema.org/Organization). We will
use these type information to specify the fact schema
http://factschema.org/worksFor. The specification of a fact schema is written
in JSON-LD, like this:
{
"@context" : {
@@ -46,4 +52,4 @@ On success this will return a 201 (Creat
## REST API Documentation
-To get the latest documentation you should start your copy of Apache Stanbol
and navigate your browser to http://localhost:8080/factstore. There you will
find more information and the documentation of the FactStore's REST API.
\ No newline at end of file
+To get the latest documentation you should start your copy of an Apache
Stanbol launcher that includes the FactStore and navigate your browser to
http://localhost:8080/factstore. There you will find more information and the
documentation of the FactStore's REST API.
\ No newline at end of file
