Author: buildbot
Date: Tue Jan 24 14:08:09 2012
New Revision: 803189
Log:
Staging update by buildbot for stanbol
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/defaultchain.html
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-defaultchain-config.png
(with props)
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-config.png
(with props)
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.html
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/STANBOL-414-specification.html
Modified:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/STANBOL-414-specification.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/STANBOL-414-specification.html
(original)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/STANBOL-414-specification.html
Tue Jan 24 14:08:09 2012
@@ -193,8 +193,15 @@ enhancement engines.</p>
<p>NOTE: We could also provide the possibility that the execution graph is
parsed as an additional parameter to a specific request to the enhancer.</p>
<h3 id="defaultchain">DefaultChain</h3>
<p>Implementation that keeps track of all currently active EnhancementEngine
and registers itself as a Chain service with the
"stanbol.enhancer.chain.name=default" an service ranking of
Integer.MIN_VALUE.</p>
-<p>This will provide a Chain returned by ChainManager.getDefault() that will
result in the same enhancement process as Stanbol used before the addition of
Chains.</p>
-<p>Note that users can change the default chain by either stopping this
component of adding an other Chain with "stanbol.enhancer.chain.name=default"
and an higher service ranking. </p>
+<p>This will cause this chain to be returned by the ChainManager.getDefault()
method if users:</p>
+<ul>
+<li>do not deactivate this Chain (see below)</li>
+<li>configure an other Chain with the "stanbol.enhancer.chain.name=default"
and an higher service ranking</li>
+</ul>
+<p>This chain can be enabled/disabled by using the
"stanbol.enhancer.chain.default.enabled"</p>
+<p><img alt="DefaultChain Configuration"
src="enhancer-defaultchain-config.png" title="Configuration Options for the
Default Chain" /></p>
+<p>Note that the DefaultChain does not actually implement the Chain interface,
but only registers an instance of the AllActiveEnginesChain on activation.
+The implementation is part of the
"org.apache.stanbol.enhancer.chain.allactive" module.</p>
<h3 id="singleenginechain">SingleEngineChain</h3>
<p>This is basically an Adapter that allows to execute a single
EnhancementEngine within a Chain. This types of Chains will not be registered
as OSGI service. Instances will be created on request for single
EnhancementEngines and directly parsed to the EnhancementJobManager
implementation.</p>
<p>Note that pre-existing metadata might still be parsed within a multipart
content item as defined by STANBOL-414.</p>
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/defaultchain.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/defaultchain.html
(added)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/defaultchain.html
Tue Jan 24 14:08:09 2012
@@ -0,0 +1,95 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - DefaultChain</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png"
href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220"
height="101" border="0"
src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL";>Issue
Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="http://dev.iks-project.eu/downloads/stanbol-launchers/";>Pre-built
Launchers</a></li>
+</ul>
+<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>
+<li><a href="http://www.apache.org/foundation/sponsorship.html";>Become a
Sponsor</a></li>
+<li><a href="http://www.apache.org/security/";>Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">DefaultChain</h1>
+ <p>Implementation that keeps track of all currently active
EnhancementEngine and registers itself as a Chain service with the
"stanbol.enhancer.chain.name=default" an service ranking of
Integer.MIN_VALUE.</p>
+<p>This will cause this chain to be returned by the ChainManager.getDefault()
method if users:</p>
+<ul>
+<li>do not deactivate this Chain (see below)</li>
+<li>configure an other Chain with the "stanbol.enhancer.chain.name=default"
and an higher service ranking</li>
+</ul>
+<p>The Chain returned by ChainManager.getDefault() is the one used for
requests that do not specify a chain. This are enhancement requests to the
"/engines" and "/enhancer" endpoint.</p>
+<h3 id="configuration">Configuration</h3>
+<p>This chain can be enabled/disabled by using the
"stanbol.enhancer.chain.default.enabled"</p>
+<p><img alt="DefaultChain Configuration"
src="enhancer-defaultchain-config.png" title="Configuration Options for the
Default Chain" /></p>
+<p>This chain does not support the configuration of the name nor the service
ranking. The name is fixed to "default" and the service ranking is
Integer.MIN_VALUE</p>
+<p>Note that the DefaultChain does not actually implement the Chain interface,
but only registers an instance of the AllActiveEnginesChain on activation.
+The implementation is part of the
"org.apache.stanbol.enhancer.chain.allactive" module.</p>
+<h3 id="calculation_of_the_executionplan">Calculation of the ExecutionPlan</h3>
+<p>This chain considers all currently active EnhancementEngines. The
ExecutionPlan is calculated by using the value for the
"org.apache.stanbol.enhancer.engine.order" property provided by the
EnhancementEngine:</p>
+<ul>
+<li>Engines with a lower order are executed before Engines with a higher
value</li>
+<li>Engines with the same order may be executed simultaneously if the
EnhancementJobMananger and the EnhancementEngine do support this feature.</li>
+</ul>
+<p>The DefaultChain ensures therefore that the default behavior of the Stanbol
Enhancer does not change after the introduction of EnhancementChains. This is
because the WeightedJobManager as used previously followed exactly the same
rules.</p>
+<p>However after the introduction of EnhancementChains users can now easily
change the default behavior.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache
License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are
trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-defaultchain-config.png
==============================================================================
Binary file - no diff available.
Propchange:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-defaultchain-config.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-config.png
==============================================================================
Binary file - no diff available.
Propchange:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancer-weightedchain-config.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added:
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.html
==============================================================================
---
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.html
(added)
+++
websites/staging/stanbol/trunk/content/stanbol/docs/trunk/enhancer/chains/weightedchain.html
Tue Jan 24 14:08:09 2012
@@ -0,0 +1,94 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/stanbol/css/stanbol.css" rel="stylesheet" type="text/css">
+ <title>Apache Stanbol - WeightedChain</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png"
href="/stanbol/images/stanbol-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <a href="/stanbol/index.html"><img alt="Apache Stanbol" width="220"
height="101" border="0"
src="/stanbol/images/stanbol-logo/stanbol-2010-12-14.png"/></a>
+ <h1 id="stanbol">Stanbol</h1>
+<ul>
+<li><a href="/stanbol/index.html">Home</a></li>
+<li><a href="/stanbol/docs/trunk/tutorial.html">Tutorial</a></li>
+<li><a href="/stanbol/docs/trunk/">Documentation</a></li>
+<li><a href="/stanbol/docs/trunk/building.html">Building</a></li>
+</ul>
+<h1 id="project">Project</h1>
+<ul>
+<li><a href="/stanbol/docs/trunk/mailinglists.html">Mailing Lists</a></li>
+<li><a href="https://issues.apache.org/jira/browse/STANBOL";>Issue
Tracker</a></li>
+<li><a href="/stanbol/team.html">Project Team</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0";>License</a></li>
+</ul>
+<h1 id="downloads">Downloads</h1>
+<ul>
+<li><a href="http://dev.iks-project.eu/downloads/stanbol-launchers/";>Pre-built
Launchers</a></li>
+</ul>
+<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>
+<li><a href="http://www.apache.org/foundation/sponsorship.html";>Become a
Sponsor</a></li>
+<li><a href="http://www.apache.org/security/";>Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">WeightedChain</h1>
+ <p>The Wighted Chain takes a list of Enhancement Engine names as input and
uses the "org.apache.stanbol.enhancer.engine.order" metadata of the configured
Engines to calculate the ExecutionPlan.</p>
+<p>This Chain is designed for easy configuration - just a list of the engine
names - but has limited possibilities to control the execution order.</p>
+<h3 id="configuration">Configuration</h3>
+<p>The property "stanbol.enhancer.chain.weighted.chain" is used to provide the
list of engine names. Both Arrays and Collections are supported as values.</p>
+<p>In addition it is possible to define Engines as optional. This allows to
specify that the enhancement process should not fail if an Engine is not active
or fails while processing a content item.</p>
+<p>The syntax to define an Engine as optional is as follows</p>
+<div class="codehilite"><pre><span class="sr"><name></span><span
class="p">;</span><span class="n">optional</span>
+<span class="sr"><name></span><span class="p">;</span><span
class="n">optional</span><span class="o">=</span><span class="n">true</span>
+</pre></div>
+
+
+<p>both variants result that the execution of the engine with the name <name>
is optional.</p>
+<p><img alt="Configuration Dialog for the WeightedCahin"
src="enhancer-weightedchain-config.png" title="Sceenshot of the Configuration
Dialog for a WeightedChain with two required and one optional Engine" /></p>
+<h3 id="calculation_of_the_executionplan">Calculation of the ExecutionPlan</h3>
+<p>It is important to note that the ordering of the list has no influence on
the ExecutionPlan because the order of execution of the configured
EnhancementEngines is calculated only by using the value for the
"org.apache.stanbol.enhancer.engine.order" property provided by the
EnhancementEngine:</p>
+<ul>
+<li>Engines with a lower order are executed before Engines with a higher
value</li>
+<li>Engines with the same order may be executed simultaneously if the
EnhancementJobMananger and the EnhancementEngine do support this feature.</li>
+</ul>
+<p>The WeightedCahin follows exactly the same algorithm as the
WeightedJobManager used to decide the execution order of all active
EnhancementEngines. However the WeightedChain will only consider configured
chains and ignore others.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache
License, Version 2.0</a>.
+ <br />
+ Apache, Stanbol and the Apache feather and Stanbol logos are
trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
