WS-1741: add new Configuration request support for dynamic gazetteer

Author: Katsuya-Tomioka

json/src/main/java/com/basistech/rosette/apimodel/jackson/ApiModelMixinModule.java

@@ -19,6 +19,7 @@
 import com.basistech.rosette.apimodel.Address;
 import com.basistech.rosette.apimodel.AddressSimilarityRequest;
 import com.basistech.rosette.apimodel.AdmRequest;
+import com.basistech.rosette.apimodel.ConfigurationRequest;
 import com.basistech.rosette.apimodel.DocumentRequest;
 import com.basistech.rosette.apimodel.Name;
 import com.basistech.rosette.apimodel.NameDeduplicationRequest;
@@ -63,6 +64,9 @@ public void setupModule(Module.SetupContext context) {
         context.setMixInAnnotations(Address.AddressBuilder.class, AddressMixin.AddressBuilderMixin.class);
         context.setMixInAnnotations(AddressSimilarityRequest.class, AddressSimilarityRequestMixin.class);
         context.setMixInAnnotations(AddressSimilarityRequest.AddressSimilarityRequestBuilder.class, AddressSimilarityRequestMixin.AddressSimilarityRequestBuilderMixin.class);
+        context.setMixInAnnotations(ConfigurationRequest.class, ConfigurationRequestMixin.class);
+        context.setMixInAnnotations(ConfigurationRequest.ConfigurationRequestBuilder.class,
+            ConfigurationRequestMixin.ConfigurationRequestBuilderMixin.class);
     }
 
     /**

json/src/main/java/com/basistech/rosette/apimodel/jackson/ConfigurationRequestMixin.java

@@ -0,0 +1,26 @@
+package com.basistech.rosette.apimodel.jackson;
+
+import com.basistech.rosette.apimodel.Configuration;
+import com.basistech.util.LanguageCode;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonTypeName;
+import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
+
+@JsonTypeName("ConfigurationRequest")
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public class ConfigurationRequestMixin {
+    @JsonCreator
+    protected ConfigurationRequestMixin(
+        @JsonProperty("profileId") String profileId,
+        @JsonProperty("language") LanguageCode language,
+        @JsonProperty("configuration") Configuration configuration
+    ) {
+        //
+    }
+
+    @JsonPOJOBuilder(withPrefix = "")
+    abstract class ConfigurationRequestBuilderMixin {
+    }
+}

json/src/test/java/com/basistech/rosette/apimodel/ModelTest.java

@@ -16,6 +16,18 @@
 
 package com.basistech.rosette.apimodel;
 
+import com.basistech.rosette.apimodel.jackson.ApiModelMixinModule;
+import com.basistech.rosette.apimodel.jackson.DocumentRequestMixin;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.ObjectWriter;
+import com.google.common.collect.Lists;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+import org.reflections.Reflections;
+import org.reflections.scanners.SubTypesScanner;
+
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.lang.reflect.Constructor;
@@ -31,18 +43,6 @@
 import java.util.List;
 import java.util.Set;
 
-import com.basistech.rosette.apimodel.jackson.ApiModelMixinModule;
-import com.basistech.rosette.apimodel.jackson.DocumentRequestMixin;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.ObjectWriter;
-import com.google.common.collect.Lists;
-import org.junit.Before;
-import org.junit.Test;
-import org.junit.runner.RunWith;
-import org.junit.runners.Parameterized;
-import org.reflections.Reflections;
-import org.reflections.scanners.SubTypesScanner;
-
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.fail;
 
@@ -100,6 +100,10 @@ public void packageTest() throws ClassNotFoundException, IllegalAccessException,
                 continue;
             }
 
+            if (className.contains("ConfigurationRequest")) {
+                continue;
+            }
+
             Class c = Class.forName(className);
             if (Modifier.isAbstract(c.getModifiers())) {
                 continue;

json/src/test/java/com/basistech/rosette/apimodel/PolymorphicRequestTest.java

@@ -15,6 +15,7 @@
 */
 package com.basistech.rosette.apimodel;
 
+import com.basistech.util.LanguageCode;
 import com.fasterxml.jackson.core.type.TypeReference;
 import org.junit.Assert;
 import org.junit.Before;
@@ -68,5 +69,9 @@ public void testRequestTypes() throws Exception {
         json = "{\"names\": [\"Joe\", \"Smith\"], \"threshold\": 0.8}";
         request = mapper.readValue(json, NameDeduplicationRequest.class);
         assertTrue(request instanceof NameDeduplicationRequest);
+
+        json = "{\"language\": \"xxx\", \"configuration\": {\"entities\": { \"LOCATION\": [\"Boston\", \"Mos Eisley\"] } } }";
+        request = mapper.readValue(json, new TypeReference<ConfigurationRequest<GazetteerConfiguration>>() { });
+        assertTrue(request instanceof ConfigurationRequest);
     }
 }

model/src/main/java/com/basistech/rosette/apimodel/Configuration.java

@@ -0,0 +1,24 @@
+/*******************************************************************************
+ * Copyright 2019 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.apimodel;
+
+import lombok.EqualsAndHashCode;
+
+@EqualsAndHashCode
+public abstract class Configuration {
+}

model/src/main/java/com/basistech/rosette/apimodel/ConfigurationRequest.java

@@ -0,0 +1,35 @@
+/*******************************************************************************
+ * Copyright 2019 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.apimodel;
+
+import com.basistech.util.LanguageCode;
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+public final class ConfigurationRequest<T extends Configuration> extends Request {
+    private final LanguageCode language;
+    private final T configuration;
+
+    @Builder
+    public ConfigurationRequest(String profileId, LanguageCode language, T configuration) {
+        super(profileId);
+        this.language = language;
+        this.configuration = configuration;
+    }
+}

model/src/main/java/com/basistech/rosette/apimodel/ConfigurationResponse.java

@@ -0,0 +1,37 @@
+/*******************************************************************************
+ * Copyright 2019 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.apimodel;
+
+import com.basistech.rosette.annotations.JacksonMixin;
+import lombok.Builder;
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+
+/**
+ * Response ping data
+ */
+@Getter
+@EqualsAndHashCode
+@Builder
+@JacksonMixin
+public class ConfigurationResponse extends Response {
+    /**
+     * @return the ping response message
+     */
+    private final String message;
+}

model/src/main/java/com/basistech/rosette/apimodel/GazetteerConfiguration.java

@@ -0,0 +1,33 @@
+/*******************************************************************************
+ * Copyright 2019 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.apimodel;
+
+import com.basistech.rosette.annotations.JacksonMixin;
+import lombok.Builder;
+import lombok.Value;
+
+import java.util.Collection;
+import java.util.Map;
+
+@Value
+@Builder
+@JacksonMixin
+public class GazetteerConfiguration extends Configuration {
+    // list of gazetteer entities keyed by entity type
+    Map<String, Collection<String>> entities;
+}