Author: rwesten
Date: Fri Jan 27 13:06:32 2012
New Revision: 1236670
URL: http://svn.apache.org/viewvc?rev=1236670&view=rev
Log:
Added Links to ContentItem in the documentation of other components.
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementengine.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext?rev=1236670&r1=1236669&r2=1236670&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/enhancementchain.mdtext
Fri Jan 27 13:06:32 2012
@@ -1,6 +1,6 @@
Title: Enhancement Chains
-An Enhancement Chain defines how Content parsed to the Stanbol Enhancer is
processed. More concrete it defines what
[EnhancementEngine](../engines/enhancementengine.html)s and in what order are
used to process ContentItems. Chains are not responsible for the actual
processing of ContentItems. They provide the
[ExecutionPlan](executionplan.html) to the
[EnhancementJobManger](../enhancementjobmanager.html) that does the actual
processing of the ContentItem.
+An Enhancement Chain defines how Content parsed to the Stanbol Enhancer is
processed. More concrete it defines what
[EnhancementEngine](../engines/enhancementengine.html)s and in what order are
used to process [ContentItem](../contentitem.html)s. Chains are not responsible
for the actual processing of ContentItems. They provide the
[ExecutionPlan](executionplan.html) to the
[EnhancementJobManger](../enhancementjobmanager.html) that does the actual
processing of the ContentItem.
In the RESTful API enhancement chains can be accessed by there name under
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext?rev=1236670&r1=1236669&r2=1236670&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/chains/executionplan.mdtext
Fri Jan 27 13:06:32 2012
@@ -1,6 +1,6 @@
Title: ExecutionPlan
-The ExecutionPlan is represented as an RDF graph following the ExecutionPlan
Ontology. It needs to be provided by the [Enhancement
Chain](enhancementchain.html) and is used by the
[EnhancementJobManager](../enhancementjobmanager.html) to enhance ContentItems
and to write the [ExecutionMetadata](../executionmetadata.html).
+The ExecutionPlan is represented as an RDF graph following the ExecutionPlan
Ontology. It needs to be provided by the [Enhancement
Chain](enhancementchain.html) and is used by the
[EnhancementJobManager](../enhancementjobmanager.html) to enhance
[ContentItem](../contentitem.html)s and to write the
[ExecutionMetadata](../executionmetadata.html).
## ExecutionPlan Ontology
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementengine.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementengine.mdtext?rev=1236670&r1=1236669&r2=1236670&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementengine.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/engines/enhancementengine.mdtext
Fri Jan 27 13:06:32 2012
@@ -1,6 +1,6 @@
Title: EnhancementEngine
-EnhancementEngines are the components that are responsible to enhance
ContentItmes. They are called by the
[EnhancementJobManager](../enhancementjobmanager.html). EnhancementEngines do
have full access to the parsed ContentItems. They are expected to modify the
state of the content item.
+EnhancementEngines are the components that are responsible to enhance
ContentItmes. They are called by the
[EnhancementJobManager](../enhancementjobmanager.html). EnhancementEngines do
have full access to the parsed [ContentItem](../contentitem.html)s. They are
expected to modify the state of the content item.
The RESTful interface of an EnhancementEngines can be accessed by
@@ -38,7 +38,7 @@ Each EnhancementEngine has an name assig
in the activate method.
-The "canEnahnce(ContentItem ci)" method is used by the
[EnhancementJobManager](../enhancementjobmanager.html) to check if an engine is
able to process a ContentItem. Calling this method MUST NOT change the state of
the ContentItem and this method MUST also NOT acquire a write lock on the
content item.
+The "canEnahnce(ContentItem ci)" method is used by the
[EnhancementJobManager](../enhancementjobmanager.html) to check if an engine is
able to process a [ContentItem](../contentitem.html). Calling this method MUST
NOT change the state of the ContentItem and this method MUST also NOT acquire a
write lock on the content item.
The "computeEnhacements(ContentItem ci)" starts the processing of the parsed
ContentItem by the engine. It is expected to change the state of the parsed
ContentItem. Engines that support asynchronous processing need to take care to
correctly apply read/write locks when reading/writing information from/to the
content time. Engines that return ENHANCE_SYNCHRONOUS on calls to
canEnhance(..) do not need to use locks. They can trust that they have
exclusive read/write access to the content item.
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext?rev=1236670&r1=1236669&r2=1236670&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/enhancementjobmanager.mdtext
Fri Jan 27 13:06:32 2012
@@ -1,7 +1,7 @@
Title: EnhancementJobManager
-The EnhancementJobManager is component responsible for the execution of the
[ExecutionPlan](chains/executionplan.html) as provided by the [Enhancement
Chain](chains/enhancementchain.html) on the ContentItem.
+The EnhancementJobManager is component responsible for the execution of the
[ExecutionPlan](chains/executionplan.html) as provided by the [Enhancement
Chain](chains/enhancementchain.html) on the [ContentItem](contentitem.html).
## EnhancementJobManager interface
@@ -20,13 +20,13 @@ Note that the parsed ContentItem will be
While the [ExecutionPlan](chains/executionplan.html) defines what
EnhancementEgnies are used and how they depend on each the
EnhancementJobManager is responsible for the actual execution of the
enhancement process based on this plan. This section provides detailed
information about requirements and expectations that MUST BE considered.
-The EnhancementJobManager is also responsible to create and update the
[ExecutionMetadata](executionmetadata.html) in the metadata of the processed
ContentItem.
+The EnhancementJobManager is also responsible to create and update the
[ExecutionMetadata](executionmetadata.html) in the metadata of the processed
[ContentItem](contentitem.html).
### Retrieving the ExecutionPlan
The [ExecutionPlan](chains/executionplan.html) is provided by the Chain in a
final graph that is guaranteed to be not changed. However because the
configuration of a Chain might be change at any time the EnhancementJobManager
MUST retrieve the execution plan only once and used it during the whole
enhancement process.
-Before the start of the enhancement process the EnhancementJobManager needs
first to initialize the [ExecutionMetadata](executionmetadata.html) for the
ContentItem. This includes
+Before the start of the enhancement process the EnhancementJobManager needs
first to initialize the [ExecutionMetadata](executionmetadata.html) for the
[ContentItem](contentitem.html). This includes
1. copying the execution plan as returned by the Chain to the metadata of the
content item
2. create an 'em:ChainExecutin' instance and set the 'em:enhances' property to
the URI of the ContentItem
@@ -89,7 +89,7 @@ This implementation supports an asynchro
### WeightedJobManager
-This JobManager was used as default before the introduction of
EnhancementChains. It does not support EnhancementChains and will enhance
parsed ContentItems by calling all currently active EnhancementEngines in a
sequential manner. It does also not have support for EnhancementMetadata.
+This JobManager was used as default before the introduction of
EnhancementChains. It does not support EnhancementChains and will enhance
parsed [ContentItem](contentitem.html)s by calling all currently active
EnhancementEngines in a sequential manner. It does also not have support for
EnhancementMetadata.
This implementation is provided by the
"org.apache.stanbol.enhancer.jobmanager.weightedjobmanager" module and is no
longer included within the Apache Stanbol launchers. This JobManager registers
itself with a service ranking of "-1000". Users that want to use this job
manager need to manually install this bundle and either deactivate other
EnhancementJobManager implementation or reconfigure the service ranking of this
one to an value > 0.
Modified:
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext
URL:
http://svn.apache.org/viewvc/incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext?rev=1236670&r1=1236669&r2=1236670&view=diff
==============================================================================
---
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext
(original)
+++
incubator/stanbol/site/trunk/content/stanbol/docs/trunk/enhancer/executionmetadata.mdtext
Fri Jan 27 13:06:32 2012
@@ -1,6 +1,6 @@
Title: Execution Metadata
-The execution metadata are added by the
[EnhancementJobManager](enhancementjobmanager.html) to the metadata of the
ContentItem. This metadata provide information about the execution of the
[ExecutionPlan](chains/executionplan.html) provided by the
[Chain](chains/enhancementchain.html) and can be used by clients to get
detailed information about the enhancement process of a content item.
+The execution metadata are added by the
[EnhancementJobManager](enhancementjobmanager.html) to the metadata of the
[ContentItem](contentitem.html). This metadata provide information about the
execution of the [ExecutionPlan](chains/executionplan.html) provided by the
[Chain](chains/enhancementchain.html) and can be used by clients to get
detailed information about the enhancement process of a content item.
In the case of asynchronous calls to the enhancers RESTful interface (requests
that immediately return and do not wait for the enhancement process to
complete) this information might also be useful to provide information about
the current state of the enhancement process.
@@ -118,4 +118,4 @@ The Execution Plan: (copy from the examp
ep:engine zemanta
ep:optional "true"^^xsd:boolean
-Note that both the Execution Metadata AND the Execution Plan need to be
contained within the metadata of the ContentItem
+Note that both the Execution Metadata AND the Execution Plan need to be
contained within the metadata of the [ContentItem](contentitem.html)
