svn commit: r803421 - in /websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer: chains/enhancementchain.html chains/executionplan.html engines/enhancementengine.html enhancementjobmanager.html executionmetadata.html

[bu...@apache.org]

Author: buildbot
Date: Fri Jan 27 13:06:40 2012
New Revision: 803421

Log:
Staging update by buildbot for stanbol

Modified:
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.html
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.html
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementengine.html
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.html
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.html

Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.html Fri Jan 27 13:06:40 2012
@@ -57,7 +57,7 @@
   
   <div id="content">
     <h1 class="title">Enhancement Chains</h1>
-    <p>An Enhancement Chain defines how Content parsed to the Stanbol Enhancer is processed. More concrete it defines what <a href="../engines/enhancementengine.html">EnhancementEngine</a>s and in what order are used to process ContentItems. Chains are not responsible for the actual processing of ContentItems. They provide the <a href="executionplan.html">ExecutionPlan</a> to the <a href="../enhancementjobmanager.html">EnhancementJobManger</a> that does the actual processing of the ContentItem.</p>
+    <p>An Enhancement Chain defines how Content parsed to the Stanbol Enhancer is processed. More concrete it defines what <a href="../engines/enhancementengine.html">EnhancementEngine</a>s and in what order are used to process <a href="../contentitem.html">ContentItem</a>s. Chains are not responsible for the actual processing of ContentItems. They provide the <a href="executionplan.html">ExecutionPlan</a> to the <a href="../enhancementjobmanager.html">EnhancementJobManger</a> that does the actual processing of the ContentItem.</p>
 <p>In the RESTful API enhancement chains can be accessed by there name under</p>
 <div class="codehilite"><pre><span class="n">http:</span><span class="sr">//</span><span class="p">{</span><span class="n">host</span><span class="p">}:{</span><span class="n">port</span><span class="p">}</span><span class="sr">/{stanbol-path}/</span><span class="n">enhancer</span><span class="sr">/chain/</span><span class="p">{</span><span class="n">chain</span><span class="o">-</span><span class="n">name</span><span class="p">}</span>
 </pre></div>

Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.html Fri Jan 27 13:06:40 2012
@@ -57,7 +57,7 @@
   
   <div id="content">
     <h1 class="title">ExecutionPlan</h1>
-    <p>The ExecutionPlan is represented as an RDF graph following the ExecutionPlan Ontology. It needs to be provided by the <a href="enhancementchain.html">Enhancement Chain</a> and is used by the <a href="../enhancementjobmanager.html">EnhancementJobManager</a> to enhance ContentItems and to write the <a href="../executionmetadata.html">ExecutionMetadata</a>.</p>
+    <p>The ExecutionPlan is represented as an RDF graph following the ExecutionPlan Ontology. It needs to be provided by the <a href="enhancementchain.html">Enhancement Chain</a> and is used by the <a href="../enhancementjobmanager.html">EnhancementJobManager</a> to enhance <a href="../contentitem.html">ContentItem</a>s and to write the <a href="../executionmetadata.html">ExecutionMetadata</a>.</p>
 <h2 id="executionplan_ontology">ExecutionPlan Ontology</h2>
 <p>The RDFS schema used for the execution plan is defined as follows.</p>
 <ul>

Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementengine.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementengine.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementengine.html Fri Jan 27 13:06:40 2012
@@ -57,7 +57,7 @@
   
   <div id="content">
     <h1 class="title">EnhancementEngine</h1>
-    <p>EnhancementEngines are the components that are responsible to enhance ContentItmes. They are called by the <a href="../enhancementjobmanager.html">EnhancementJobManager</a>. EnhancementEngines do have full access to the parsed ContentItems. They are expected to modify the state of the content item.</p>
+    <p>EnhancementEngines are the components that are responsible to enhance ContentItmes. They are called by the <a href="../enhancementjobmanager.html">EnhancementJobManager</a>. EnhancementEngines do have full access to the parsed <a href="../contentitem.html">ContentItem</a>s. They are expected to modify the state of the content item.</p>
 <p>The RESTful interface of an EnhancementEngines can be accessed by</p>
 <div class="codehilite"><pre><span class="n">http:</span><span class="sr">//</span><span class="p">{</span><span class="n">host</span><span class="p">}:{</span><span class="n">port</span><span class="p">}</span><span class="sr">/{stanbol-root}/</span><span class="n">enhancer</span><span class="sr">/engine/</span><span class="p">{</span><span class="n">engine</span><span class="o">-</span><span class="n">name</span><span class="p">}</span>
 </pre></div>
