Author: alexdma
Date: Mon Jan 16 12:09:14 2012
New Revision: 1231967
URL: http://svn.apache.org/viewvc?rev=1231967&view=rev
Log:
STANBOL-448 :
- Small correction to Ontology Manager component description
- initial Java API documentation for OntoNet
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/ontonet.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext?rev=1231967&r1=1231966&r2=1231967&view=diff
==============================================================================
--- incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
(original)
+++ incubator/stanbol/site/trunk/content/stanbol/docs/trunk/components.mdtext
Mon Jan 16 12:09:14 2012
@@ -21,7 +21,7 @@ We will shortly describe the components
* The [Reasoners](reasoners.html) can be used to automatically infer
additional knowledge. It is used to obtain new facts in the knowledge base,
e.g. if your enhanced content tells you about a shop located in "Montparnasse",
you can infer via a "located-in" relation that the same shop is located in
"Paris", in the "Ãle-de-France" and in "France".
-* The [Ontology Manager](ontologymanager.html) has the facility to manage your
ontologies. Ontologies are used to define the knowledge models that describe
the content's metadata. Additionally, the semantic of you metadata can be
defined through an ontology.
+* The [Ontology Manager](ontologymanager.html) is the facility that manages
your ontologies. Ontologies are used to define the knowledge models that
describe the metadata of content. Additionally, the semantics of your metadata
can be defined through an ontology.
* The [CMS Adapter](cmsadapter.html) can be used to map (bidirectionally)
existing node structures from content repositories (CMIS) to RDF models.
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/ontonet.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/ontonet.mdtext?rev=1231967&r1=1231966&r2=1231967&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/ontonet.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/ontologymanager/ontonet.mdtext
Mon Jan 16 12:09:14 2012
@@ -1,5 +1,4 @@
Title: Ontology Network Manager (OntoNet)
-=========================================
## Terminology
@@ -11,9 +10,38 @@ Stanbol OntoNet implements the API secti
* Session: a container of (supposedly volatile) semantic data which need to be
intercrossed with one or more Scopes, for stateful management of ontology
networks. It can be used to load instances and reason on them using different
models (one per scope). An OntoNet Session is not equivalent to an HTTP session
(since it can live persistently across multiple HTTP sessions), although its
behaviour can reflect the one of the HTTP session that created it, if required
by the implementation.
-## Service Endpoints
--------------------
+## Usage
+
+Given the entire knowledge base managed by your CMS, OntoNet allows the
construction and management of ontology networks, programmatically via its Java
API or RESTful Web Services _(see next section for details on the latter)_. A
criterion for choosing the appropriate API can be as follows:
+
+* Stanbol plugins or server software that incorporates Stanbol (e.g. larger
OSGi platforms) should use the Java API.
+
+* Client applications, non-Java CMSs or services decoupled from Stanbol should
use the RESTful API.
+
+* Java-based CMSs can use either API.
+
+### Java API
+
+First and foremost, the concept of __ontology network__ is implicit in the
OntoNet API. There is no such thing as an `OntologyNetwork` type. What you do
is create `OntologyScope` and `Session` objects and link them together at
creation time or when launching a process.
+
+#### Accessing the managers.
+
+First and foremost let us obtain references to the main OntoNet manager
classes. In an OSGi environment they can be obtained by reference:
+
+ @Reference
+ ONManager onMgr;
+
+ @Reference
+ SessionManager sesMgr;
+
+In a non-OSGi environment they must be instantiated as POJOs (Plain Old Java
Objects):
+
+ TODO
+
+### Service Endpoints
+
The OntoNet RESTful API is structured as follows:
_(Please note, that the following links to the actual service endpoints link
to a running instance of Apache Stanbol. If you use other domains or ports than
"localhost:8080", then please change accordingly)_
