WS-2589: marking genre as deprecated.

Yaison · Yaison · commit 189f611d2e7a · 2022-11-08T19:22:39.000-04:00
diff --git a/json/src/main/java/com/basistech/rosette/apimodel/jackson/AdmRequestMixin.java b/json/src/main/java/com/basistech/rosette/apimodel/jackson/AdmRequestMixin.java
@@ -36,7 +36,7 @@ protected AdmRequestMixin(
             @JsonProperty("profileId") String profileId,
             @JsonProperty("text") AnnotatedText text,
             @JsonProperty("options") Options options,
-            @JsonProperty("genre") String genre,
+            @Deprecated @JsonProperty("genre") String genre,
             @JsonProperty("language") LanguageCode language
     ) {
         //
diff --git a/json/src/main/java/com/basistech/rosette/apimodel/jackson/DocumentRequestMixin.java b/json/src/main/java/com/basistech/rosette/apimodel/jackson/DocumentRequestMixin.java
@@ -47,7 +47,7 @@ protected DocumentRequestMixin(
             @JsonProperty("content") Object content,
             @JsonProperty("contentUri") String contentUri,
             @JsonProperty("contentType") String contentType,
-            @JsonProperty("genre") String genre,
+            @Deprecated @JsonProperty("genre") String genre,
             @JsonProperty("options") Options options
     ) {
         //
diff --git a/model/src/main/java/com/basistech/rosette/apimodel/AdmRequest.java b/model/src/main/java/com/basistech/rosette/apimodel/AdmRequest.java
@@ -1,18 +1,18 @@
 /*
-* 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.
-*/
+ * 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.apimodel;
 
 import com.basistech.rosette.dm.AnnotatedText;
@@ -39,6 +39,7 @@ public final class AdmRequest<O extends Options> extends Request {
     private final O options;
 
     /**
+     * @deprecated
      * @return genre
      */
     private final String genre;
@@ -48,12 +49,25 @@ public final class AdmRequest<O extends Options> extends Request {
      */
     private final LanguageCode language;
 
+
+    public AdmRequest(String profileId,
+                      AnnotatedText text,
+                      O options,
+                      LanguageCode language) {
+        super(profileId);
+        this.text = text;
+        this.options = options;
+        this.genre = null;
+        this.language = language;
+    }
+
+
     @Builder     // workaround for inheritance https://github.com/rzwitserloot/lombok/issues/853
     public AdmRequest(String profileId,
-                       AnnotatedText text,
-                       O options,
-                       String genre,
-                       LanguageCode language) {
+                      AnnotatedText text,
+                      O options,
+                      @Deprecated String genre,
+                      LanguageCode language) {
         super(profileId);
         this.text = text;
         this.options = options;
diff --git a/model/src/main/java/com/basistech/rosette/apimodel/DocumentRequest.java b/model/src/main/java/com/basistech/rosette/apimodel/DocumentRequest.java
@@ -1,18 +1,18 @@
 /*
-* 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.
-*/
+ * 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.apimodel;
 
@@ -44,9 +44,6 @@
  * In this object the 'content' item is an {@link Object}; it contains a {@link String}
  * for plain text, or an {@link java.io.InputStream} for binary data. {@link DocumentRequest.DocumentRequestBuilder}
  * provides several alternative methods for setting this information.
- *
- * This class includes a 'genre' field. If no genre is specified, then the system
- * applies generic processing. Valid values for genre are specified in the API documentation.
  */
 @Value
 public final class DocumentRequest<O extends Options> extends Request {
@@ -71,7 +68,7 @@ public final class DocumentRequest<O extends Options> extends Request {
      */
     private final String contentType;
 
-    /**
+    /** @deprecated
      * @return request genre
      */
     private final String genre;
@@ -81,13 +78,29 @@ public final class DocumentRequest<O extends Options> extends Request {
      */
     private final O options;
 
+
+    public DocumentRequest(String profileId,
+                           LanguageCode language,
+                           Object content,
+                           String contentUri,
+                           String contentType,
+                           O options) {
+        super(profileId);
+        this.language = language;
+        this.content = content;
+        this.contentUri = contentUri;
+        this.contentType = contentType;
+        this.genre = null;
+        this.options = options;
+    }
+
     @Builder     // workaround for inheritance https://github.com/rzwitserloot/lombok/issues/853
     public DocumentRequest(String profileId,
                            LanguageCode language,
                            Object content,
                            String contentUri,
                            String contentType,
-                           String genre,
+                           @Deprecated String genre,
                            O options) {
         super(profileId);
         this.language = language;
@@ -100,6 +113,7 @@ public DocumentRequest(String profileId,
 
     /**
      * get content to process if it's a String.
+     *
      * @return the content if a String, else null.
      */
     public String getContent() {
@@ -112,18 +126,20 @@ public String getContent() {
 
     /**
      * get the content as an array of bytes
+     *
      * @return the content as bytes
      */
     public InputStream getContentBytes() {
         if (content instanceof InputStream) {
-            return (InputStream)content;
+            return (InputStream) content;
         } else {
             return null;
         }
     }
 
     /**
      * get content as an object
+     *
      * @return the content as object
      */
     public Object getRawContent() {
@@ -134,6 +150,7 @@ public Object getRawContent() {
     public static class DocumentRequestBuilder<O extends Options> {
         /**
          * Specify the content as String. Use this for plain text.
+         *
          * @param data The data.
          * @return this.
          */
@@ -145,7 +162,8 @@ public DocumentRequestBuilder<O> content(String data) {
         /**
          * Specify the content as bytes with a content type. Use this for
          * formats other than plain text.
-         * @param bytes The data.
+         *
+         * @param bytes       The data.
          * @param contentType the content type.
          * @return this.
          */
@@ -158,7 +176,8 @@ public DocumentRequestBuilder<O> content(byte[] bytes, String contentType) {
         /**
          * Specify the content as bytes with a content type. Use this for
          * formats other than plain text.
-         * @param bytes The data.
+         *
+         * @param bytes       The data.
          * @param contentType the content type.
          * @return this.
          */
