Rename appearance and style models formrecognizer (Azure#18823)

Author: samvaity

sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## 3.1.0-beta.2 (Unreleased)
 
+### Breaking Changes
+- Renamed `Appearance`, `Style` and `TextStyle` models to `TextAppearance`, `TextStyle` and `TextStyleName` respectively.
+
 ## 3.0.4 (2021-01-14)
 
 ### Dependency Updates

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/Transforms.java

@@ -3,13 +3,13 @@
 
 package com.azure.ai.formrecognizer;
 
-import com.azure.ai.formrecognizer.implementation.AppearanceHelper;
+import com.azure.ai.formrecognizer.implementation.TextAppearanceHelper;
 import com.azure.ai.formrecognizer.implementation.FormLineHelper;
 import com.azure.ai.formrecognizer.implementation.FormPageHelper;
 import com.azure.ai.formrecognizer.implementation.FormSelectionMarkHelper;
 import com.azure.ai.formrecognizer.implementation.FormTableHelper;
 import com.azure.ai.formrecognizer.implementation.RecognizedFormHelper;
-import com.azure.ai.formrecognizer.implementation.StyleHelper;
+import com.azure.ai.formrecognizer.implementation.TextStyleHelper;
 import com.azure.ai.formrecognizer.implementation.models.AnalyzeResult;
 import com.azure.ai.formrecognizer.implementation.models.DocumentResult;
 import com.azure.ai.formrecognizer.implementation.models.FieldValue;
@@ -20,7 +20,7 @@
 import com.azure.ai.formrecognizer.implementation.models.SelectionMarkState;
 import com.azure.ai.formrecognizer.implementation.models.TextLine;
 import com.azure.ai.formrecognizer.implementation.models.TextWord;
-import com.azure.ai.formrecognizer.models.Appearance;
+import com.azure.ai.formrecognizer.models.TextAppearance;
 import com.azure.ai.formrecognizer.models.FieldBoundingBox;
 import com.azure.ai.formrecognizer.models.FieldData;
 import com.azure.ai.formrecognizer.models.FieldValueType;
@@ -36,8 +36,8 @@
 import com.azure.ai.formrecognizer.models.LengthUnit;
 import com.azure.ai.formrecognizer.models.Point;
 import com.azure.ai.formrecognizer.models.RecognizedForm;
-import com.azure.ai.formrecognizer.models.Style;
 import com.azure.ai.formrecognizer.models.TextStyle;
+import com.azure.ai.formrecognizer.models.TextStyleName;
 import com.azure.core.util.CoreUtils;
 import com.azure.core.util.logging.ClientLogger;
 
@@ -264,7 +264,7 @@ static List<FormLine> getReadResultFormLines(ReadResult readResultItem) {
                     readResultItem.getPage(),
                     toWords(textLine.getWords(), readResultItem.getPage()));
 
-                FormLineHelper.setAppearance(formLine, getAppearance(textLine));
+                FormLineHelper.setAppearance(formLine, getTextAppearance(textLine));
                 return formLine;
             })
             .collect(Collectors.toList());
