svn commit: r804885 - in /websites/staging/stanbol/trunk: ./ content/stanbol/docs/trunk/enhancer/ content/stanbol/docs/trunk/enhancer/chains/

[bu...@apache.org]

Author: buildbot
Date: Wed Feb 15 07:29:25 2012
New Revision: 804885

Log:
Staging update by buildbot for stanbol

Added:
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.png   (with props)
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemmultipartmime.png   (with props)
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.png   (with props)
Modified:
    websites/staging/stanbol/trunk/   (props changed)
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.html
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitem.html
    websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.html

Propchange: websites/staging/stanbol/trunk/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Wed Feb 15 07:29:25 2012
@@ -1 +1 @@
-1244383
+1244385

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 Wed Feb 15 07:29:25 2012
@@ -60,6 +60,7 @@
     <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>
+<p><img alt="Execution Plan" src="executionplan.png" title="Overview of the Execution Plan Ontology" /></p>
 <ul>
 <li>Namespace: ep : http://stanbol.apache.org/ontology/enhancer/executionplan#</li>
 <li><strong>ep:ExecutionPlan</strong> : Represent an execution plan defined by all linked execution nodes.<ul>

Added: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.png
==============================================================================
Binary file - no diff available.

Propchange: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

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 Feb 15 07:29:25 2012
@@ -130,6 +130,45 @@
 
 
 <p>While accessing content items within an <a href="engines/enhancementengine.html">enhancement engine</a> there is an exception to this rule. If an engine declares that is only supports the <code>SYNCHRONOUS</code> enhancement mode the <a href="enhancementjobmanager.html">enhancement job manager</a> needs to take care the an engine has exclusive access to the content item. In that case implementors of enhancement engines need not to care about using read/write locks.</p>
+<h2 id="multipart_mime_serialization">Multipart MIME serialization</h2>
+<p>Stanbol supports the serialization of ContentItems as Multipart MIME. This serialization is used by the RESTful API of the Stanbol Enhancer. This section provides details about how ContentItems are represented using Multipart MIME. For more information on how to send/receive multipart content items via the RESTful Serivces provided by the Stanbol Enhancer please see the documentation provided in the Web Interface (e.g. http://localhost:8080/enhancer).</p>
+<p>The following figure provides an overview on how ContentItems are represented using MultiPart MIME.</p>
+<p><img alt="ConentItem Multipart MIME format" src="contentitemmultipartmime.png" title="This figure provides an overview on how ContentItems are serialize as MultiPart MIME" /></p>
+<p>Serialization Rules:</p>
+<ul>
+<li>ContentItems are con tainted within an "multipart/from-data" container</li>
+<li>Apache Stanbol uses "contentItem" as "boundary", but users may use any as long as the "boundary" parameter in the "Content-Type" header is set correctly.</li>
+<li>Stanbol uses UTF-8 as charset, but users might use any supported encoding as long as the "charset" parameter in the "Content-Type" header is set accordingly.</li>
+</ul>
+<p>The default Content-Type for serialized ContentItems is therefore "multipart/form-data; boundary=contentItem; charset=UTF-8"</p>
+<h3 id="metadata">Metadata:</h3>
+<ul>
+<li>If present this MUST BE the first MIME part within the "multipart/from-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 the 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 equals 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>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>
+<h3 id="content">Content</h3>
+<ul>
+<li>If present the MIME part representing the Content MUST directly follow the Metadata. If the Metadata are not present the Content MUST BE the first MIME part within the "multipart/from-data" container representing the ContentItem.</li>
+<li>Because multiple Content variants can be included within a ContentItem a "multipart/alternate" container is used to represent the content.</li>
+<li>The "name" parameter of the "Content-Disposition" header MUST BE "content". The "fileName" parameter is not used and therefore not present/ignored. The Stanbol Enhancer uses "contentParts" as boundary but users may use any boundary as long as it is correctly set within the "Content-Type" header.</li>
+</ul>
+<p>The different content elements are contained within the "multipart/from-data" container. The ordering is important. For serialized ContentItems it is assumed that the first element is the original document for the ConentItem. All further MIME parts are considered alternate - e.g. transcoded/transformed - versions. For serialized ContentItems provided as Response to requests to the Stanbol Enhancer the ordering of the MIME parts is the same as the indexes of the ContentParts in the ContentItem.</p>
+<ul>
+<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 that want to send a single ContentPart AND Metadata to the Stanbol Enhancer can also directly add the content to the "multipart/from-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 ContnetPart is included in an Response.</p>
+<h3 id="additional_metadata">Additional Metadata</h3>
+<p>The <a href="#contentparts">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 that are not encoded as RDF data are currently not supported by the Multipart MIME serialization.</p>
+<ul>
+<li>MimeParts representing such ContentParts MUST BE added after the MIME parts for the "metadata" AND the "content"</li>
+<li>The "name" parameter of the "Content-Disposition" MUST BE 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. The Stanbol Enhancer will always use the same RDF serialization as for the "metadata" when serializing additional Metadata. Users are free to use any supported serialization as long as they set the "Content-Type" header accordingly.</li>
+<li>The ordering of parts representing additional Metadata is the same as the ordering (index) of the ContentParts in the ContentItem.</li>
+</ul>
   </div>
   
   <div id="footer">

Added: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemmultipartmime.png
==============================================================================
Binary file - no diff available.

Propchange: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/contentitemmultipartmime.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

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 Wed Feb 15 07:29:25 2012
@@ -65,6 +65,7 @@
 </ul>
 <h2 id="exection_metadata_ontology">Exection Metadata Ontology</h2>
 <p>The RDFS schema used for the execution plan is defined as follows.</p>
+<p><img alt="Execution Metadata" src="executionmetadata.png" title="Overview of the Execution Metadata Ontology" /></p>
 <ul>
 <li>Namespace: em : http://stanbol.apache.org/ontology/enhancer/executionMetadata#</li>
 <li><strong>em:Execution</strong> : Super class for all Executions<ul>

Added: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.png
==============================================================================
Binary file - no diff available.

Propchange: websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream