Package com.azure.ai.formrecognizer.models

Class FieldData

java.lang.Object

com.azure.ai.formrecognizer.models.FormElement

com.azure.ai.formrecognizer.models.FieldData

public final class FieldData
extends FormElement

The FieldData model.

Constructor Summary

Constructors

Constructor	Description
FieldData(String text, FieldBoundingBox boundingBox, int pageNumber, List<FormElement> fieldElements)	Creates raw OCR FieldData item.

Method Summary

Modifier and Type	Method	Description
FieldBoundingBox	getBoundingBox()	BoundingBox property of the element.
List<FormElement>	getFieldElements()	When `includeFieldElements` is set to true, gets a list of reference elements constituting this FieldData.
int	getPageNumber()	Get the 1-based page number in the input document.
String	getText()	The text content of the form element.

Methods inherited from class java.lang.Object

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

Constructor Details

FieldData

public FieldData(String text,
 FieldBoundingBox boundingBox,
 int pageNumber,
 List<FormElement> fieldElements)

Creates raw OCR FieldData item.

Parameters:

text - The text content of this form element.

boundingBox - The Bounding Box of the recognized field.

pageNumber - the 1 based page number.

fieldElements - The list of element references when includeFieldElements is set to true.

Method Details

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.

getPageNumber

public int getPageNumber()

Get the 1-based page number in the input document.

Overrides:

getPageNumber in class FormElement

Returns:

the page number value.

getFieldElements

public List<FormElement> getFieldElements()

When `includeFieldElements` is set to true, gets a list of reference elements constituting this FieldData.

Returns:

The unmodifiable list of reference elements constituting this FieldData.