@@ -275,19 +275,19 @@ static List<FormLine> getReadResultFormLines(ReadResult readResultItem) {
      * @param textLine The service side text line object.
      * @return the custom type Appearance model.
      */
-    private static Appearance getAppearance(TextLine textLine) {
-        Style style = new Style();
+    private static TextAppearance getTextAppearance(TextLine textLine) {
+        TextStyle textStyle = new TextStyle();
         if (textLine.getAppearance() != null && textLine.getAppearance().getStyle() != null) {
             if (textLine.getAppearance().getStyle().getName() != null) {
-                StyleHelper.setName(style,
-                    TextStyle.fromString(textLine.getAppearance().getStyle().getName().toString()));
+                TextStyleHelper.setName(textStyle,
+                    TextStyleName.fromString(textLine.getAppearance().getStyle().getName().toString()));
             }
-            StyleHelper.setConfidence(style, textLine.getAppearance().getStyle().getConfidence());
+            TextStyleHelper.setConfidence(textStyle, textLine.getAppearance().getStyle().getConfidence());
         }
 
-        Appearance appearance = new Appearance();
-        AppearanceHelper.setStyle(appearance, style);
-        return appearance;
+        TextAppearance textAppearance = new TextAppearance();
+        TextAppearanceHelper.setStyle(textAppearance, textStyle);
+        return textAppearance;
     }
 
     /**
@@ -565,7 +565,7 @@ private static List<FormElement> setReferenceElements(List<String> elements,
                 TextLine textLine = readResults.get(readResultIndex).getLines().get(lineIndex);
                 FormLine lineElement = new FormLine(textLine.getText(), toBoundingBox(textLine.getBoundingBox()),
                     readResultIndex + 1, toWords(textLine.getWords(), readResultIndex + 1));
-                FormLineHelper.setAppearance(lineElement, getAppearance(textLine));
+                FormLineHelper.setAppearance(lineElement, getTextAppearance(textLine));
                 formElementList.add(lineElement);
             }
         });

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/AppearanceHelper.java

@@ -3,7 +3,7 @@
 
 package com.azure.ai.formrecognizer.implementation;
 
-import com.azure.ai.formrecognizer.models.Appearance;
+import com.azure.ai.formrecognizer.models.TextAppearance;
 import com.azure.ai.formrecognizer.models.FormLine;
 
 /**
@@ -18,7 +18,7 @@ private FormLineHelper() { }
      * Type defining the methods to set the non-public properties of an {@link FormLine} instance.
      */
     public interface FormLineAccessor {
-        void setAppearance(FormLine formLine, Appearance appearance);
+        void setAppearance(FormLine formLine, TextAppearance textAppearance);
     }
 
     /**
@@ -30,7 +30,7 @@ public static void setAccessor(final FormLineAccessor formLineAccessor) {
         accessor = formLineAccessor;
     }
 
-    public static void setAppearance(FormLine formLine, Appearance appearance) {
-        accessor.setAppearance(formLine, appearance);
+    public static void setAppearance(FormLine formLine, TextAppearance textAppearance) {
+        accessor.setAppearance(formLine, textAppearance);
     }
 }

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/FormLineHelper.java

@@ -0,0 +1,36 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.ai.formrecognizer.implementation;
+
+import com.azure.ai.formrecognizer.models.TextAppearance;
+import com.azure.ai.formrecognizer.models.TextStyle;
+
+/**
+ * The helper class to set the non-public properties of an {@link TextAppearance} instance.
+ */
+public final class TextAppearanceHelper {
+    private static TextAppearanceAccessor accessor;
+
+    private TextAppearanceHelper() { }
+
+    /**
+     * Type defining the methods to set the non-public properties of an {@link TextAppearance} instance.
+     */
+    public interface TextAppearanceAccessor {
+        void setStyle(TextAppearance textAppearance, TextStyle textStyle);
+    }
+
+    /**
+     * The method called from {@link TextAppearance} to set it's accessor.
+     *
+     * @param styleAccessor The accessor.
+     */
+    public static void setAccessor(final TextAppearanceAccessor styleAccessor) {
+        accessor = styleAccessor;
+    }
+
+    public static void setStyle(TextAppearance textAppearance, TextStyle textStyle) {
+        accessor.setStyle(textAppearance, textStyle);
+    }
+}

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/TextAppearanceHelper.java

@@ -3,39 +3,39 @@
 
 package com.azure.ai.formrecognizer.implementation;
 
-import com.azure.ai.formrecognizer.models.Style;
 import com.azure.ai.formrecognizer.models.TextStyle;
+import com.azure.ai.formrecognizer.models.TextStyleName;
 
 /**
- * The helper class to set the non-public properties of an {@link Style} instance.
+ * The helper class to set the non-public properties of an {@link TextStyle} instance.
  */
-public final class StyleHelper {
+public final class TextStyleHelper {
     private static StyleAccessor accessor;
 
-    private StyleHelper() { }
+    private TextStyleHelper() { }
 
     /**
-     * Type defining the methods to set the non-public properties of an {@link Style} instance.
+     * Type defining the methods to set the non-public properties of an {@link TextStyle} instance.
      */
     public interface StyleAccessor {
-        void setName(Style style, TextStyle name);
-        void setConfidence(Style style, float confidence);
+        void setName(TextStyle textStyle, TextStyleName name);
+        void setConfidence(TextStyle textStyle, float confidence);
     }
 
     /**
-     * The method called from {@link Style} to set it's accessor.
+     * The method called from {@link TextStyle} to set it's accessor.
      *
      * @param styleAccessor The accessor.
      */
     public static void setAccessor(final StyleAccessor styleAccessor) {
         accessor = styleAccessor;
     }
 
-    public static void setName(Style style, TextStyle name) {
-        accessor.setName(style, name);
+    public static void setName(TextStyle textStyle, TextStyleName name) {
+        accessor.setName(textStyle, name);
     }
 
-    public static void setConfidence(Style style, float confidence) {
-        accessor.setConfidence(style, confidence);
+    public static void setConfidence(TextStyle textStyle, float confidence) {
+        accessor.setConfidence(textStyle, confidence);
     }
 }

…cognizer/implementation/StyleHelper.java …izer/implementation/TextStyleHelper.javasdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/StyleHelper.java renamed to sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/TextStyleHelper.java sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/StyleHelper.java renamed to sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/TextStyleHelper.java

@@ -4,7 +4,6 @@
 
 package com.azure.ai.formrecognizer.implementation.models;
 
-import com.azure.ai.formrecognizer.models.TextStyle;
 import com.azure.core.annotation.Fluent;
 import com.fasterxml.jackson.annotation.JsonProperty;
 

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/implementation/models/Style.java

@@ -18,13 +18,16 @@ public final class FormLine extends FormElement {
      */
     private final List<FormWord> words;
 
-    private Appearance appearance;
+    /*
+     * Line text appearance properties.
+     */
+    private TextAppearance appearance;
 
     static {
         FormLineHelper.setAccessor(new FormLineHelper.FormLineAccessor() {
             @Override
-            public void setAppearance(FormLine formLine, Appearance appearance) {
-                formLine.setAppearance(appearance);
+            public void setAppearance(FormLine formLine, TextAppearance textAppearance) {
+                formLine.setAppearance(textAppearance);
             }
         });
     }
@@ -82,7 +85,7 @@ public int getPageNumber() {
      *
      * @param appearance the appearance text line.
      */
-    private FormLine setAppearance(Appearance appearance) {
+    private FormLine setAppearance(TextAppearance appearance) {
         this.appearance = appearance;
         return this;
     }
@@ -92,7 +95,7 @@ private FormLine setAppearance(Appearance appearance) {
      *
      * @return the appearance of the text line.
      */
-    public Appearance getAppearance() {
+    public TextAppearance getAppearance() {
         return appearance;
     }
 }