RD-1983 add support for topics and keyphrases

json/src/main/java/com/basistech/rosette/dm/jackson/AnnotatedDataModelModule.java

@@ -27,6 +27,7 @@
 import com.basistech.rosette.dm.Entity;
 import com.basistech.rosette.dm.Extent;
 import com.basistech.rosette.dm.HanMorphoAnalysis;
+import com.basistech.rosette.dm.Keyphrase;
 import com.basistech.rosette.dm.KoreanMorphoAnalysis;
 import com.basistech.rosette.dm.LanguageDetection;
 import com.basistech.rosette.dm.ListAttribute;
@@ -39,6 +40,7 @@
 import com.basistech.rosette.dm.ScriptRegion;
 import com.basistech.rosette.dm.Sentence;
 import com.basistech.rosette.dm.Token;
+import com.basistech.rosette.dm.Topic;
 import com.basistech.rosette.dm.TranslatedData;
 import com.basistech.rosette.dm.TranslatedTokens;
 import com.basistech.util.jackson.EnumModule;
@@ -86,6 +88,8 @@ public void setupModule(SetupContext context) {
         context.setMixInAnnotations(Dependency.class, DependencyMixin.class);
         context.setMixInAnnotations(EmbeddingCollection.class, EmbeddingCollectionMixin.class);
         context.setMixInAnnotations(Embeddings.class, EmbeddingsMixin.class);
+        context.setMixInAnnotations(Topic.class, TopicMixin.class);
+        context.setMixInAnnotations(Keyphrase.class, KeyphraseMixin.class);
     }
 
     /**

json/src/main/java/com/basistech/rosette/dm/jackson/AnnotatedTextMixin.java

@@ -21,12 +21,14 @@
 import com.basistech.rosette.dm.Dependency;
 import com.basistech.rosette.dm.Embeddings;
 import com.basistech.rosette.dm.Entity;
+import com.basistech.rosette.dm.Keyphrase;
 import com.basistech.rosette.dm.LanguageDetection;
 import com.basistech.rosette.dm.ListAttribute;
 import com.basistech.rosette.dm.RelationshipMention;
 import com.basistech.rosette.dm.ScriptRegion;
 import com.basistech.rosette.dm.Sentence;
 import com.basistech.rosette.dm.Token;
+import com.basistech.rosette.dm.Topic;
 import com.basistech.rosette.dm.TranslatedData;
 import com.basistech.rosette.dm.TranslatedTokens;
 import com.fasterxml.jackson.annotation.JsonCreator;
@@ -124,4 +126,10 @@ public abstract class AnnotatedTextMixin {
 
     @JsonIgnore
     public abstract Embeddings getEmbeddings();
+
+    @JsonIgnore
+    public abstract ListAttribute<Topic> getTopics();
+
+    @JsonIgnore
+    public abstract ListAttribute<Keyphrase> getKeyphrases();
 }

json/src/main/java/com/basistech/rosette/dm/jackson/KeyphraseMixin.java

@@ -0,0 +1,33 @@
+/*
+* Copyright 2017 Basis Technology Corp.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+package com.basistech.rosette.dm.jackson;
+
+import com.basistech.rosette.dm.Extent;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.List;
+import java.util.Map;
+
+public abstract class KeyphraseMixin {
+    @JsonCreator
+    KeyphraseMixin(@JsonProperty("keyphrase") String keyphrase,
+                   @JsonProperty("confidence") Double confidence,
+                   @JsonProperty("extents")List<Extent> extents,
+                   @JsonProperty("extendedProperties") Map<String, Object> extendedProperties) {
+        //
+    }
+}

json/src/main/java/com/basistech/rosette/dm/jackson/KnownAttribute.java

@@ -21,13 +21,15 @@
 import com.basistech.rosette.dm.Dependency;
 import com.basistech.rosette.dm.Embeddings;
 import com.basistech.rosette.dm.Entity;
+import com.basistech.rosette.dm.Keyphrase;
 import com.basistech.rosette.dm.LanguageDetection;
 import com.basistech.rosette.dm.ListAttribute;
 import com.basistech.rosette.dm.RelationshipComponent;
 import com.basistech.rosette.dm.RelationshipMention;
 import com.basistech.rosette.dm.ScriptRegion;
 import com.basistech.rosette.dm.Sentence;
 import com.basistech.rosette.dm.Token;
+import com.basistech.rosette.dm.Topic;
 import com.basistech.rosette.dm.TranslatedData;
 import com.basistech.rosette.dm.TranslatedTokens;
 import com.basistech.rosette.dm.UnknownAttribute;
@@ -59,7 +61,9 @@ public enum KnownAttribute {
     TOPIC_RESULT("topicResults", CategorizerResult.class),
     LIST("list", ListAttribute.class),
     UNKNOWN("unknown", UnknownAttribute.class),
-    RELATION_ARGUMENT("RelationshipComponent", RelationshipComponent.class);
+    RELATION_ARGUMENT("RelationshipComponent", RelationshipComponent.class),
+    TOPIC("topics", Topic.class),
+    KEYPHRASE("keyphrase", Keyphrase.class);
 
     private final String jsonTag;
     private final Class<? extends BaseAttribute> attributeClass;

json/src/main/java/com/basistech/rosette/dm/jackson/TopicMixin.java

@@ -0,0 +1,31 @@
+/*
+* Copyright 2017 Basis Technology Corp.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+package com.basistech.rosette.dm.jackson;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.Map;
+
+public abstract class TopicMixin {
+    @JsonCreator
+    TopicMixin(@JsonProperty("topic") String topic,
+               @JsonProperty("confidence") Double confidence,
+               @JsonProperty("conceptId") String topicId,
+               @JsonProperty("extendedProperties") Map<String, Object> extendedProperties) {
+        //
+    }
+}

json/src/main/java/com/basistech/rosette/dm/jackson/array/AnnotatedDataModelArrayModule.java

@@ -28,6 +28,7 @@
 import com.basistech.rosette.dm.Entity;
 import com.basistech.rosette.dm.Extent;
 import com.basistech.rosette.dm.HanMorphoAnalysis;
+import com.basistech.rosette.dm.Keyphrase;
 import com.basistech.rosette.dm.KoreanMorphoAnalysis;
 import com.basistech.rosette.dm.LanguageDetection;
 import com.basistech.rosette.dm.ListAttribute;
@@ -40,6 +41,7 @@
 import com.basistech.rosette.dm.ScriptRegion;
 import com.basistech.rosette.dm.Sentence;
 import com.basistech.rosette.dm.Token;
+import com.basistech.rosette.dm.Topic;
 import com.basistech.rosette.dm.TranslatedData;
 import com.basistech.rosette.dm.TranslatedTokens;
 import com.basistech.rosette.dm.jackson.ArabicMorphoAnalysisMixin;
@@ -53,6 +55,7 @@
 import com.basistech.rosette.dm.jackson.EntityMixin;
 import com.basistech.rosette.dm.jackson.ExtentMixin;
 import com.basistech.rosette.dm.jackson.HanMorphoAnalysisMixin;
+import com.basistech.rosette.dm.jackson.KeyphraseMixin;
 import com.basistech.rosette.dm.jackson.KoreanMorphoAnalysisMixin;
 import com.basistech.rosette.dm.jackson.MentionMixin;
 import com.basistech.rosette.dm.jackson.MorphoAnalysisMixin;
@@ -63,6 +66,7 @@
 import com.basistech.rosette.dm.jackson.ResolvedEntityMixin;
 import com.basistech.rosette.dm.jackson.ScriptRegionMixin;
 import com.basistech.rosette.dm.jackson.SentenceMixin;
+import com.basistech.rosette.dm.jackson.TopicMixin;
 import com.basistech.rosette.dm.jackson.TranslatedDataMixin;
 import com.basistech.rosette.dm.jackson.TranslatedTokensMixin;
 import com.basistech.util.jackson.EnumModule;
@@ -114,6 +118,8 @@ public void setupModule(SetupContext context) {
         context.setMixInAnnotations(Dependency.class, DependencyMixin.class);
         context.setMixInAnnotations(EmbeddingCollection.class, EmbeddingCollectionMixin.class);
         context.setMixInAnnotations(Embeddings.class, EmbeddingsMixin.class);
+        context.setMixInAnnotations(Topic.class, TopicMixin.class);
+        context.setMixInAnnotations(Keyphrase.class, KeyphraseMixin.class);
     }
 
     /**

json/src/main/java/com/basistech/rosette/dm/jackson/array/AnnotatedTextArrayMixin.java

@@ -21,12 +21,14 @@
 import com.basistech.rosette.dm.CategorizerResult;
 import com.basistech.rosette.dm.Dependency;
 import com.basistech.rosette.dm.Entity;
+import com.basistech.rosette.dm.Keyphrase;
 import com.basistech.rosette.dm.LanguageDetection;
 import com.basistech.rosette.dm.ListAttribute;
 import com.basistech.rosette.dm.RelationshipMention;
 import com.basistech.rosette.dm.ScriptRegion;
 import com.basistech.rosette.dm.Sentence;
 import com.basistech.rosette.dm.Token;
+import com.basistech.rosette.dm.Topic;
 import com.basistech.rosette.dm.TranslatedData;
 import com.basistech.rosette.dm.TranslatedTokens;
 import com.basistech.rosette.dm.jackson.DmTypeIdResolver;
@@ -122,4 +124,10 @@ public abstract class AnnotatedTextArrayMixin {
 
     @JsonIgnore
     public abstract ListAttribute<Dependency> getDependencies();
+
+    @JsonIgnore
+    public abstract ListAttribute<Topic> getTopics();
+
+    @JsonIgnore
+    public abstract ListAttribute<Keyphrase> getKeyphrases();
 }

json/src/test/java/com/basistech/rosette/dm/json/array/JsonTest.java

@@ -21,6 +21,7 @@
 import com.basistech.rosette.dm.CategorizerResult;
 import com.basistech.rosette.dm.Extent;
 import com.basistech.rosette.dm.HanMorphoAnalysis;
+import com.basistech.rosette.dm.Keyphrase;
 import com.basistech.rosette.dm.KoreanMorphoAnalysis;
 import com.basistech.rosette.dm.LanguageDetection;
 import com.basistech.rosette.dm.ListAttribute;
@@ -30,6 +31,7 @@
 import com.basistech.rosette.dm.ScriptRegion;
 import com.basistech.rosette.dm.Sentence;
 import com.basistech.rosette.dm.Token;
+import com.basistech.rosette.dm.Topic;
 import com.basistech.rosette.dm.TranslatedData;
 import com.basistech.rosette.dm.TranslatedTokens;
 import com.basistech.rosette.dm.jackson.AnnotatedDataModelModule;
@@ -77,6 +79,8 @@ public class JsonTest extends AdmAssert {
     private CategorizerResult categoryResult;
     private CategorizerResult sentimentResult;
     private CategorizerResult topicResult;
+    private Topic topic;
+    private Keyphrase keyphrase;
     private AnnotatedText referenceText;
 
     @Before
@@ -282,6 +286,18 @@ public void oneWithEverything() {
         crBuilder.add(topicResult);
         builder.topicResults(crBuilder.build());
 
+        ListAttribute.Builder<Topic> topicBuilder = new ListAttribute.Builder<>(Topic.class);
+        topic = new Topic.Builder("topic", 0.7, "Q100").build();
+        topicBuilder.add(topic);
+        builder.topics(topicBuilder.build());
+
+        ListAttribute.Builder<Keyphrase> keyphraseBuilder = new ListAttribute.Builder<>(Keyphrase.class);
+        keyphrase = new Keyphrase.Builder("keyphrase", 1.0,
+                Lists.newArrayList(new Extent.Builder(5, 6).build(), new Extent.Builder(6, 7).build()))
+                .build();
+        keyphraseBuilder.add(keyphrase);
+        builder.keyphrases(keyphraseBuilder.build());
+
         referenceText = builder.build();
     }
 

json/src/test/java/com/basistech/rosette/dm/json/plain/JsonTest.java

@@ -26,6 +26,7 @@
 import com.basistech.rosette.dm.Entity;
 import com.basistech.rosette.dm.Extent;
 import com.basistech.rosette.dm.HanMorphoAnalysis;
+import com.basistech.rosette.dm.Keyphrase;
 import com.basistech.rosette.dm.KoreanMorphoAnalysis;
 import com.basistech.rosette.dm.LanguageDetection;
 import com.basistech.rosette.dm.ListAttribute;
@@ -36,6 +37,7 @@
 import com.basistech.rosette.dm.ScriptRegion;
 import com.basistech.rosette.dm.Sentence;
 import com.basistech.rosette.dm.Token;
+import com.basistech.rosette.dm.Topic;
 import com.basistech.rosette.dm.TranslatedData;
 import com.basistech.rosette.dm.TranslatedTokens;
 import com.basistech.rosette.dm.jackson.AnnotatedDataModelModule;
@@ -93,6 +95,8 @@ public class JsonTest extends AdmAssert {
     private AnnotatedText referenceText;
     private Entity entity;
     private Embeddings embeddings;
+    private Topic topic;
+    private Keyphrase keyphrase;
 
     @Before
     public void oneWithEverythingOldEntities() {
@@ -306,6 +310,18 @@ public void oneWithEverythingOldEntities() {
         embeddings = embeddingsBuilder.build();
         builder.embeddings(embeddingsBuilder.build());
 
+        ListAttribute.Builder<Topic> topicBuilder = new ListAttribute.Builder<>(Topic.class);
+        topic = new Topic.Builder("topic", 0.7, "Q100").build();
+        topicBuilder.add(topic);
+        builder.topics(topicBuilder.build());
+
+        ListAttribute.Builder<Keyphrase> keyphraseBuilder = new ListAttribute.Builder<>(Keyphrase.class);
+        keyphrase = new Keyphrase.Builder("keyphrase", 1.0,
+                Lists.newArrayList(new Extent.Builder(5, 6).build(), new Extent.Builder(6, 7).build()))
+                .build();
+        keyphraseBuilder.add(keyphrase);
+        builder.keyphrases(keyphraseBuilder.build());
+
         referenceTextOldEntities = builder.build();
 
     }

model/src/main/java/com/basistech/rosette/dm/AnnotatedText.java

@@ -527,6 +527,15 @@ public Embeddings getEmbeddings() {
         return (Embeddings) attributes.get(AttributeKey.EMBEDDING.key());
     }
 
+    @SuppressWarnings("unchecked")
+    public ListAttribute<Topic> getTopics() {
+        return (ListAttribute<Topic>) attributes.get(AttributeKey.TOPIC.key());
+    }
+
+    @SuppressWarnings("unchecked")
+    public ListAttribute<Keyphrase> getKeyphrases() {
+        return (ListAttribute<Keyphrase>) attributes.get(AttributeKey.KEYPHRASE.key());
+    }
     /**
      * toString is a convenience for accessing the textual data, if any, in this annotated text.
      * @return the data for this AnnotatedText as a String.
@@ -798,6 +807,16 @@ public Builder embeddings(Embeddings embeddings) {
             return this;
         }
 
+        public Builder topics(ListAttribute<Topic> topics) {
+            attributes.put(AttributeKey.TOPIC.key(), topics);
+            return this;
+        }
+
+        public Builder keyphrases(ListAttribute<Keyphrase> keyphrases) {
+            attributes.put(AttributeKey.KEYPHRASE.key(), keyphrases);
+            return this;
+        }
+
         /**
          * Adds an attribute.
          *

model/src/main/java/com/basistech/rosette/dm/AttributeKey.java

@@ -50,7 +50,10 @@ enum AttributeKey {
     TOKEN("token"),
     TRANSLATED_DATA("translatedData"),
     TRANSLATED_TOKENS("translatedTokens"),
-    TOPIC_RESULTS("topicResults");
+    TOPIC_RESULTS("topicResults"),
+
+    TOPIC("topics"),
+    KEYPHRASE("keyphrases");
 
     private final String key;