com.azure.ai.formrecognizer.models

Class TimeValue

java.lang.Object

com.azure.ai.formrecognizer.models.RawItem

com.azure.ai.formrecognizer.models.FieldValue<String>

com.azure.ai.formrecognizer.models.TimeValue

public class TimeValue
extends FieldValue<String>

Class to represent the Time value for FieldValue.getValueTime()

Constructor Summary

Constructors

Constructor and Description
TimeValue(String text, BoundingBox boundingBox, String valueTime, int pageNumber) Constructs a Time Value.

Method Summary

Modifier and Type	Method and Description
BoundingBox	getBoundingBox() BoundingBox property of the element.
Float	getConfidence() Get the confidence property: Confidence score.
List<Element>	getElements() Get the elements property: When includeTextDetails is set to true, a list of references to the text elements constituting this field.
int	getPageNumber() Get the 1-based page number in the input document.
String	getText() The text of the extracted item.
FieldValueType	getType() Gets the type the field value.
String	getValue() Gets the field value.

Methods inherited from class com.azure.ai.formrecognizer.models.FieldValue

setConfidence, setElements

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeValue

public TimeValue(String text,
                 BoundingBox boundingBox,
                 String valueTime,
                 int pageNumber)

Constructs a Time Value.

Parameters:

text - The text content of the extracted field.

boundingBox - Bounding box of the field value.

valueTime - Time value.

pageNumber - The page number on which this field exists.

Method Detail

getPageNumber

public int getPageNumber()

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

Overrides:

getPageNumber in class FieldValue<String>

Returns:

the page number value.

getBoundingBox

public BoundingBox getBoundingBox()

BoundingBox property of the element.

Overrides:

getBoundingBox in class RawItem

Returns:

the bounding box of the element.

getText

public String getText()

The text of the extracted item.

Overrides:

getText in class RawItem

Returns:

The text of the extracted item.

getValue

public String getValue()

Gets the field value.

Specified by:

getValue in class FieldValue<String>

Returns:

The T field value

getType

public FieldValueType getType()

Gets the type the field value.

Specified by:

getType in class FieldValue<String>

Returns:

The type the field value.

getElements

public List<Element> getElements()

Get the elements property: When includeTextDetails is set to true, a list of references to the text elements constituting this field.

Overrides:

getElements in class FieldValue<String>

Returns:

the elements value.

getConfidence

public Float getConfidence()

Get the confidence property: Confidence score.

Overrides:

getConfidence in class FieldValue<String>

Returns:

the confidence value.