Author: buildbot
Date: Tue Jan 31 08:04:26 2012
New Revision: 803628
Log:
Staging update by buildbot for stanbol
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.html
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
Tue Jan 31 08:04:26 2012
@@ -57,7 +57,7 @@
<div id="content">
<h1 class="title">Execution Metadata</h1>
- <p>The execution metadata provide detailed information about an
ongoing/completed enhancement process. Basically they describe how the <a
href="chains/executionplan.html">ExecutionPlan</a> provided by the <a
href="chains.enhancementchain.html">Chain</a> was executed by the <a
href="enhancementjobmanager.html">EnhancementJobManager</a>. Both the
ExecutionMetadata and the ExecutionPlan are provided with the ContentItem as an
own content part of the type MGraph with the URI
"http://stanbol.apache.org/ontology/enhancer/executionMetadata#ChainExecution";.
For users of the Stanbol Enhacer the Execution Metadata are of interest to:</p>
+ <p>The execution metadata provide detailed information about an
ongoing/completed enhancement process. Basically they describe how the <a
href="chains/executionplan.html">ExecutionPlan</a> provided by the <a
href="chains/enhancementchain.html">Chain</a> was executed by the <a
href="enhancementjobmanager.html">EnhancementJobManager</a>. Both the
ExecutionMetadata and the ExecutionPlan are provided with the ContentItem as an
own content part of the type MGraph with the URI
"http://stanbol.apache.org/ontology/enhancer/executionMetadata#ChainExecution";.
For users of the Stanbol Enhacer the Execution Metadata are of interest to:</p>
<ul>
<li>check progress of asynchronously started Enhancement Processes: Metadata
for all planed executions of engines are created as soon as an ContentItem is
parsed to the EnhancementJobManager and are updated as soon as the execution of
engines start/complete/fail.</li>
<li>Monitor the performance of different EnhancementEngines: The Execution
Metadata provide detailed information about starting/completion time points for
engine executions.</li>
@@ -276,36 +276,38 @@
<ul>
<li>ExecutionPlanHelper: Utility class that provides methods for reading and
creating <a href="chains/executionplan.html">ExecutionPlan</a>.</li>
<li>ExecutionMetadataHelper: Utility class for reading and manipulating the
ExecutionMetadata</li>
-<li>
-<p>EnhancementEngineHelper: Utility that contains general purpose RDF
utilities.</p>
-<p>ContentItem ci; //the ContentItem
-MGraph em; //the ExecutionMetadata</p>
-<p>//get the ChainExecution, ExecutionPlan and the name of the Chain
-NonLiteral ce = getChainExecution(em,ci.getUri());
-if(ce != null){
- NonLiteral ep = getExecutionPlan(em,ce);
- String chainName = getString(em,ep,ExecutionPlan.CHAIN);
-} else {
- log.warn("ExecutionMetadata of not contain information for "
- + "ContentItem {}!",ci.getUri());
-}</p>
-<p>//get the EngineExecutions and the name of the Engines
-Set<NonLiteral> executions = getExecutions(em,ce);
-for(NonLiteral ex : executions){
- NonLiteral en = getExecutionNode(em,ex);
- if(en != null){
- String engineName = getEngine(em,en);
- boolean optional = isOptional(em,en);
- } else { //maybe a sub-chain execution
- //currently not supported, but might
- //added in future versions
- }
- UriRef status = getStatus(em,ex);
- Date started = getStarted(em,ex);
- Date completed = getCompleted(em,ex);
-}</p>
-</li>
+<li>EnhancementEngineHelper: Utility that contains general purpose RDF
utilities.</li>
</ul>
+<p>This code example first gets the ChainExecution, ExecutionPlan and Chain
name for the enhanced content item. In a second step metadata of all executed
EnhancementEngines are retrieved.</p>
+<div class="codehilite"><pre><span class="n">ContentItem</span> <span
class="n">ci</span><span class="p">;</span> <span class="sr">//</span><span
class="n">the</span> <span class="n">ContentItem</span>
+<span class="n">MGraph</span> <span class="n">em</span><span
class="p">;</span> <span class="sr">//</span><span class="n">the</span> <span
class="n">ExecutionMetadata</span>
+
+<span class="sr">//g</span><span class="n">et</span> <span
class="n">the</span> <span class="n">ChainExecution</span><span
class="p">,</span> <span class="n">ExecutionPlan</span> <span
class="ow">and</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="n">NonLiteral</span> <span class="n">ce</span> <span
class="o">=</span> <span class="n">getChainExecution</span><span
class="p">(</span><span class="n">em</span><span class="p">,</span><span
class="n">ci</span><span class="o">.</span><span class="n">getUri</span><span
class="p">());</span>
+<span class="k">if</span><span class="p">(</span><span class="n">ce</span>
<span class="o">!=</span> <span class="n">null</span><span class="p">){</span>
+ <span class="n">NonLiteral</span> <span class="n">ep</span> <span
class="o">=</span> <span class="n">getExecutionPlan</span><span
class="p">(</span><span class="n">em</span><span class="p">,</span><span
class="n">ce</span><span class="p">);</span>
+ <span class="n">String</span> <span class="n">chainName</span> <span
class="o">=</span> <span class="n">getString</span><span
class="p">(</span><span class="n">em</span><span class="p">,</span><span
class="n">ep</span><span class="p">,</span><span
class="n">ExecutionPlan</span><span class="o">.</span><span
class="n">CHAIN</span><span class="p">);</span>
+<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+ <span class="nb">log</span><span class="o">.</span><span
class="nb">warn</span><span class="p">(</span><span
class="s">"ExecutionMetadata of not contain information for "</span>
+ <span class="o">+</span> <span class="s">"ContentItem
{}!"</span><span class="p">,</span><span class="n">ci</span><span
class="o">.</span><span class="n">getUri</span><span class="p">());</span>
+<span class="p">}</span>
+
+<span class="sr">//g</span><span class="n">et</span> <span
class="n">the</span> <span class="n">EngineExecutions</span> <span
class="ow">and</span> <span class="n">the</span> <span class="n">name</span>
<span class="n">of</span> <span class="n">the</span> <span
class="n">Engines</span>
+<span class="n">Set</span><span class="sr"><NonLiteral></span> <span
class="n">executions</span> <span class="o">=</span> <span
class="n">getExecutions</span><span class="p">(</span><span
class="n">em</span><span class="p">,</span><span class="n">ce</span><span
class="p">);</span>
+<span class="k">for</span><span class="p">(</span><span
class="n">NonLiteral</span> <span class="n">ex</span> <span class="p">:</span>
<span class="n">executions</span><span class="p">){</span>
+ <span class="n">NonLiteral</span> <span class="n">en</span> <span
class="o">=</span> <span class="n">getExecutionNode</span><span
class="p">(</span><span class="n">em</span><span class="p">,</span><span
class="n">ex</span><span class="p">);</span>
+ <span class="k">if</span><span class="p">(</span><span class="n">en</span>
<span class="o">!=</span> <span class="n">null</span><span class="p">){</span>
+ <span class="n">String</span> <span class="n">engineName</span> <span
class="o">=</span> <span class="n">getEngine</span><span
class="p">(</span><span class="n">em</span><span class="p">,</span><span
class="n">en</span><span class="p">);</span>
+ <span class="n">boolean</span> <span class="n">optional</span> <span
class="o">=</span> <span class="n">isOptional</span><span
class="p">(</span><span class="n">em</span><span class="p">,</span><span
class="n">en</span><span class="p">);</span>
+ <span class="p">}</span> <span class="k">else</span> <span
class="p">{</span> <span class="sr">//m</span><span class="n">aybe</span> <span
class="n">a</span> <span class="n">sub</span><span class="o">-</span><span
class="n">chain</span> <span class="n">execution</span>
+ <span class="sr">//c</span><span class="n">urrently</span> <span
class="ow">not</span> <span class="n">supported</span><span class="p">,</span>
<span class="n">but</span> <span class="n">might</span>
+ <span class="sr">//</span><span class="n">added</span> <span
class="n">in</span> <span class="n">future</span> <span
class="n">versions</span>
+ <span class="p">}</span>
+ <span class="n">UriRef</span> <span class="n">status</span> <span
class="o">=</span> <span class="n">getStatus</span><span
class="p">(</span><span class="n">em</span><span class="p">,</span><span
class="n">ex</span><span class="p">);</span>
+ <span class="n">Date</span> <span class="n">started</span> <span
class="o">=</span> <span class="n">getStarted</span><span
class="p">(</span><span class="n">em</span><span class="p">,</span><span
class="n">ex</span><span class="p">);</span>
+ <span class="n">Date</span> <span class="n">completed</span> <span
class="o">=</span> <span class="n">getCompleted</span><span
class="p">(</span><span class="n">em</span><span class="p">,</span><span
class="n">ex</span><span class="p">);</span>
+<span class="p">}</span>
+</pre></div>
</div>
<div id="footer">
