[ 
https://issues.apache.org/jira/browse/STANBOL-967?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13590312#comment-13590312
 ] 

Rupert Westenthaler commented on STANBOL-967:
---------------------------------------------

The ServiceProperties interface mimics the Dictionary<String,Object> as used by 
OSGI for the component configuration. The reason why this is not a subClass of 
the EnhancementEngine is that it might be also used by other Components (e.g. 
enhancement Chains).

The javadoc of ORDERING_EXTRACTION_ENHANCEMENT explains the range

     * Ordering values < {@link ServiceProperties#ORDERING_CONTENT_EXTRACTION}
     * and >= this value indicate, that an enhancement engine performs 
operations
     * on extracted features of the content. It can also extract additional
     * enhancement by using the content, but such features might not be
     * available to other engines using this ordering range

While ServiceProperties are currently only used for automatic ordering of the 
execution of EnhancementEngines (e.g. by the WeightedChain implementation) this 
API allows Engines to provide additional information. They could be also used 
for other usage examples (e.g. to make OSGI configuration properties available 
via the API)

Some NLP processing Engines use this Interface to expose their Role(s) 
(org.apache.stanbol.enhancer.nlp.NlpProcessingRole) via the ServiceProperties. 
The according key is defined by the NlpServiceProperties class. This 
information might be used by a future NlpProcessingChain implementation to 
automatically construct an NLP processing EnhancementChain based on available 
NLP processing engines.


                
> enhancer.servicesapi.ServiceProperties documentation improvement
> ----------------------------------------------------------------
>
>                 Key: STANBOL-967
>                 URL: https://issues.apache.org/jira/browse/STANBOL-967
>             Project: Stanbol
>          Issue Type: Improvement
>          Components: Enhancer
>            Reporter: Reto Bachmann-Gmür
>            Priority: Minor
>              Labels: documentation
>
> The javadoc of enhancer.servicesapi.ServiceProperties isn't very clear.
> "Stanbol Enhancer components might implement this interface to parse 
> additional properties to other components."
> What does it mean to "parse additional properties". If an "Enhancer 
> component" is a EnhancementEngine why doesn't this interface extend it? And 
> what is the "other component"?
> Why does getServiceProperties return a Map with Objects as values while the 
> constants are all integers? What are the possible keys expect 
> ENHANCEMENT_ENGINE_ORDERING? Is anything else but the EnhancementJobManager 
> expected to read/use this properties?
> javadoc to DEFAULT_ORDERING:
>      * The default ordering uses {@link 
> ServiceProperties#ORDERING_EXTRACTION_ENHANCEMENT}
>      * -1 . So by default EnhancementEngines are called after all engines that
>      * use an value within the ordering range defined by
>      * {@link ServiceProperties#ORDERING_EXTRACTION_ENHANCEMENT}
> As ORDERING_EXTRACTION_ENHANCEMENT is 1 ORDERING_EXTRACTION_ENHANCEMENT-1 is 
> 0. Is the first sentence ust a convuted wy of saying that this constant has 
> value 0?
> An what is the value range defined by ORDERING_EXTRACTION_ENHANCEMENT, is 
> this the range [1,1]?

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Reply via email to