[jira] [Updated] (STANBOL-488) EnhancementProperties

["Rupert Westenthaler (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/STANBOL-488?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rupert Westenthaler updated STANBOL-488:
----------------------------------------

          Description: 
Enhancement Properties aim to provide Chain and Request scoped configurations to EnhancementEngines. 

__IMPORTANT NOTE:__ This Issue introduces incompatible API changes to core interfaces of the Stanbol Enhancer. This includes the `EnhancementEngine` interface.


Expected use ages include:

* parse through of user names and passwords for EnhancementEngines that depend on external services. This will allow such engines to use the user account of the the one parsing the request (request scope) or the one configuring the chain (chain configuration scope)
* parse request specific constraints (e.g. the minimum confidence level for Enhancements). The acceptable confidence might depend on the actual context of the client application (e.g. if the user will review results or not)
* configure dereferencing on a request bases (e.g. depending on the requirements of the UI showing the enhancement results)
* reduce the number of configured engine instances (e.g. when specifying the minimum required confidence level for a chain or on request level one would only need a single instance of a confidence-level-filter-engine; The same would be true for dbpedia-linking engines with a different amount of suggested results) 

NOTES:

* See detailed description in comments dating from February 2014 or later. 
* The initial (and now outdated) description of this issue was moved to the start of the first comment. 

  was:
Enhancement Properties represent a "Map<String,Object>" that can be used to add properties to an Enhancement Request.

EnhancementProperties are a simple way to share information within an EnhancementRequest. Intended Usage include:

* Users may parse special properties that can be accessed by all components of the EnhancementProcess (e.g. user.name user.pwd for external services)
* To share parameters parsed as Query Parameters such as defined by STANBOL-481

Implementation:

(1) Store EnhancementProperties as ContentPart with the URI "urn:apache.org:stanbol.web:enhancement.properties"

(2) Provide an EnhancementPropertiesHelper with helper methods

(3) Optionally extend the ContentItem interface with a method to get the EnhancementPrpoerties

    + getEnhancementProperties() : Map<String,Object>

This Issue will initially cover (1) and (2). (3) needs to be discussed

    Affects Version/s: 1.0.0
        Fix Version/s: 1.0.0

> EnhancementProperties
> ---------------------
>
>                 Key: STANBOL-488
>                 URL: https://issues.apache.org/jira/browse/STANBOL-488
>             Project: Stanbol
>          Issue Type: New Feature
>          Components: Enhancer
>    Affects Versions: 1.0.0
>            Reporter: Rupert Westenthaler
>            Assignee: Rupert Westenthaler
>             Fix For: 1.0.0
>
>
> Enhancement Properties aim to provide Chain and Request scoped configurations to EnhancementEngines. 
> __IMPORTANT NOTE:__ This Issue introduces incompatible API changes to core interfaces of the Stanbol Enhancer. This includes the `EnhancementEngine` interface.
> Expected use ages include:
> * parse through of user names and passwords for EnhancementEngines that depend on external services. This will allow such engines to use the user account of the the one parsing the request (request scope) or the one configuring the chain (chain configuration scope)
> * parse request specific constraints (e.g. the minimum confidence level for Enhancements). The acceptable confidence might depend on the actual context of the client application (e.g. if the user will review results or not)
> * configure dereferencing on a request bases (e.g. depending on the requirements of the UI showing the enhancement results)
> * reduce the number of configured engine instances (e.g. when specifying the minimum required confidence level for a chain or on request level one would only need a single instance of a confidence-level-filter-engine; The same would be true for dbpedia-linking engines with a different amount of suggested results) 
> NOTES:
> * See detailed description in comments dating from February 2014 or later. 
> * The initial (and now outdated) description of this issue was moved to the start of the first comment. 



--
This message was sent by Atlassian JIRA
(v6.1.5#6160)