Author: buildbot
Date: Wed Feb 15 19:07:09 2012
New Revision: 804944
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 19:07:09 2012
@@ -1 +1 @@
-1244590
+1244647
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 19:07:09 2012
@@ -79,33 +79,52 @@
<p>For detailed information please see the documentation provided by 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>
<p>The usage of the Java API requires the following OSGI Services</p>
-<div class="codehilite"><pre><span class="nv">@Reference</span>
-<span class="n">EnhancementJobManager</span> <span class="n">jobManager</span>
-<span class="nv">@Reference</span>
-<span class="n">EnhancementChainManager</span>
+<table class="codehilitetable"><tr><td class="linenos"><div
class="linenodiv"><pre>1
+2
+3
+4</pre></div></td><td class="code"><div class="codehilite"><pre><span
class="nd">@Reference</span>
+<span class="n">EnhancementJobManager</span> <span
class="n">jobManager</span><span class="o">;</span>
+<span class="nd">@Reference</span>
+<span class="n">ChainManager</span> <span class="n">chainManager</span><span
class="o">;</span>
</pre></div>
-
+</td></tr></table>
<p>This code snipped shows how to enhance a HTML document</p>
-<div class="codehilite"><pre><span class="n">InputStream</span> <span
class="n">content</span><span class="p">;</span> <span
class="sr">//</span><span class="n">the</span> <span class="n">content</span>
<span class="p">(</span><span class="n">assuming</span> <span
class="n">an</span> <span class="n">HTML</span> <span
class="n">document</span><span class="p">)</span>
-<span class="n">String</span> <span class="n">chainName</span><span
class="p">;</span> <span class="sr">//</span><span class="n">the</span> <span
class="n">name</span> <span class="n">of</span> <span class="n">the</span>
<span class="n">chain</span> <span class="ow">or</span> <span
class="n">null</span> <span class="n">to</span> <span class="k">use</span>
<span class="n">the</span> <span class="n">default</span>
-<span class="n">ContentItem</span> <span class="n">contentItem</span> <span
class="o">=</span> <span class="k">new</span> <span
class="n">InMemoryContentItem</span><span class="p">(</span>
- <span class="n">IOUtils</span><span class="o">.</span><span
class="n">toByteArray</span><span class="p">(</span><span
class="n">content</span><span class="p">),</span> <span
class="s">"text/html; charset=UTF-8"</span><span class="p">);</span>
-<span class="sr">//g</span><span class="n">et</span> <span
class="n">the</span> <span class="n">EnhancementChain</span>
-<span class="n">Chain</span> <span class="n">enhancementChain</span><span
class="p">;</span>
-<span class="k">if</span><span class="p">(</span><span
class="n">chainName</span> <span class="o">==</span> <span
class="n">null</span><span class="p">){</span>
- <span class="n">enhancementChain</span> <span class="o">=</span> <span
class="n">chainManager</span><span class="o">.</span><span
class="n">getDefault</span><span class="p">();</span>
-<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
- <span class="n">enhancementChain</span> <span class="o">=</span> <span
class="n">chainManager</span><span class="o">.</span><span
class="n">getChain</span><span class="p">(</span><span
class="n">chainName</span><span class="p">);</span>
-<span class="p">}</span>
-<span class="n">try</span> <span class="p">{</span> <span
class="sr">//</span><span class="n">enhance</span> <span class="n">the</span>
<span class="n">content</span>
- <span class="n">jobManager</span><span class="o">.</span><span
class="n">enhanceContent</span><span class="p">(</span><span
class="n">contentItem</span><span class="p">,</span> <span
class="n">enhancementChain</span><span class="p">);</span>
-<span class="p">}</span> <span class="n">catch</span> <span
class="p">(</span><span class="n">EnhancementException</span> <span
class="n">e</span><span class="p">)</span> <span class="p">{}</span>
+<table class="codehilitetable"><tr><td class="linenos"><div
class="linenodiv"><pre> 1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+13
+14
+15
+16
+17</pre></div></td><td class="code"><div class="codehilite"><pre><span
class="n">InputStream</span> <span class="n">content</span><span
class="o">;</span> <span class="c1">//the content (assuming an HTML
document)</span>
+<span class="n">String</span> <span class="n">chainName</span><span
class="o">;</span> <span class="c1">//the name of the chain or null to use the
default</span>
+<span class="n">ContentItem</span> <span class="n">contentItem</span> <span
class="o">=</span> <span class="k">new</span> <span
class="n">InMemoryContentItem</span><span class="o">(</span>
+ <span class="n">IOUtils</span><span class="o">.</span><span
class="na">toByteArray</span><span class="o">(</span><span
class="n">content</span><span class="o">),</span> <span
class="s">"text/html; charset=UTF-8"</span><span class="o">);</span>
+<span class="c1">//get the EnhancementChain</span>
+<span class="n">Chain</span> <span class="n">enhancementChain</span><span
class="o">;</span>
+<span class="k">if</span><span class="o">(</span><span
class="n">chainName</span> <span class="o">==</span> <span
class="kc">null</span><span class="o">){</span>
+ <span class="n">enhancementChain</span> <span class="o">=</span> <span
class="n">chainManager</span><span class="o">.</span><span
class="na">getDefault</span><span class="o">();</span>
+<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
+ <span class="n">enhancementChain</span> <span class="o">=</span> <span
class="n">chainManager</span><span class="o">.</span><span
class="na">getChain</span><span class="o">(</span><span
class="n">chainName</span><span class="o">);</span>
+<span class="o">}</span>
+<span class="k">try</span> <span class="o">{</span> <span class="c1">//enhance
the content</span>
+ <span class="n">jobManager</span><span class="o">.</span><span
class="na">enhanceContent</span><span class="o">(</span><span
class="n">contentItem</span><span class="o">,</span> <span
class="n">enhancementChain</span><span class="o">);</span>
+<span class="o">}</span> <span class="k">catch</span> <span
class="o">(</span><span class="n">EnhancementException</span> <span
class="n">e</span><span class="o">)</span> <span class="o">{}</span>
-<span class="sr">//</span><span class="n">Get</span> <span
class="n">the</span> <span class="n">enhancement</span> <span
class="n">Results</span>
-<span class="n">MGraph</span> <span class="n">enhancements</span> <span
class="o">=</span> <span class="n">contentItem</span><span
class="o">.</span><span class="n">getMetadata</span><span class="p">();</span>
+<span class="c1">//Get the enhancement Results</span>
+<span class="n">MGraph</span> <span class="n">enhancements</span> <span
class="o">=</span> <span class="n">contentItem</span><span
class="o">.</span><span class="na">getMetadata</span><span class="o">();</span>
</pre></div>
-
+</td></tr></table>
<p>After the enhancement process finishes ContentIems 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>
<div class="codehilite"><pre><span class="n">Entry</span><span
class="sr"><UriRef,Blob></span> <span class="n">textContentPart</span>
<span class="o">=</span>
