You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stanbol.apache.org by rw...@apache.org on 2013/12/02 16:57:11 UTC

svn commit: r1547071 - in /stanbol/branches/release-0.12: ./ enhancement-engines/ enhancement-engines/entitylinking/engine/src/main/java/org/apache/stanbol/enhancer/engines/entitylinking/config/ enhancement-engines/entitytagging/src/main/java/org/apach...

Author: rwesten
Date: Mon Dec  2 15:57:11 2013
New Revision: 1547071

URL: http://svn.apache.org/r1547071
Log:
STANBOL-1225: deprecation of entitylinking functionaliy of the EntityLinking, NamedEntityLinking and EntityTagging engine in the trunk.

Modified:
    stanbol/branches/release-0.12/   (props changed)
    stanbol/branches/release-0.12/enhancement-engines/   (props changed)
    stanbol/branches/release-0.12/enhancement-engines/entitylinking/engine/src/main/java/org/apache/stanbol/enhancer/engines/entitylinking/config/EntityLinkerConfig.java
    stanbol/branches/release-0.12/enhancement-engines/entitytagging/src/main/java/org/apache/stanbol/enhancer/engines/entitytagging/impl/NamedEntityTaggingEngine.java
    stanbol/branches/release-0.12/enhancement-engines/keywordextraction/src/main/java/org/apache/stanbol/enhancer/engines/keywordextraction/engine/KeywordLinkingEngine.java

Propchange: stanbol/branches/release-0.12/
------------------------------------------------------------------------------
  Merged /stanbol/trunk:r1546706,1547070

Propchange: stanbol/branches/release-0.12/enhancement-engines/
------------------------------------------------------------------------------
  Merged /stanbol/trunk/enhancement-engines:r1546706,1547070

