Author: buildbot
Date: Wed Feb 15 10:49:36 2012
New Revision: 804902
Log:
Staging update by buildbot for stanbol
Modified:
websites/staging/stanbol/trunk/ (props changed)
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/index.html
Propchange: websites/staging/stanbol/trunk/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Feb 15 10:49:36 2012
@@ -1 +1 @@
-1244426
+1244434
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/index.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/index.html
(original)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/index.html
Wed Feb 15 10:49:36 2012
@@ -57,7 +57,7 @@
<div id="content">
<h1 class="title">Stanbol Enhancer</h1>
- <p>The Apache Stanbol Enhancer provides both a RESTful and a Java API that
allows caller to Extract features from parsed Content. In more detail the
parsed Content is processed by <a href="engines">enhancement engines</a> as
defined by the called <a href="chains/enhancementchain.html">Enhancement
Chain</a>.</p>
+ <p>The Apache Stanbol Enhancer provides both a RESTful and a Java API that
allows caller to Extract features from parsed Content. In more detail the
parsed Content is processed by <a href="engines">Enhancement Engines</a> as
defined by the called <a href="chains/enhancementchain.html">Enhancement
Chain</a>.</p>
<h2 id="using_the_stanbol_enhancer">Using the Stanbol Enhancer</h2>
<p>The following figure provides an overview about the RESTful as well as the
Java API provided by the Stanbol Enhancer</p>
<p><img alt="Stanbol Enhancer Overview" src="enhanceroverview.png"
title="Overview about the RESTful Services and Java API provided by the Stanbol
Enhancer" /></p>
@@ -114,10 +114,18 @@
<h2 id="list_of_available_enhancement_engines">List of Available Enhancement
Engines</h2>
<p>Apache Stanbol comes with a <a href="engines/list.html">list of predefined
enhancement engines</a>. These engines are supported by the Apache Stanbol
community. If you would like to implement your own enhancement engine, you
should go on reading this documentation.</p>
<h2 id="main_interfaces_and_utilities">Main Interfaces and Utilities</h2>
-<p>A <a href="contentitem.html">content item</a> is the unit of content that
Stanbol Enhancer can deal with. It gives access to the binary content that was
registered, and the graph that represents its metadata (provided by client
and/or generated). The <a href="engines/">enhancement engine</a> provides the
interface to internal or external semantic enhancement engines. There will
usually be several of those, that the EnhancementJobManager uses to enhance
content items. The <a href="enhancementjobmanager.html">enhancement job
manager</a> accepts requests for enhancing <a href="contentitem.html">content
items</a>, and processes them either synchronously or asynchronously (as
decided by the enhancement engines or by configuration). The enhancement engine
helper provides the classes for the resulting enhancement structure according
to the defined enhancement structure.</p>
+<ul>
+<li><strong>ContentItem</strong>: A <a href="contentitem.html">content
item</a> is the unit of content that Stanbol Enhancer can deal with. It gives
access to the binary content that was registered, and the graph that represents
its metadata (provided by client and/or generated). </li>
+<li><strong>EnhancementEngine</strong>: The <a href="engines">enhancement
engine</a> provides the interface to internal or external semantic enhancement
engines. Typically content items will be processed by several enhancement
engines.</li>
+<li><strong>EnhancementChain</strong>: A <a
href="chains/enhancementchain.html">enhancement chain</a> represents a user
provided configuration that describes how <a href="contentitem.html">content
item</a>s parsed to this chain should be processed by the Stanbol Enhancer. A
chain defines list of <a href="engines/">enhancement engine</a> and their order
of execution.</li>
+<li><strong>EnhancementJobManager</strong>: The <a
href="enhancementjobmanager.html">EnhancementJobManager</a> performs the
execution of the enhancement process as described in the <a
href="chains/executionplan.html">execution plan</a> provided by the <a
href="chains/enhancementchain.html">enhancement chain</a>. The enhancement job
manager is also responsible for recording the <a
href="executionmetadata.html">execution metadata</a>.</li>
+<li><strong>ChainManager</strong>: The <a
href="chains/chainmanager.html">chain manager</a> allows to lookup all
configured enhancement chains. It also provides a getter for the default
chain.</li>
+<li><strong>EnhancementEngineManager</strong>: The <a
href="engines/enhancementenginemanager.html">enhancement engine manager</a>
allows to lookup active enhancement engines by their name.</li>
+</ul>
+<p>Note that the "org.apache.stanbol.enhancer.servicesapi" module also provide
a set of "**Helper" utility classes (e.g. ContentItemHelper,
EnhancementEngineHelper, â¦). It is highly recommended for users to use the
functionality provided by such helpers when working with the according classes
of the Stanbol Enhancer.</p>
<h2 id="enhancement_structure">Enhancement Structure</h2>
<p>The enhancement structure for Apache Stanbol is been described <a
href="http://wiki.iks-project.eu/index.php/EnhancementStructure";>here</a> in
full. It defines the types and properties used for the resulting metadata graph
of Apache Stanbol.</p>
-<p><em>Note: There is a proposal and ongoing discussion to update this
structure in the future.</em></p>
+<p><strong>_Note:</strong> The currently used Enhancement Structure was
defined before the incubation to Apache. There is a proposal and ongoing
discussion to update this structure in the future however the decision was to
keep the current Structure until a first Release._</p>
<p>Each enhancement type description which contains the following important
properties:</p>
<ul>
<li>creator: the specific enhancement engine creating this enhancement</li>
