Author: rwesten
Date: Fri May 23 08:54:51 2014
New Revision: 1597033
URL: http://svn.apache.org/r1597033
Log:
STANBOL-488, STANBOL-336, STANBOL-1223, STANBOL-1165: improvements, corrections
and clarifications
Modified:
stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/dereference.mdtext
stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/entityhubdereference.mdtext
stanbol/site/trunk/content/docs/trunk/components/enhancer/enhancementproperties.mdtext
stanbol/site/trunk/content/docs/trunk/components/enhancer/nlp/index.mdtext
Modified:
stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/dereference.mdtext
URL:
http://svn.apache.org/viewvc/stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/dereference.mdtext?rev=1597033&r1=1597032&r2=1597033&view=diff
==============================================================================
---
stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/dereference.mdtext
(original)
+++
stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/dereference.mdtext
Fri May 23 08:54:51 2014
@@ -1,5 +1,7 @@
title: Entity Dereference Engine
+__since version `0.12.0`__ with
[STANBOL-1222](https://issues.apache.org/jira/browse/STANBOL-1222)
+
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
[Content Item](../contentitem).
@@ -81,13 +83,17 @@ The `dereference(..)` method is used to
Configuration Parameters supported by the Core Entity Dereference Engine
implementation are defined in the `DereferenceConstants` class.
+#### DereferenceEngineConfig
+
The `DereferenceEngineConfig` class provides an easy - API based - access to
those configuration parameters. It is instantiated by using the `Dictionary`
parsed by the OSGI as part of the `ComponentContext`.
-Finally the `DereferenceContext` is used to parse both the
`DereferenceEngineConfig` and the request specific configuration (including
_Offline Mode_ state and [Enhancement Properties](../enhancementproperties)) to
calls to the `EntityDereferencer`.
+#### DereferenceContext
+
+The `DereferenceContext` is used to parse request specific context to the
`EntityDereferencer` implementation.
-Specific EntityDereferencer implementation can use their own custom
`DereferenceContext` 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
`EntityDereferenceEngine` will result in multiple calls to the
`EntityDereferencer` - one call for each scheduled Entity. The same
`DereferenceContext` instance will be used for each of those calls.
`DereferenceContext` instances are created by using the
`DereferenceContextFactory` parsed when constructing the `DereferenceEngine`.
So a custom `DereferenceContext` implementation allows to ensure that request
specific configurations are only parsed once per request and not for each
dereferenced entity.
+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 `EntityDereferencer#dereference(..)`
method. All such calls will use the same `DereferenceContext` instance.
-The following listing shows how to instantiate a `EntityDereferenceEngine`
with a custom `DereferenceContext`.
+Extending the `DereferenceContextFactory` allows dereference engine
implementations to use a custom `DereferenceContext`. With that it is possible
to parse request specific configuration (e.g. parsed by [Enhancement
Properties](../enhancementproperties) only once per request. The following code
snippet shows how to use a custom `DereferenceContext` with the core
`EntityDereferenceEngine` implementation.
:::java
entityDereferenceEngine = new EntityDereferenceEngine(entityDereferencer,
engineConfig,
Modified:
stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/entityhubdereference.mdtext
URL:
http://svn.apache.org/viewvc/stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/entityhubdereference.mdtext?rev=1597033&r1=1597032&r2=1597033&view=diff
==============================================================================
---
stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/entityhubdereference.mdtext
(original)
+++
stanbol/site/trunk/content/docs/trunk/components/enhancer/engines/entityhubdereference.mdtext
Fri May 23 08:54:51 2014
@@ -77,6 +77,8 @@ _NOTE_ when used in a OSGI `*.cfg` file
## Supported Enhancement Properties
+__since version `0.12.1`__ with
[STANBOL-1287](https://issues.apache.org/jira/browse/STANBOL-1287)
+
The following Enhancement Properties are supported by the Entityhub
Dereference Engine
* __Dereference Languages__ _(enhancer.engines.dereference.languages)_: A set
of languages that are dereferenced. Even if _'Dereference only Content Language
Literals'_ is active explicitly configured languages will still get
dereferenced. * __Dereferenced Fields__
_(enhancer.engines.dereference.fields)_: The dereferenced fields - in RDF
terminology 'properties' - to be dereferenced. QNames (e.g. `rdf:label`) 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.
Modified:
stanbol/site/trunk/content/docs/trunk/components/enhancer/enhancementproperties.mdtext
URL:
http://svn.apache.org/viewvc/stanbol/site/trunk/content/docs/trunk/components/enhancer/enhancementproperties.mdtext?rev=1597033&r1=1597032&r2=1597033&view=diff
==============================================================================
---
stanbol/site/trunk/content/docs/trunk/components/enhancer/enhancementproperties.mdtext
(original)
+++
stanbol/site/trunk/content/docs/trunk/components/enhancer/enhancementproperties.mdtext
Fri May 23 08:54:51 2014
@@ -1,6 +1,6 @@
Title: Enhancement Properties
-__since version `0.12.1`__
+__since version `0.12.1`__ with
[STANBOL-488](https://issues.apache.org/jira/browse/STANBOL-488)
Enhancement Properties allow to parametrize the enhancement process of a
[ContentItem](contentitem). In contrast to the configuration of [Enhancement
Engines](engines) - that is bound to the component life cycle - enhancement
properties can be defined for [Enhancement Chain](chains) and single
enhancement requests.
Modified:
stanbol/site/trunk/content/docs/trunk/components/enhancer/nlp/index.mdtext
URL:
http://svn.apache.org/viewvc/stanbol/site/trunk/content/docs/trunk/components/enhancer/nlp/index.mdtext?rev=1597033&r1=1597032&r2=1597033&view=diff
==============================================================================
--- stanbol/site/trunk/content/docs/trunk/components/enhancer/nlp/index.mdtext
(original)
+++ stanbol/site/trunk/content/docs/trunk/components/enhancer/nlp/index.mdtext
Fri May 23 08:54:51 2014
@@ -1,6 +1,6 @@
title: Stanbol Enhancer Natural Language Processing Support
-__NOTE:__ The NLP processing module for the Apache Stanbol Enhancer was
introduced in [STANBOL-733](https://issues.apache.org/jira/browse/STANBOL-733)
and is only available in Apache Stanbol Enhancer versions starting from
<code>0.10.0</code>.
+__since version 0.10.0__ with
[STANBOL-733](https://issues.apache.org/jira/browse/STANBOL-733)
Overview:
---------
