Author: buildbot
Date: Wed Apr 11 08:50:43 2012
New Revision: 812320
Log:
Staging update by buildbot for stanbol
Modified:
websites/staging/stanbol/trunk/content/ (props changed)
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitem.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemfactory.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/index.html
Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Apr 11 08:50:43 2012
@@ -1 +1 @@
-1324631
+1324645
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitem.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitem.html
(original)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitem.html
Wed Apr 11 08:50:43 2012
@@ -77,12 +77,12 @@
<p>Content parts are accessible by the index <em>and</em> by their URI
formatted ID. Re-adding a content part will replace the old one. The index will
not be changed by this operation.</p>
<p>There are two types of content parts:</p>
<ol>
-<li>Content parts which have additional metadata provided within the metadata
of the content item. Such content parts are typically used to store transformed
versions of the original content. This allows e.g. engines which can only
process plain text versions to query for the content part containing this
version of the parsed document.</li>
+<li>Content parts which have additional metadata provided within the metadata
of the content item. Such content parts are typically used to store transformed
versions of the original content. This allows e.g. engines which can only
process plain text versions to query for the content part containing this
version of the passed document.</li>
<li>Content parts that are registered under a predefined URI. Such content
parts are typically not mentioned within the metadata of the content item. This
is used to share intermediate enhancement results between enhancement engines.
An example would be tokens, sentences, POS tags and chunks that are extracted
by some NLP engine. Engines which want to consume such data need to know the
predefined URI of the content part holding this data. They will check within
the <code>canEnhance(..)</code> method if a content part with an expected URI
is present and if it has the correct type. </li>
</ol>
<h3 id="accessing-the-main-content-of-the-contentitem">Accessing the main
content of the ContentItem</h3>
-<p>The main content of the ContentItem refers to the content parsed by the
enhancement request (or downloaded from the URL provided by a request). For
accessing this content the following methods are available</p>
-<div class="codehilite"><pre><span class="cm">/** Getter for the InputStream
of the content as parsed</span>
+<p>The main content of the ContentItem refers to the content passed by the
enhancement request (or downloaded from the URL provided by a request). For
accessing this content the following methods are available</p>
+<div class="codehilite"><pre><span class="cm">/** Getter for the InputStream
of the content as passed</span>
<span class="cm"> for the ContentItem */</span>
<span class="o">+</span> <span class="n">getStream</span><span
class="o">()</span> <span class="o">:</span> <span class="n">InputStream</span>
<span class="cm">/** Getter for the mime type of the content */</span>
@@ -93,7 +93,7 @@
<p>The <code>getStream()</code> and <code>getMimeType()</code> methods are
shortcuts for the according methods of the content item's blob object. Calling
<code>contentItem.getBlob.getStream()</code> will return an InputStream over
the exact same content as directly calling <code>getStream()</code> on the
content item. <em>Note that the blob interface also provides a
<code>getParameter()</code> method which allows to retrieve mime-type
parameters such as the charset of textual content.</em></p>
-<p>The content parsed by the user is stored as content part at the index '0'
with the URI of the content item in the form of a blob. Therefore, calling</p>
+<p>The content passed by the user is stored as content part at the index '0'
with the URI of the content item in the form of a blob. Therefore, calling</p>
<div class="codehilite"><pre><span class="n">contentItem</span><span
class="o">.</span><span class="na">getPart</span><span class="o">(</span><span
class="mi">0</span><span class="o">,</span><span class="n">Blob</span><span
class="o">.</span><span class="na">class</span><span class="o">)</span>
<span class="n">contentItem</span><span class="o">.</span><span
class="na">getPart</span><span class="o">(</span><span
class="n">contentItem</span><span class="o">.</span><span
class="na">getUri</span><span class="o">(),</span><span
class="n">Blob</span><span class="o">.</span><span class="na">class</span><span
class="o">)</span>
<span class="n">contentItem</span><span class="o">.</span><span
class="na">getBlob</span><span class="o">()</span>
@@ -159,7 +159,7 @@
<ul>
<li>If present this MUST BE the first MIME part within the
"multipart/form-data" container representing the ContentItem.</li>
<li>The "name" parameter of the "Content-Disposition" header MUST BE
"metadata"</li>
-<li>If the "fileName" parameter of the "Content-Disposition" header is present
it MUST BE the URI of the ContentItem. Users are typically required to set this
header in case they want to parse existing metadata with enhancement requests.
This is because is such cases it is important that the URI of the ContentItem
created by the Stanbol Enhancer is equal to the URI used to describe the
Content within the parsed Metadata. The Stanbol Enhancer MUST set to "fileName"
parameter of the metadata to the URI of the processed ContentItem.</li>
+<li>If the "fileName" parameter of the "Content-Disposition" header is present
it MUST BE the URI of the ContentItem. Users are typically required to set this
header in case they want to parse existing metadata with enhancement requests.
This is because is such cases it is important that the URI of the ContentItem
created by the Stanbol Enhancer is equal to the URI used to describe the
Content within the passed Metadata. The Stanbol Enhancer MUST set to "fileName"
parameter of the metadata to the URI of the processed ContentItem.</li>
<li>The "Content-Type" of the metadata can be any RDF serialization supported
by Apache Stanbol. UTF-8 is used as default charset.</li>
<li>The RDF data serialized in this MIME part represent the enhancement
results.</li>
</ul>
@@ -174,7 +174,7 @@
<li>the "name" parameter of the "Content-Disposition" is set to the URI of the
ContentPart in the ContentItem.</li>
<li>the "Content-Type" header must correspond to the media type of the
content</li>
</ul>
-<p>Note that users which want to send a single ContentPart AND Metadata to the
Stanbol Enhancer can also directly add the content to the "multipart/form-data"
container of the ContentItem. In this case the "name" parameter MUST BE still
set to "content" but the "Content-Type" header needs to be directly set to the
media type of the parsed ContentPart. The Stanbol Enhancer does NOT use this
option when serializing ContentItems. It will ALWAYS use a
"multipart/alternate" container for the "content" even when only a single
ContentPart is included in an Response.</p>
+<p>Note that users which want to send a single ContentPart AND Metadata to the
Stanbol Enhancer can also directly add the content to the "multipart/form-data"
container of the ContentItem. In this case the "name" parameter MUST BE still
set to "content" but the "Content-Type" header needs to be directly set to the
media type of the passed ContentPart. The Stanbol Enhancer does NOT use this
option when serializing ContentItems. It will ALWAYS use a
"multipart/alternate" container for the "content" even when only a single
ContentPart is included in an Response.</p>
<p><strong>Additional Metadata</strong></p>
<p>The <a href="#content_parts">ContentPart API</a> of the Stanbol ContentItem
allows to register content parts of any type. The MultiPart MIME serialization
of ContentItems supports the serialization of such additional parts as long as
they are encoded as RDF graphs (compatible to the Clerezza TripleCollection
class). Additional ContentParts which are not encoded as RDF data are currently
not supported by the Multipart MIME serialization.</p>
<ul>
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemfactory.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemfactory.html
(original)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemfactory.html
Wed Apr 11 08:50:43 2012
@@ -85,7 +85,7 @@
</pre></div>
-<p>The Blob interface is used by the Stanbol Enhancer to represent content.
Blobs are added to ContentItems as <a
href="contentitem.html#content_parts">content parts</a>. In addition to the
ContentSource and ContentReference interfaces that are also supported for the
creation of ContentItems for the creation of Blobs also a ContentSink can be
used. A ContentSink allows to obtain an OutputStream to an initially empty Blob
that can later be used to stream the content. This is intended to be used by
EnhancementEngine that need to convert content from one format to an other
because it allows to avoid caching the converted content in-memory.</p>
+<p>The Blob interface is used by the Stanbol Enhancer to represent content.
Blobs are added to ContentItems as <a
href="contentitem.html#content-parts">content parts</a>. In addition to the
ContentSource and ContentReference interfaces that are also supported for the
creation of ContentItems for the creation of Blobs also a ContentSink can be
used. A ContentSink allows to obtain an OutputStream to an initially empty Blob
that can later be used to stream the content. This is intended to be used by
EnhancementEngine that need to convert content from one format to an other
because it allows to avoid caching the converted content in-memory.</p>
<h3 id="contentitem-implementations">ContentItem implementations</h3>
<p>By default the Stanbol Enhancer provides two
ContentItemFactory/ContentItem/Blob implementations. Users can control the
implementation used by the Stanbol Enhancer by configuring the
"service.ranking" property of the different ContentItemFactory implementations
(e.g. via the configuration tab of the Apache Felix Web Console). The
implementation with the highest "service.ranking" will be used by the Stanbol
Enhancer to create ContentItems and Blobs. </p>
<h4 id="in-memory-contentitem">In-memory ContentItem</h4>
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 Apr 11 08:50:43 2012
@@ -46,7 +46,7 @@
<ul>
<li><a href="/stanbol/docs/trunk/downloads.html">Overview</a></li>
</ul>
-<h1 id="the_asf">The ASF</h1>
+<h1 id="the-asf">The ASF</h1>
<ul>
<li><a href="http://www.apache.org";>Apache Software Foundation</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li>
@@ -57,11 +57,11 @@
<div id="content">
<h1 class="title">Stanbol Enhancer</h1>
- <p>The Apache Stanbol Enhancer provides both a RESTful and a Java API that
allows a 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">Enhancement Chain</a>.</p>
-<h2 id="using_the_stanbol_enhancer">Using the Stanbol Enhancer</h2>
+ <p>The Apache Stanbol Enhancer provides both a RESTful and a Java API that
allows a caller to extract features from passed content. In more detail the
passed content is processed by <a href="engines">Enhancement Engines</a> as
defined by the called <a href="chains">Enhancement Chain</a>.</p>
+<h2 id="using-the-stanbol-enhancer">Using the Stanbol Enhancer</h2>
<p>The figure below provides an overview of the RESTful as well as the Java
API provided by the Stanbol Enhancer</p>
<p><img alt="Stanbol Enhancer Overview" src="enhanceroverview-s.png"
title="Overview of RESTful Services and Java API provided by the Stanbol
Enhancer" /></p>
-<h3 id="restful_service">RESTful service</h3>
+<h3 id="restful-service">RESTful service</h3>
<p>The content to be analyzed should be sent in a POST request with the
mime-type specified in the Content-type header. The response will hold the RDF
enhancement serialized in the format specified in the Accept header:</p>
<div class="codehilite"><pre>curl -X POST -H <span class="s2">"Accept:
text/turtle"</span> -H <span class="s2">"Content-type:
text/plain"</span> <span class="se">\</span>
--data <span class="s2">"The Stanbol enhancer can detect famous
cities such as \</span>
@@ -70,7 +70,7 @@
</pre></div>
-<p>The RESTful interface also provides parameters that can be used to
parse/request additional information. The following example shows a request
which answers with the plain/text version of the parsed HTML content.</p>
+<p>The RESTful interface also provides parameters that can be used to
parse/request additional information. The following example shows a request
which answers with the plain/text version extracted from the HTML content
passed in the request.</p>
<div class="codehilite"><pre>curl -v -X POST -H <span class="s2">"Accept:
text/plain"</span> <span class="se">\</span>
-H <span class="s2">"Content-type: text/html;
charset=UTF-8"</span> <span class="se">\</span>
--data <span class="s2">"<html><body><p>The Stanbol
enhancer can detect famous cities \</span>
@@ -80,7 +80,7 @@
<p>For detailed information please see the documentation of the <a
href="enhancerrest.html">Stanbol Enhancer RESTful Services</a>. A short version
is also provided under the REST API link of the Stanbol Web UI (e.g. <a
href="http://localhost:8080/enhancer";>http://localhost:8080/enhancer</a>
assuming that Apache Stanbol runs on localhost:8080).</p>
-<h3 id="java_api">Java API</h3>
+<h3 id="java-api">Java API</h3>
<p>The usage of the Java API requires the following OSGI Services</p>
<div class="codehilite"><pre><span class="nd">@Reference</span>
<span class="n">EnhancementJobManager</span> <span
class="n">jobManager</span><span class="o">;</span>
@@ -110,7 +110,7 @@
</pre></div>
-<p>After the enhancement process, ContentItems do not only contain the
metadata but also other informations such as converted versions of the parsed
content. The following code snippet shows how to retrieve the text version of
the parsed HTML content such as created by the <a
href="engines/metaxaengine.html">Metaxa Engine</a>.</p>
+<p>After the enhancement process, ContentItems do not only contain the
metadata but also other informations such as converted versions of the passed
content. The following code snippet shows how to retrieve the text version of
the passed HTML content such as created by the <a
href="engines/metaxaengine.html">Metaxa Engine</a>.</p>
<div class="codehilite"><pre><span class="n">Entry</span><span
class="o"><</span><span class="n">UriRef</span><span class="o">,</span><span
class="n">Blob</span><span class="o">></span> <span
class="n">textContentPart</span> <span class="o">=</span>
<span class="n">ContentItemHelper</span><span class="o">.</span><span
class="na">getBlob</span><span class="o">(</span><span
class="n">contentItem</span><span class="o">,</span>
<span class="n">Collections</span><span class="o">.</span><span
class="na">singleton</span><span class="o">(</span><span
class="s">"text/plain"</span><span class="o">));</span>
@@ -122,19 +122,19 @@
</pre></div>
-<h2 id="list_of_available_enhancement_engines">List of Available Enhancement
Engines</h2>
+<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 enhancement
engines implementations</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>
+<h2 id="main-interfaces-and-utilities">Main Interfaces and Utilities</h2>
<ul>
-<li><strong>ContentItem</strong>: A <a href="contentitem.html">content
item</a> is the unit of content the 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>ContentItem</strong>: A <a href="contentitem.html">content
item</a> is the unit of content the 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). ContentItems are created by
using the <a href="contentitemfactory.html">ContentItemFactory</a>.</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>: An <a href="chains">enhancement
chain</a> represents a user provided configuration which describes how <a
href="contentitem.html">content items</a> parsed to this chain should be
processed by the Stanbol Enhancer. The chain defines a list of <a
href="engines/list.html">available enhancement engines</a> and their order of
execution.</li>
+<li><strong>EnhancementChain</strong>: An <a href="chains">enhancement
chain</a> represents a user provided configuration which describes how <a
href="contentitem.html">content items</a> passed to this chain should be
processed by the Stanbol Enhancer. The chain defines a list of <a
href="engines/list.html">available enhancement engines</a> and their order of
execution.</li>
<li><strong>EnhancementJobManager</strong>: The <a
href="enhancementjobmanager.html">enhancement job manager</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">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><em>Note that the "org.apache.stanbol.enhancer.servicesapi" module also
provides 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.</em></p>
-<h2 id="enhancement_structure">Enhancement Structure</h2>
+<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: 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.</em></p>
<p>Each enhancement type description which contains the following important
properties:</p>