@@ -92,7 +92,7 @@
 <p>Each EnhancementEngine has an name assigned. This is typically provided by the engine configuration and MUST be set as value to the property "stanbol.enhancer.engine.name" in the service registration of the enhancement engine. The getter for the name MUST return the same value as the value set to this property. EnhancementEngine implementations will usually get the name by calling</p>
 <p>this.name = (String)ComponentContext.getProperties(EnhancementEngine.PROPERTY_NAME);</p>
 <p>in the activate method.</p>
-<p>The "canEnahnce(ContentItem ci)" method is used by the <a href="../enhancementjobmanager.html">EnhancementJobManager</a> to check if an engine is able to process a ContentItem. Calling this method MUST NOT change the state of the ContentItem and this method MUST also NOT acquire a write lock on the content item.</p>
+<p>The "canEnahnce(ContentItem ci)" method is used by the <a href="../enhancementjobmanager.html">EnhancementJobManager</a> to check if an engine is able to process a <a href="../contentitem.html">ContentItem</a>. Calling this method MUST NOT change the state of the ContentItem and this method MUST also NOT acquire a write lock on the content item.</p>
 <p>The "computeEnhacements(ContentItem ci)" starts the processing of the parsed ContentItem by the engine. It is expected to change the state of the parsed ContentItem. Engines that support asynchronous processing need to take care to correctly apply read/write locks when reading/writing information from/to the content time. Engines that return ENHANCE_SYNCHRONOUS on calls to canEnhance(..) do not need to use locks. They can trust that they have exclusive read/write access to the content item.</p>
 <p>EnhancementEngiens do have full access to the ContentItem. Theoretically they would be even allowed to delete all metadata as well as all content parts from the parsed ContentItem. However typically the do only</p>
 <ul>

Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.html Fri Jan 27 13:06:40 2012
@@ -57,7 +57,7 @@
   
   <div id="content">
     <h1 class="title">EnhancementJobManager</h1>
-    <p>The EnhancementJobManager is component responsible for the execution of the <a href="chains/executionplan.html">ExecutionPlan</a> as provided by the <a href="chains/enhancementchain.html">Enhancement Chain</a> on the ContentItem.</p>
+    <p>The EnhancementJobManager is component responsible for the execution of the <a href="chains/executionplan.html">ExecutionPlan</a> as provided by the <a href="chains/enhancementchain.html">Enhancement Chain</a> on the <a href="contentitem.html">ContentItem</a>.</p>
 <h2 id="enhancementjobmanager_interface">EnhancementJobManager interface</h2>
 <p>The interface of the EnhancementJobManager is very simple:</p>
 <div class="codehilite"><pre><span class="sr">/** Enhances the content item by using the default Chain */</span>
@@ -70,10 +70,10 @@
 <p>Note that the parsed ContentItem will be changed during the enhancement process. <a href="engines/enhancementengine.html">EnhancementEngine</a>s will add extracted knowledge to the metadata of the content item. Also additional content parts may be added to the content item.</p>
 <h2 id="enhancement_process">Enhancement Process</h2>
 <p>While the <a href="chains/executionplan.html">ExecutionPlan</a> defines what EnhancementEgnies are used and how they depend on each the EnhancementJobManager is responsible for the actual execution of the enhancement process based on this plan. This section provides detailed information about requirements and expectations that MUST BE considered.</p>
-<p>The EnhancementJobManager is also responsible to create and update the <a href="executionmetadata.html">ExecutionMetadata</a> in the metadata of the processed ContentItem.</p>
+<p>The EnhancementJobManager is also responsible to create and update the <a href="executionmetadata.html">ExecutionMetadata</a> in the metadata of the processed <a href="contentitem.html">ContentItem</a>.</p>
 <h3 id="retrieving_the_executionplan">Retrieving the ExecutionPlan</h3>
 <p>The <a href="chains/executionplan.html">ExecutionPlan</a> is provided by the Chain in a final graph that is guaranteed to be not changed. However because the configuration of a Chain might be change at any time the EnhancementJobManager MUST retrieve the execution plan only once and used it during the whole enhancement process.</p>