Modified: stanbol/branches/release-0.12/enhancement-engines/entitylinking/engine/src/main/java/org/apache/stanbol/enhancer/engines/entitylinking/config/EntityLinkerConfig.java
URL: http://svn.apache.org/viewvc/stanbol/branches/release-0.12/enhancement-engines/entitylinking/engine/src/main/java/org/apache/stanbol/enhancer/engines/entitylinking/config/EntityLinkerConfig.java?rev=1547071&r1=1547070&r2=1547071&view=diff
==============================================================================
--- stanbol/branches/release-0.12/enhancement-engines/entitylinking/engine/src/main/java/org/apache/stanbol/enhancer/engines/entitylinking/config/EntityLinkerConfig.java (original)
+++ stanbol/branches/release-0.12/enhancement-engines/entitylinking/engine/src/main/java/org/apache/stanbol/enhancer/engines/entitylinking/config/EntityLinkerConfig.java Mon Dec  2 15:57:11 2013
@@ -197,12 +197,15 @@ public class EntityLinkerConfig {
     public static final String MAX_SEARCH_TOKEN_DISTANCE = "enhancer.engines.linking.maxSearchTokenDistance";
     /**
      * Adds the dereference feature (STANBOL-333) also to this engine.
-     * This will be replaced by STANBOL-336. 
+     * @deprecated Use a Dereference Engine instead (STANBOL-336)
      */
+    @Deprecated
     public static final String DEREFERENCE_ENTITIES = "enhancer.engines.linking.dereference";
     /**
      * Allows to add a list of fields that are included when dereferencing Entities
+     * @deprecated Use a Dereference Engine instead (STANBOL-336)
      */
+    @Deprecated
     public static final String DEREFERENCE_ENTITIES_FIELDS = "enhancer.engines.linking.dereferenceFields";
     /**
      * Allows to enable/disable sorting of suggestion that have the same score
@@ -439,9 +442,12 @@ public class EntityLinkerConfig {
     public final static float DEFAULT_MIN_TOKEN_SCORE = 0.7f;
 
     /**
-     * By default Entities are dereferenced
+     * By default Entities are dereferenced. Default chanted to <code>false</code>
+     * as this is now deprecated
+     * @deprecated Use a Dereference Engine instead (STANBOL-336)
      */
-    public static final boolean DEFAULT_DEREFERENCE_ENTITIES_STATE = true;
+    @Deprecated
+    public static final boolean DEFAULT_DEREFERENCE_ENTITIES_STATE = false;
 
     /**
      * The default value for the state if entities that would have the same score
@@ -839,6 +845,10 @@ public class EntityLinkerConfig {
             linkerConfig.setDereferenceEntitiesState(Boolean.parseBoolean(value.toString()));
         }
         if(linkerConfig.isDereferenceEntitiesEnabled()){
+            log.warn("DereferenceEntities is deprecated for the Engine. Please use the "
+                + "EntityhubDereferenceEngine instead (see STANBOL-1223 for details)");
+        }
+        if(linkerConfig.isDereferenceEntitiesEnabled()){
             value = configuration.get(DEREFERENCE_ENTITIES_FIELDS);
             if(value instanceof String[]){
                 for(String field : (String[])value){
@@ -1406,6 +1416,7 @@ public class EntityLinkerConfig {
      * Setter for the dereference entities state.
      * @param state the state or <code>null</code> to set the
      * default.
+     * @deprecated Use a Dereference Engine instead (STANBOL-336)
      */
     public void setDereferenceEntitiesState(Boolean state) {
         if(state == null){
@@ -1418,6 +1429,7 @@ public class EntityLinkerConfig {
     /**
      * Getter for the dereference entities state
      * @return <code>true</code> if enabled otherwise <code>false</code>
+     * @deprecated Use a Dereference Engine instead (STANBOL-336)
      */
     public boolean isDereferenceEntitiesEnabled(){
         return dereferenceEntitiesState;
@@ -1433,6 +1445,7 @@ public class EntityLinkerConfig {
      * <li> {@link #getDereferencedFields()} if {@link #isDereferenceEntitiesEnabled()}
      * </ul>
      * @return the selected fields for queries against the linked vocabulary.
+     * @deprecated Use a Dereference Engine instead (STANBOL-336)
      */
     public Set<UriRef> getSelectedFields() {
         if(__selectedFields == null){

Modified: stanbol/branches/release-0.12/enhancement-engines/entitytagging/src/main/java/org/apache/stanbol/enhancer/engines/entitytagging/impl/NamedEntityTaggingEngine.java
URL: http://svn.apache.org/viewvc/stanbol/branches/release-0.12/enhancement-engines/entitytagging/src/main/java/org/apache/stanbol/enhancer/engines/entitytagging/impl/NamedEntityTaggingEngine.java?rev=1547071&r1=1547070&r2=1547071&view=diff
==============================================================================
--- stanbol/branches/release-0.12/enhancement-engines/entitytagging/src/main/java/org/apache/stanbol/enhancer/engines/entitytagging/impl/NamedEntityTaggingEngine.java (original)
+++ stanbol/branches/release-0.12/enhancement-engines/entitytagging/src/main/java/org/apache/stanbol/enhancer/engines/entitytagging/impl/NamedEntityTaggingEngine.java Mon Dec  2 15:57:11 2013
@@ -123,8 +123,10 @@ public class NamedEntityTaggingEngine ex
 
     /**
      * Use the RDFS label as default
+     * @deprecated Use a dereference engine instead (STANBOL-336)
      */
-    @Property(boolValue = true)
+    @Deprecated
+    @Property(boolValue = false) //changed default to false
     public static final String DEREFERENCE_ENTITIES = "org.apache.stanbol.enhancer.engines.entitytagging.dereference";
 
     @Property(intValue = 0)
@@ -206,8 +208,11 @@ public class NamedEntityTaggingEngine ex
      * The number of Suggestions to be added
      */
     protected Integer numSuggestions = 3;
-
-    protected boolean dereferenceEntities = true;
+    /**
+     * Changed default to <code>false</code> now that this feature is deprecated
+     * (STANBOL-336).
+     */
+    protected boolean dereferenceEntities = false;
 
     /**
      * The {@link OfflineMode} is used by Stanbol to indicate that no external service should be referenced.
@@ -289,6 +294,10 @@ public class NamedEntityTaggingEngine ex
         Object dereferenceEntities = config.get(DEREFERENCE_ENTITIES);
         this.dereferenceEntities = state == null ? true : Boolean
                 .parseBoolean(dereferenceEntities.toString());
+        if(this.dereferenceEntities){
+            log.warn("DereferenceEntities is deprecated for this Enigne. Please use "
+                + "the EntityhubDereferenceEngine instead (see STANBOL-1223 for details)");
+        }
     }
 
     @Deactivate

Modified: stanbol/branches/release-0.12/enhancement-engines/keywordextraction/src/main/java/org/apache/stanbol/enhancer/engines/keywordextraction/engine/KeywordLinkingEngine.java
URL: http://svn.apache.org/viewvc/stanbol/branches/release-0.12/enhancement-engines/keywordextraction/src/main/java/org/apache/stanbol/enhancer/engines/keywordextraction/engine/KeywordLinkingEngine.java?rev=1547071&r1=1547070&r2=1547071&view=diff
==============================================================================
--- stanbol/branches/release-0.12/enhancement-engines/keywordextraction/src/main/java/org/apache/stanbol/enhancer/engines/keywordextraction/engine/KeywordLinkingEngine.java (original)
+++ stanbol/branches/release-0.12/enhancement-engines/keywordextraction/src/main/java/org/apache/stanbol/enhancer/engines/keywordextraction/engine/KeywordLinkingEngine.java Mon Dec  2 15:57:11 2013
@@ -168,15 +168,18 @@ public class KeywordLinkingEngine 
 //  public static final String ENABLE_CHUNKER = "org.apache.stanbol.enhancer.engines.keywordextraction.enableChunker";
     /**
      * Adds the dereference feature (STANBOL-333) also to this engine.
-     * This will be replaced by STANBOL-336. 
+     * @deprecated Use a Dereference Engine instead (STANBOL-336)
      */
     public static final String DEREFERENCE_ENTITIES = "org.apache.stanbol.enhancer.engines.keywordextraction.dereference";
     /**
-     * The default state to dereference entities set to <code>true</code>.
+     * The default state to dereference entities set to <code>false</code> as
+     * this is now a deprecated feature.
+     * @deprecated Use a Dereference Engine instead (STANBOL-336)
      */
-    public static final boolean DEFAULT_DEREFERENCE_ENTITIES_STATE = true;
+    public static final boolean DEFAULT_DEREFERENCE_ENTITIES_STATE = false;
     /**
      * Allows to add a list of fields that are included when dereferencing Entities
+     * @deprecated Use a Dereference Engine instead (STANBOL-336)
      */
     public static final String DEREFERENCE_ENTITIES_FIELDS = "org.apache.stanbol.enhancer.engines.keywordextraction.dereferenceFields";
     /**
@@ -566,6 +569,10 @@ public class KeywordLinkingEngine 
             dereferenceEntitiesState = DEFAULT_DEREFERENCE_ENTITIES_STATE;
         }
         if(dereferenceEntitiesState){
+            log.warn("DereferenceEntities is deprecated. Please use the Entityhub"
+                + "DereferenceEngine instead (see STANBOL-1223 for details)");
+        }
+        if(dereferenceEntitiesState){
             value = properties.get(DEREFERENCE_ENTITIES_FIELDS);
             if(value instanceof String[]){
                 for(String field : (String[])value){