Author: buildbot
Date: Fri May 23 08:54:57 2014
New Revision: 909697
Log:
Staging update by buildbot for stanbol
Modified:
websites/staging/stanbol/trunk/content/ (props changed)
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/engines/dereference.html
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/engines/entityhubdereference.html
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/enhancementproperties.html
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/nlp/index.html
Propchange: websites/staging/stanbol/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri May 23 08:54:57 2014
@@ -1 +1 @@
-1597026
+1597033
Modified:
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/engines/dereference.html
==============================================================================
---
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/engines/dereference.html
(original)
+++
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/engines/dereference.html
Fri May 23 08:54:57 2014
@@ -89,7 +89,8 @@
<ul> <li><a href="/">Home</a></li> <li class="item"><a
href="/docs/">Docs</a></li> <li class="item"><a
href="/docs/trunk/">Trunk</a></li> <li class="item"><a
href="/docs/trunk/components/">Components</a></li> <li class="item"><a
href="/docs/trunk/components/enhancer/">Enhancer</a></li> <li class="item"><a
href="/docs/trunk/components/enhancer/engines/">Engines</a></li> </ul>
</div>
<h1 class="title">Entity Dereference Engine</h1>
- <p>The responsibility of the Dereference Engine is to retrieve information
about Entities
+ <p><strong>since version <code>0.12.0</code></strong> with <a
href="https://issues.apache.org/jira/browse/STANBOL-1222";>STANBOL-1222</a></p>
+<p>The responsibility of the Dereference Engine is to retrieve information
about Entities
referenced by the Enhancement Results and add them to the metadata of the <a
href="../contentitem">Content Item</a>.</p>
<h2 id="consumed-information">Consumed information</h2>
<p>The Entity Dereference Engine consumes the RDF enhancements generated by
other Enhancement Engines. Especially the <code>fise:entity-reference</code>
properties used by <code>fise:EntityAnnotation</code> and
<code>fise:TopicAnnotation</code> are processed by this engine as they do link
to the Entities that need to be dereferenced.</p>
@@ -156,10 +157,12 @@ referenced by the Enhancement Results an
<p>The <code>dereference(..)</code> method is used to dereference the Entity
with the parsed <code>UriRef</code>. Dereferenced information are expected to
be written in the parsed <code>MGraph</code>. While writing dereferenced
information to the parsed graph a write lock MUST BE acquired. The
<code>DereferenceContext</code> provides the configuration (see the following
section for more information). If the parsed entity was successfully
dereferenced this method is expected to return <code>true</code>. Otherwise
<code>false</code>.</p>
<h3 id="configuration-api">Configuration API</h3>
<p>Configuration Parameters supported by the Core Entity Dereference Engine
implementation are defined in the <code>DereferenceConstants</code> class. </p>
+<h4 id="dereferenceengineconfig">DereferenceEngineConfig</h4>
<p>The <code>DereferenceEngineConfig</code> class provides an easy - API based
- access to those configuration parameters. It is instantiated by using the
<code>Dictionary</code> parsed by the OSGI as part of the
<code>ComponentContext</code>.</p>
-<p>Finally the <code>DereferenceContext</code> is used to parse both the
<code>DereferenceEngineConfig</code> and the request specific configuration
(including <em>Offline Mode</em> state and <a
href="../enhancementproperties">Enhancement Properties</a>) to calls to the
<code>EntityDereferencer</code>.</p>
-<p>Specific EntityDereferencer implementation can use their own custom
<code>DereferenceContext</code> implementations. Typically they want to do that
as this allows to avoid parsing request specific configurations multiple times.
For this it is important to understand that one call to the
<code>EntityDereferenceEngine</code> will result in multiple calls to the
<code>EntityDereferencer</code> - one call for each scheduled Entity. The same
<code>DereferenceContext</code> instance will be used for each of those calls.
<code>DereferenceContext</code> instances are created by using the
<code>DereferenceContextFactory</code> parsed when constructing the
<code>DereferenceEngine</code>. So a custom <code>DereferenceContext</code>
implementation allows to ensure that request specific configurations are only
parsed once per request and not for each dereferenced entity.</p>
-<p>The following listing shows how to instantiate a
<code>EntityDereferenceEngine</code> with a custom
<code>DereferenceContext</code>.</p>
+<h4 id="dereferencecontext">DereferenceContext</h4>
+<p>The <code>DereferenceContext</code> is used to parse request specific
context to the <code>EntityDereferencer</code> implementation.</p>
+<p>For that it is important to note that a single request to the Entity
Dereference Engine can schedule multiple Entities to be dereferenced and
therefore result in multiple call to the
<code>EntityDereferencer#dereference(..)</code> method. All such calls will
use the same <code>DereferenceContext</code> instance.</p>
+<p>Extending the <code>DereferenceContextFactory</code> allows dereference
engine implementations to use a custom <code>DereferenceContext</code>. With
that it is possible to parse request specific configuration (e.g. parsed by <a
href="../enhancementproperties">Enhancement Properties</a> only once per
request. The following code snippet shows how to use a custom
<code>DereferenceContext</code> with the core
<code>EntityDereferenceEngine</code> implementation.</p>
<div class="codehilite"><pre><span class="n">entityDereferenceEngine</span>
<span class="o">=</span> <span class="k">new</span> <span
class="n">EntityDereferenceEngine</span><span class="o">(</span><span
class="n">entityDereferencer</span><span class="o">,</span> <span
class="n">engineConfig</span><span class="o">,</span>
<span class="k">new</span> <span
class="nf">DereferenceContextFactory</span><span class="o">()</span> <span
class="o">{</span> <span class="c1">//we want to use our own DereferenceContext
impl</span>
Modified:
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/engines/entityhubdereference.html
==============================================================================
---
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/engines/entityhubdereference.html
(original)
+++
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/engines/entityhubdereference.html
Fri May 23 08:54:57 2014
@@ -150,6 +150,7 @@ enhancer.engines.dereference.ldpath=[&qu
<p><em>NOTE</em> when used in a OSGI <code>*.cfg</code> file one would need to
escape spaces and <code>=</code> with <code>\</code> and remove all line
breaks.</p>
<h2 id="supported-enhancement-properties">Supported Enhancement Properties</h2>
+<p><strong>since version <code>0.12.1</code></strong> with <a
href="https://issues.apache.org/jira/browse/STANBOL-1287";>STANBOL-1287</a></p>
<p>The following Enhancement Properties are supported by the Entityhub
Dereference Engine</p>
<ul>
<li><strong>Dereference Languages</strong>
<em>(enhancer.engines.dereference.languages)</em>: A set of languages that are
dereferenced. Even if <em>'Dereference only Content Language Literals'</em> is
active explicitly configured languages will still get dereferenced. *
<strong>Dereferenced Fields</strong>
<em>(enhancer.engines.dereference.fields)</em>: The dereferenced fields - in
RDF terminology 'properties' - to be dereferenced. QNames (e.g.
<code>rdf:label</code>) can be used for the configuration. This Engine supports
the use of FieldMappings for the configuration. Dereferenced Fields parsed as
EnhancementProperty will override values configured for the Engine.</li>
Modified:
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/enhancementproperties.html
==============================================================================
---
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/enhancementproperties.html
(original)
+++
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/enhancementproperties.html
Fri May 23 08:54:57 2014
@@ -89,7 +89,7 @@
<ul> <li><a href="/">Home</a></li> <li class="item"><a
href="/docs/">Docs</a></li> <li class="item"><a
href="/docs/trunk/">Trunk</a></li> <li class="item"><a
href="/docs/trunk/components/">Components</a></li> <li class="item"><a
href="/docs/trunk/components/enhancer/">Enhancer</a></li> </ul>
</div>
<h1 class="title">Enhancement Properties</h1>
- <p><strong>since version <code>0.12.1</code></strong></p>
+ <p><strong>since version <code>0.12.1</code></strong> with <a
href="https://issues.apache.org/jira/browse/STANBOL-488";>STANBOL-488</a></p>
<p>Enhancement Properties allow to parametrize the enhancement process of a <a
href="contentitem">ContentItem</a>. In contrast to the configuration of <a
href="engines">Enhancement Engines</a> - that is bound to the component life
cycle - enhancement properties can be defined for <a href="chains">Enhancement
Chain</a> and single enhancement requests.</p>
<h2 id="naming-and-definition">Naming and definition</h2>
<p>EnhancementProperties are defined as string keys similar to Java
properties. To represent them in RDF the key is transformed to an URI by using
the string key as local name and
<code>http://stanbol.apache.org/ontology/enhancementproperties#</code> as
namespace. The default namespace prefix for enhancement properties is
<code>ehp</code>. </p>
Modified:
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/nlp/index.html
==============================================================================
---
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/nlp/index.html
(original)
+++
websites/staging/stanbol/trunk/content/docs/trunk/components/enhancer/nlp/index.html
Fri May 23 08:54:57 2014
@@ -89,7 +89,7 @@
<ul> <li><a href="/">Home</a></li> <li class="item"><a
href="/docs/">Docs</a></li> <li class="item"><a
href="/docs/trunk/">Trunk</a></li> <li class="item"><a
href="/docs/trunk/components/">Components</a></li> <li class="item"><a
href="/docs/trunk/components/enhancer/">Enhancer</a></li> <li class="item"><a
href="/docs/trunk/components/enhancer/nlp/">Nlp</a></li> </ul>
</div>
<h1 class="title">Stanbol Enhancer Natural Language Processing Support
</h1>
- <p><strong>NOTE:</strong> The NLP processing module for the Apache Stanbol
Enhancer was introduced in <a
href="https://issues.apache.org/jira/browse/STANBOL-733";>STANBOL-733</a> and is
only available in Apache Stanbol Enhancer versions starting from
<code>0.10.0</code>.</p>
+ <p><strong>since version 0.10.0</strong> with <a
href="https://issues.apache.org/jira/browse/STANBOL-733";>STANBOL-733</a></p>
<h2 id="overview">Overview:</h2>
<p>This section covers the following topics:</p>
<ul>