-<p>Before the start of the enhancement process the EnhancementJobManager needs first to initialize the <a href="executionmetadata.html">ExecutionMetadata</a> for the ContentItem. This includes</p>
+<p>Before the start of the enhancement process the EnhancementJobManager needs first to initialize the <a href="executionmetadata.html">ExecutionMetadata</a> for the <a href="contentitem.html">ContentItem</a>. This includes</p>
 <ol>
 <li>copying the execution plan as returned by the Chain to the metadata of the content item</li>
 <li>create an 'em:ChainExecutin' instance and set the 'em:enhances' property to the URI of the ContentItem</li>
@@ -120,7 +120,7 @@ This code snippet assumes to be called a
 <p>This implementation is provided by the "org.apache.stanbol.enhancer.jobmanager.event" module and is currently used as default. It registers itself (by default) with a service ranking of '0'.</p>
 <p>This implementation supports an asynchronous enhancement process by using the <a href="http://www.osgi.org/javadoc/r4v42/org/osgi/service/event/package-summary.html">"org.osgi.serivce.event"</a> framework. </p>
 <h3 id="weightedjobmanager">WeightedJobManager</h3>
-<p>This JobManager was used as default before the introduction of EnhancementChains. It does not support EnhancementChains and will enhance parsed ContentItems by calling all currently active EnhancementEngines in a sequential manner. It does also not have support for EnhancementMetadata.</p>
+<p>This JobManager was used as default before the introduction of EnhancementChains. It does not support EnhancementChains and will enhance parsed <a href="contentitem.html">ContentItem</a>s by calling all currently active EnhancementEngines in a sequential manner. It does also not have support for EnhancementMetadata.</p>
 <p>This implementation is provided by the "org.apache.stanbol.enhancer.jobmanager.weightedjobmanager" module and is no longer included within the Apache Stanbol launchers. This JobManager registers itself with a service ranking of "-1000". Users that want to use this job manager need to manually install this bundle and either deactivate other EnhancementJobManager implementation or reconfigure the service ranking of this one to an value &gt; 0.</p>
   </div>
   

Modified: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.html
==============================================================================
--- websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.html (original)
+++ websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.html Fri Jan 27 13:06:40 2012
@@ -57,7 +57,7 @@
   
   <div id="content">
     <h1 class="title">Execution Metadata</h1>
-    <p>The execution metadata are added by the <a href="enhancementjobmanager.html">EnhancementJobManager</a> to the metadata of the ContentItem. This metadata provide information about the execution of the <a href="chains/executionplan.html">ExecutionPlan</a> provided by the <a href="chains/enhancementchain.html">Chain</a> and can be used by clients to get detailed information about the enhancement process of a content item.</p>
+    <p>The execution metadata are added by the <a href="enhancementjobmanager.html">EnhancementJobManager</a> to the metadata of the <a href="contentitem.html">ContentItem</a>. This metadata provide information about the execution of the <a href="chains/executionplan.html">ExecutionPlan</a> provided by the <a href="chains/enhancementchain.html">Chain</a> and can be used by clients to get detailed information about the enhancement process of a content item.</p>
 <p>In the case of asynchronous calls to the enhancers RESTful interface (requests that immediately return and do not wait for the enhancement process to complete) this information might also be useful to provide information about the current state of the enhancement process.</p>
 <h3 id="exection_metadata_ontology">Exection Metadata Ontology</h3>
 <p>The RDFS schema used for the execution plan is defined as follows.</p>
@@ -179,7 +179,7 @@
 </pre></div>
 
 
-<p>Note that both the Execution Metadata AND the Execution Plan need to be contained within the metadata of the ContentItem</p>
+<p>Note that both the Execution Metadata AND the Execution Plan need to be contained within the metadata of the <a href="contentitem.html">ContentItem</a></p>
   </div>
   
   <div id="footer">