Author: rwesten
Date: Wed Feb 15 10:49:29 2012
New Revision: 1244434
URL: http://svn.apache.org/viewvc?rev=1244434&view=rev
Log:
updates to the - Main Interfaces and Utilits - section of the Stanbol Enhancer
documentation
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext?rev=1244434&r1=1244433&r2=1244434&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/index.mdtext
Wed Feb 15 10:49:29 2012
@@ -1,6 +1,6 @@
Title: Stanbol Enhancer
-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 [enhancement engines](engines) as defined by the called
[Enhancement Chain](chains/enhancementchain.html).
+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 [Enhancement Engines](engines) as defined by the called
[Enhancement Chain](chains/enhancementchain.html).
## Using the Stanbol Enhancer
@@ -64,13 +64,21 @@ Apache Stanbol comes with a [list of pre
## Main Interfaces and Utilities
-A [content item](contentitem.html) 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 [enhancement engine](engines/) 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 [enhancement job manager](enhancementjobmanager.html) accepts requests for
enhancing [content items](contentitem.html), 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.
+* __ContentItem__: A [content item](contentitem.html) 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).
+* __EnhancementEngine__: The [enhancement engine](engines) provides the
interface to internal or external semantic enhancement engines. Typically
content items will be processed by several enhancement engines.
+* __EnhancementChain__: A [enhancement chain](chains/enhancementchain.html)
represents a user provided configuration that describes how [content
item](contentitem.html)s parsed to this chain should be processed by the
Stanbol Enhancer. A chain defines list of [enhancement engine](engines/) and
their order of execution.
+* __EnhancementJobManager__: The
[EnhancementJobManager](enhancementjobmanager.html) performs the execution of
the enhancement process as described in the [execution
plan](chains/executionplan.html) provided by the [enhancement
chain](chains/enhancementchain.html). The enhancement job manager is also
responsible for recording the [execution metadata](executionmetadata.html).
+* __ChainManager__: The [chain manager](chains/chainmanager.html) allows to
lookup all configured enhancement chains. It also provides a getter for the
default chain.
+* __EnhancementEngineManager__: The [enhancement engine
manager](engines/enhancementenginemanager.html) allows to lookup active
enhancement engines by their name.
+
+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.
+
## Enhancement Structure
The enhancement structure for Apache Stanbol is been described
[here](http://wiki.iks-project.eu/index.php/EnhancementStructure) in full. It
defines the types and properties used for the resulting metadata graph of
Apache Stanbol.
-_Note: There is a proposal and ongoing discussion to update this structure in
the future._
+___Note:__ 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._
Each enhancement type description which contains the following important
properties:
