Package com.azure.ai.formrecognizer.models

Class FormTableCell

java.lang.Object
com.azure.ai.formrecognizer.models.FormElement
com.azure.ai.formrecognizer.models.FormTableCell
public final class FormTableCell extends FormElement
Represents a cell contained in a table recognized from the input document.

  • Constructor Details

    • FormTableCell

      public FormTableCell(int rowIndex, int columnIndex, int rowSpan, int columnSpan, String text, FieldBoundingBox boundingBox, float confidence, boolean isHeader, boolean isFooter, int pageNumber, List<FormElement> fieldElements)
      Constructs a FormTableCell object.
      Parameters:
      rowIndex - the row index of the cell.
      columnIndex - the column index of the cell.
      rowSpan - the number of rows spanned by this cell.
      columnSpan - the number of columns spanned by this cell.
      text - the recognized text value.
      boundingBox - the bounding box properties of the cell.
      confidence - the confidence value of the recognized text.
      isHeader - the boolean indicating if the current cell a header cell?
      isFooter - the boolean indicating if the current cell a footer cell?
      pageNumber - the 1 based page number of the cell
      fieldElements - a list of references to the elements constituting this table cell.

  • Method Details

    • getConfidence

      public float getConfidence()
      Get the confidence value of the recognized text of the cell.
      Returns:
      the confidence value of the recognized text of the cell.

    • getPageNumber

      public int getPageNumber()
      Get the 1-based page number in the input document.
      Overrides:
      getPageNumber in class FormElement
      Returns:
      the page number value.

    • getBoundingBox

      public FieldBoundingBox getBoundingBox()
      BoundingBox property of the element.
      Overrides:
      getBoundingBox in class FormElement
      Returns:
      the bounding box of the element.

    • getText

      public String getText()
      The text content of the form element.
      Overrides:
      getText in class FormElement
      Returns:
      The text content of the form element.

    • getRowIndex

      public int getRowIndex()
      Get the row index of the cell.
      Returns:
      the row index of the cell.

    • getColumnIndex

      public int getColumnIndex()
      Get the column index of the cell.
      Returns:
      the column index of the cell.

    • getRowSpan

      public int getRowSpan()
      Get the number of rows spanned by this cell.
      Returns:
      the number of rows spanned by this cell.

    • getColumnSpan

      public int getColumnSpan()
      Get the number of columns spanned by this cell.
      Returns:
      the number of columns spanned by this cell.

    • getFieldElements

      public List<FormElement> getFieldElements()
      When includeFieldElements is set to true, gets the list of references to the elements constituting this table cell.
      Returns:
      the unmodifiable list of list of references to the text elements constituting this table cell.

    • isHeader

      public boolean isHeader()
      Get the boolean if the current cell a header cell.
      Returns:
      the boolean indicating if the current cell a header cell.

    • isFooter

      public boolean isFooter()
      Get the boolean if the current cell a footer cell.
      Returns:
      the boolean indicating if the current cell is a footer cell.