FieldData Class

Package:

com.azure.ai.formrecognizer.models

Maven Artifact:

com.azure:azure-ai-formrecognizer:4.1.12

• 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

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

Method Summary

Modifier and Type	Method and 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 FormElement

getBoundingBox getPageNumber getText

Methods inherited from 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 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:

FieldData.getBoundingBox()

getFieldElements

public List 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.

getPageNumber

public int getPageNumber()

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

Overrides:

FieldData.getPageNumber()

getText

public String getText()

The text content of the form element.

Overrides:

FieldData.getText()