Package com.azure.ai.documentintelligence.models

Class DocumentLine

java.lang.Object
com.azure.ai.documentintelligence.models.DocumentLine
All Implemented Interfaces:
com.azure.json.JsonSerializable<DocumentLine>
public final class DocumentLine extends Object implements com.azure.json.JsonSerializable<DocumentLine>
A content line object consisting of an adjacent sequence of content elements, such as words and selection marks.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DocumentLine
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of DocumentLine from the JsonReader.
    String
    getContent()
    Get the content property: Concatenated content of the contained elements in reading order.
    List<Double>
    getPolygon()
    Get the polygon property: Bounding polygon of the line, with coordinates specified relative to the top-left of the page.
    List<DocumentSpan>
    getSpans()
    Get the spans property: Location of the line in the reading order concatenated content.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Method Details

    • getContent

      public String getContent()
      Get the content property: Concatenated content of the contained elements in reading order.
      Returns:
      the content value.

    • getPolygon

      public List<Double> getPolygon()
      Get the polygon property: Bounding polygon of the line, with coordinates specified relative to the top-left of the page. The numbers represent the x, y values of the polygon vertices, clockwise from the left (-180 degrees inclusive) relative to the element orientation.
      Returns:
      the polygon value.

    • getSpans

      public List<DocumentSpan> getSpans()
      Get the spans property: Location of the line in the reading order concatenated content.
      Returns:
      the spans value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<DocumentLine>
      Throws:
      IOException

    • fromJson

      public static DocumentLine fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of DocumentLine from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of DocumentLine if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the DocumentLine.